Alapmodell – REST API-referencia

Ez a cikk általános API-információkat tartalmaz a Databricks Foundation modell API-jaihoz és az általuk támogatott modellekhez. Az Alapmodell API-k az OpenAI REST API-jához hasonlóak, hogy megkönnyítse a meglévő projektek migrálását. A tokenenkénti fizetés és a kiosztott átviteli sebesség végpontjai is ugyanazt a REST API kérésformátumot fogadják el.

végpontok

Az Alapmodellek API-ja támogatja a token alapú fizetési végpontokat és a fix átviteli sebességű végpontokat.

A munkaterületen minden zsetononként fizetős modellhez előre konfigurált végpont érhető el, és a felhasználók HTTP POST kérések használatával kezelhetik ezeket a végpontokat. A támogatott modellekhez tekintse meg a Támogatott alapmodellek című témakört a Model Service szolgáltatásban.

A kiosztott átviteli sebesség végpontjai hozhatók létre az API vagy a Kiszolgáló felhasználói felülethasználatával. Ezek a végpontok végpontonként több modellt támogatnak az A/B-teszteléshez, mindaddig, amíg mindkét kiszolgált modell ugyanazt az API-formátumot teszi elérhetővé. Például mindkét modell csevegési modell. A végpontkonfigurációs paraméterekről lásd POST /api/2.0/serving-endpoints.

A kérelmek és válaszok JSON-t használnak, a pontos JSON-struktúra a végpont tevékenységtípusától függ. A csevegő- és befejezővégpontok támogatják a válaszok folyamatos átadását.

Használat

A válaszok egy usage alüzenetet tartalmaznak, amely a kérés és a válasz tokenjeinek számát jelenti. Az alüzenet formátuma minden tevékenységtípusban megegyezik.

Mező Típus Leírás
completion_tokens Egész szám A létrehozott tokenek száma. Nem szerepel a beágyazási válaszokban.
prompt_tokens Egész szám A bemeneti kérés(ek) tokenjeinek száma.
total_tokens Egész szám A tokenek teljes száma.
reasoning_tokens Egész szám A gondolkodó tokenek száma. Ez csak az érvelési modellekre vonatkozik.
cache_read_input_tokens Egész szám A prompt cache-ből olvasott bemeneti tokenek száma. A Databricks által üzemeltetett Claude végpontok felső szintű usage mezőként tér vissza, amikor a gyorsítótározás aktív.
cache_creation_input_tokens Egész szám A prompt cache-be írt bemeneti tokenek száma. A Databricks által üzemeltetett Claude végpontok felső szintű usage mezőként tér vissza, amikor a gyorsítótározás aktív.

Az olyan modellek esetében, mint a databricks-meta-llama-3-3-70b-instruct, a rendszer egy parancssori sablon használatával alakítja át a felhasználói kérést, mielőtt átkerül a modellbe. Tokenenkénti fizetéses végpontok esetén rendszerüzenet is hozzáadható. prompt_tokens tartalmazza a kiszolgáló által hozzáadott összes szöveget.

Válaszok API

Fontos

Ez a Responses API-referencia OpenAI-modellekre vonatkozik. Ha Anthropic Claude, Google Gemini vagy Databricks által üzemeltetett nyitott modellekkel szeretné használni a Válaszkérés formátumot, olvassa el a Modell lekérdezése az Open Responses API-val című témakört.

A Responses API többfordulós beszélgetéseket tesz lehetővé egy modellel. A Chat Completion segítségével ellentétben a Válasz API a input-t használja messages helyett.

Válaszok API-kérés

Mező Alapértelmezett Típus Leírás
model Karakterlánc Kötelező. A válasz létrehozásához használt modellazonosító.
input Sztring vagy lista [ResponsesInput] Kötelező. A modell szöveg-, kép- vagy fájlbemenetei, amelyeket válasz létrehozásához használnak. Ellentétben messagesez a mező a beszélgetés tartalmának megadására használja input .
instructions null Karakterlánc A modell környezetébe beszúrt rendszer-(vagy fejlesztői) üzenet.
max_output_tokens null null, ami azt jelenti, hogy nincs korlát, vagy nullánál nagyobb egész szám A válaszhoz létrehozható tokenek számának felső határa, beleértve a látható kimeneti tokeneket és az érvelési tokeneket.
temperature 1.0 Lebegőpontos szám a [0,2] tartományban A mintavételi hőmérséklet. A 0 determinisztikus, és a magasabb értékek nagyobb véletlenszerűséget vezetnek be.
top_p 1.0 Lebegés (0,1] A nukleusz mintavételezéséhez használt valószínűségi küszöbérték.
stream false logikai Ha igaz értékre van állítva, a modell válaszadatai folyamatosan, a generálásukkal egy időben, kiszolgálói küldött események használatával kerülnek továbbításra az ügyfél felé.
stream_options null StreamOptions A streamelési válaszok beállításai. Ezt csak akkor állítsa be, ha be van állítva stream: true.
text null TextConfig A modell szöveges válaszának konfigurációs beállításai. Lehetnek egyszerű szöveges vagy strukturált JSON-adatok.
reasoning null ReasoningConfig A gpt-5 és o sorozatú modellek érvelési konfigurációja.
tool_choice "auto" Karakterlánc vagy ToolChoiceObject Hogyan válassza ki a modell a válasz létrehozásakor használni kívánt eszközt (vagy eszközöket). A paraméterből tools megtudhatja, hogyan adhatja meg, hogy a modell mely eszközöket hívhatja meg.
tools null Lista[ToolObject] A modell által a válasz létrehozása során meghívható eszközök tömbje. Megjegyzés: A Databricks nem támogatja a kódértelmezőt és a webes keresőeszközöket.
parallel_tool_calls true logikai Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.
max_tool_calls null Nullánál nagyobb egész szám A válaszban feldolgozható beépített eszközökre irányuló összes hívás maximális száma.
metadata null Tárgy Egy objektumhoz csatolható 16 kulcs-érték pár készlete.
prompt_cache_key null Karakterlánc Hasonló kérések válaszainak gyorsítótárazására szolgál a gyorsítótár-találatok arányának optimalizálása érdekében. Lecseréli a user mezőt.
prompt_cache_retention null Karakterlánc A prompt gyorsítótár adatmegőrzési szabályzata. Úgy van beállítva, hogy engedélyezze a "24h" kiterjesztett parancssori gyorsítótárazást, amely a gyorsítótárazott előtagokat hosszabb ideig, legfeljebb 24 óráig aktív állapotban tartja.
service_tier null Karakterlánc "priority" a kérés prioritási módba való bekapcsolásához. A támogatott modellekhez és régiókhoz tartozó alapmodell API-k esetében lásd a prioritási jogkivonatonkénti fizetést . "default" Az alapértelmezett jogkivonatonkénti fizetéses termék explicit használatára van beállítva. A kihagyás service_tier egyenértékű az átadással "default". Bármely érték, amely nem "default""priority" vagy csak hibát ad vissza.
safety_identifier null Karakterlánc Stabil azonosító, amely segít észlelni az alkalmazás olyan felhasználóit, amelyek megsérthetik a használati szabályzatokat.
user null Karakterlánc Elavult. Használja a safety_identifier és a prompt_cache_key helyett.
truncation null Karakterlánc A modell válaszához használandó csonkítási stratégia.
top_logprobs null Egész szám Egy 0 és 20 közötti egész szám, amely megadja, hogy minden tokenpozíciónál hány legvalószínűbb tokent kell visszaadni, mindegyikhez társuló logvalószínűséggel.
include null Lista[String] Adja meg a modell válaszában felvenni kívánt további kimeneti adatokat.
prompt null Tárgy Hivatkozás egy parancssori sablonra és annak változóira.

Nem támogatott paraméterek: A Databricks nem támogatja a következő paramétereket, és ha meg van adva, 400-os hibát ad vissza:

  • background – A háttérfeldolgozás nem támogatott
  • store – A tárolt válaszok nem támogatottak
  • conversation - A Beszélgetés API nem támogatott

ResponsesInput

A input mező egy sztringet vagy egy szerepkörrel és tartalommal rendelkező bemeneti üzenetobjektumok listáját fogadja el.

Mező Típus Leírás
role Karakterlánc Kötelező. Az üzenet szerzőjének szerepe. Lehet "user" vagy "assistant".
content Sztring vagy lista[ResponsesContentBlock] Kötelező. Az üzenet tartalma sztringként vagy tartalomblokkok tömbjeként.

ResponsesContentBlock

A tartalomblokkok határozzák meg a bemeneti és kimeneti üzenetek tartalmát. A tartalomblokk típusát a type mező határozza meg.

InputText
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "input_text".
text Karakterlánc Kötelező. A szöveges tartalom.
OutputText
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "output_text".
text Karakterlánc Kötelező. A szöveges tartalom.
annotations Lista[Objektum] A szöveges tartalomhoz nem kötelező megjegyzéseket fűzni.
InputImage
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "input_image".
image_url Karakterlánc Kötelező. A kép URL-címe vagy base64-kódolású adat URI-ja.
InputFile
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "input_file".
file_id Karakterlánc Fájlazonosító, ha feltöltött fájlokat használ.
filename Karakterlánc A fájl neve.
file_data Karakterlánc Base64 kódolású adat URI formátumelőtaggal. A PDF-fájlok például formátumot data:application/pdf;base64,<base64 data>használnak.
FunctionCall
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "function_call".
id Karakterlánc Kötelező. A függvényhívás egyedi azonosítója.
call_id Karakterlánc Kötelező. A hívásazonosító.
name Karakterlánc Kötelező. A meghívandó függvény neve.
arguments Objektum/sztring Kötelező. A függvényargumentumok JSON-objektumként vagy sztringként vannak megadva.
FunctionCallOutput
Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "function_call_output".
call_id Karakterlánc Kötelező. A kimenetnek megfelelő hívásazonosító.
output Sztring/objektum Kötelező. A függvény kimenete sztringként vagy JSON-objektumként.
CustomToolCall

Az egyéni eszköz meghívásakor a válasz tömbben output kerül visszaadásra. A függvényhívásoktól eltérően az egyéni eszközhívások JSON inputhelyett egyszerű szöveget arguments adnak vissza.

Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "custom_tool_call".
id Karakterlánc Kötelező. Az egyéni eszközhívás egyedi azonosítója.
call_id Karakterlánc Kötelező. A hívásazonosító.
name Karakterlánc Kötelező. A meghívandó egyéni eszköz neve.
input Karakterlánc Kötelező. Az eszköz bemenete sima szövegként, nem JSON.
status Karakterlánc Az eszközhívás állapota. Az egyik: completed, in_progress.
CustomToolCallOutput

Használd ezt a bemeneti típust, hogy egy egyéni eszköz hívásának eredményét visszajuttasd a modellnek egy többszörös fordulós beszélgetés során.

Mező Típus Leírás
type Karakterlánc Kötelező. Kell lennie "custom_tool_call_output".
call_id Karakterlánc Kötelező. A kimenetnek megfelelő hívásazonosító.
output Karakterlánc Kötelező. Az egyéni eszköz kimenete szövegként.

StreamOptions

A streamelési válaszok konfigurálása. Csak akkor használatos, ha stream: true.

Mező Típus Leírás
include_usage logikai Ha igaz, tartalmazza a token használati információit a streamben. Az alapértelmezett érték false.

TextConfig

A szöveges kimenet konfigurációja, beleértve a strukturált kimeneteket is.

Mező Típus Leírás
format ResponsesFormatObject A szövegkimenet formátumspecifikációja.

ResponsesFormatObject

Megadja a szöveges válaszok kimeneti formátumát.

Mező Típus Leírás
type Karakterlánc Kötelező. Formátum típusa: "text" egyszerű szöveghez, "json_object" JSON-hoz vagy "json_schema" strukturált JSON-hoz.
json_schema Tárgy Kötelező , ha type van "json_schema". A kimenet szerkezetét meghatározó JSON-sémaobjektum.

Az json_schema objektum struktúrája megegyezik a Chat Completions API-ban dokumentált JsonSchemaObject struktúrával.

ReasoningConfig

Érvelési viselkedés konfigurálása az érvelési modellekben (o-sorozatú és gpt-5 modellek).

Mező Típus Leírás
effort Karakterlánc Az érvelési munka szintje: "low", "medium"vagy "high". Az alapértelmezett érték "medium".
encrypted_content Karakterlánc Titkosított érvelési tartalom állapot nélküli módhoz. A modell adta meg a korábbi válaszokban.

ToolObject

Lásd: Függvényhívás az Azure Databricks-on.

Megjegyzés:

A Responses API a következő eszköztípusokat támogatja: function, custom, mcp, image_generation, shell. Az egyéni eszközök és a nyelvhelyességi alapú kimeneti formátumok csak GPT-5 sorozatú modellekben érhetők el (gpt-5, gpt-5.1, ). gpt-5.2

Mező Típus Leírás
type Karakterlánc Kötelező. Az eszköz típusa. A támogatott értékekről lásd a fenti megjegyzést.
function FunctionObject Kötelező, ha type van function. Az eszközhöz társított függvénydefiníció.
name Karakterlánc Kötelező, ha type van custom. Az egyéni eszköz neve.
description Karakterlánc Kötelező, ha type van custom. Az egyéni eszköz által megadott teendők leírása.
format CustomFormat Opcionális. Ha type igen custom, a kimeneti formátumot adja meg. Alapértelmezett érték: {"type": "text"}. Strukturált kimenethez is használható {"type": "grammar", "definition": "<grammar>", "syntax": "lark"} . Csak GPT-5 sorozatú modellek esetén támogatott.

CustomToolObject

Az egyéni eszközök lehetővé teszik, hogy a modell JSON-formátumú függvényargumentumok helyett tetszőleges sztringkimenetet ad vissza. Ez a kódlétrehozáshoz, javítások alkalmazásához vagy más olyan használati esetekhez hasznos, amikor nincs szükség strukturált JSON-ra.

Megjegyzés:

Az egyéni eszközöket csak a GPT-5 sorozatú modellek (gpt-5, gpt-5.1, ) gpt-5.2támogatják a Responses API-n keresztül.

Példa egyéni eszközre:

{
  "type": "custom",
  "name": "code_exec",
  "description": "Executes arbitrary Python code. Return only valid Python code."
}

Példa egyéni nyelvtani eszköz:

{
  "type": "custom",
  "name": "apply_patch",
  "description": "Apply a patch to create or modify files.",
  "format": {
    "type": "grammar",
    "definition": "start: begin_patch hunk end_patch\nbegin_patch: \"*** Begin Patch\" LF\n...",
    "syntax": "lark"
  }
}

Egyéni eszköz meghívása esetén a válasz JSON custom_tool_callhelyett egyszerű input szöveget arguments tartalmazó kimeneti elemet tartalmaz.

CustomFormat

A nyelvtanalapú kimeneti formátumok csak GPT-5 sorozatú modellek esetén támogatottak.

Mező Típus Leírás
type Karakterlánc Kötelező. Egyszerű "text" szöveges kimenethez vagy "grammar" nyelvtani korlátozású kimenethez.
definition Karakterlánc Kötelező, ha type van "grammar". A nyelvtani definíciós sztring a Lark szintaxisával.
syntax Karakterlánc Kötelező, ha type van "grammar". A nyelvhelyességi szintaxis. Jelenleg csak "lark" támogatott.

FunctionObject

Mező Típus Leírás
name Karakterlánc Kötelező. A meghívandó függvény neve.
description Tárgy Kötelező. A függvény részletes leírása. A modell ezt a leírást használja a függvény kérdésre való relevanciájának megértéséhez és az eszközhívások nagyobb pontosságú generálásához.
parameters Tárgy A függvény által elfogadott paraméterek érvényes JSON-séma objektumként vannak leírva. Az eszköz meghívása esetén az eszközhívás a megadott JSON-sémához igazodik. Paraméterek kihagyása paraméter nélküli függvényt határoz meg. A properties száma 15 kulcsra korlátozódik.
strict logikai A függvényhívás létrehozásakor engedélyezze-e a szigorú sémabetartást. Ha trueértékre van állítva, a modell a sémamezőben meghatározott sémát követi. Csak a JSON-séma egy részhalmaza támogatott, ha szigorú üzemmód true van beállítva.

ToolChoiceObject

Lásd: Függvényhívás az Azure Databricks-on.

Mező Típus Leírás
type Karakterlánc Kötelező. Az kényszerítendő eszköz típusa. A támogatott értékek megfelelnek a ToolObject eszköztípusainak: "function", "custom"stb.
function Tárgy Kötelező, ha type van "function". Az űrlap {"name": "my_function"} objektuma, ahol "my_function" a mezőben egy FunctionObjecttools neve szerepel.
name Karakterlánc Kötelező, ha type van "custom". A kényszerítendő egyéni eszköz megnevezése. Csak GPT-5 sorozatú modellek esetén támogatott.

API-válaszok

A nem streamelt kérelmek esetén a válasz egyetlen válaszobjektum. Streamelési kérelmek esetén a válasz az text/event-stream , ahol minden esemény választömb.

Mező Típus Leírás
id Karakterlánc A válasz egyedi azonosítója. Megjegyzés: A Databricks ezt az azonosítót titkosítja a biztonság érdekében.
object Karakterlánc Az objektum típusa. Egyenlő a következővel: "response".
created_at Egész szám A Unix időbélyege (másodpercben), amikor a válasz létrejött.
status Karakterlánc A válasz állapota. Az alábbiak egyike: completed, failed, in_progress, cancelled, queuedvagy incomplete.
model Karakterlánc A válasz létrehozásához használt modellverzió.
output Lista[ResponsesMessage] A modell által generált kimenet, amely általában üzenetobjektumokat tartalmaz.
usage Használat Token használati metaadatai.
error Error Hibainformáció, ha a válasz nem sikerült.
incomplete_details Hiányos részletek Részletek arról, hogy a válasz miért hiányos, ha van ilyen.
instructions Karakterlánc A kérelemben megadott utasítások.
max_output_tokens Egész szám A kérelemben megadott maximális kimeneti tokenek.
temperature Lebegés A generációhoz használt hőmérséklet.
top_p Lebegés A top_p generációhoz használt érték.
tools Lista[ToolObject] A kérelemben megadott eszközök.
tool_choice Karakterlánc vagy ToolChoiceObject A kérés tool_choice beállítása.
parallel_tool_calls logikai Azt jelzi, hogy engedélyezve lettek-e a párhuzamos eszközhívások.
store logikai Azt jelzi, hogy a válasz tárolása megtörtént-e.
metadata Tárgy A válaszhoz csatolt metaadatok.
service_tier Karakterlánc A kéréshez használt szolgáltatási szint. Akkor adja "priority" vissza, ha prioritási módra volt szükség, ellenkező esetben "default".

ResponsesMessage

A modell választartalmat tartalmazó üzenetobjektumok output a mezőben.

Mező Típus Leírás
id Karakterlánc Kötelező. Az üzenet egyedi azonosítója.
role Karakterlánc Kötelező. Az üzenet szerepe. Vagy "user" vagy "assistant".
content Lista[ResponsesContentBlock] Kötelező. A tartalomblokkok az üzenetben.
status Karakterlánc Az üzenetfeldolgozás állapota.
type Karakterlánc Kötelező. Az objektum típusa. Egyenlő a következővel: "message".

Error

Hibainformáció, ha egy válasz meghiúsul.

Mező Típus Leírás
code Karakterlánc Kötelező. A hibakód.
message Karakterlánc Kötelező. Emberi olvasásra alkalmas hibaüzenet.
param Karakterlánc A hibát okozó paraméter, ha van.
type Karakterlánc Kötelező. A hiba típusa.

IncompleteDetails

Részletek arról, hogy miért nem teljes a válasz.

Mező Típus Leírás
reason Karakterlánc Kötelező. A válasz hiányos, mert nincs megadva az ok.

Csevegés befejezések API

A Csevegés befejezése API többfordulós beszélgetéseket tesz lehetővé egy modellel. A modell válasza a beszélgetés következő assistant üzenetét adja meg. Lásd POST /serving-endpoints/{name}/invocations a végpontparaméterek lekérdezéséhez.

Csevegési kérelem

Mező Alapértelmezett Típus Leírás
messages Chatüzenet lista Kötelező. Az aktuális beszélgetést jelképező üzenetek listája.
max_tokens null null, ami azt jelenti, hogy nincs korlát, vagy nullánál nagyobb egész szám A létrehozandó tokenek maximális száma.
stream true logikai A kérések részleges eredményének lehetővé tétele érdekében visszakérheti a válaszokat egy ügyfélnek. Ha ez a paraméter szerepel a kérelemben, a rendszer a válaszokat a kiszolgáló által küldött események standard használatával küldi el.
temperature 1.0 Lebegőpontos szám a [0,2] tartományban A mintavételi hőmérséklet. A 0 determinisztikus, és a magasabb értékek nagyobb véletlenszerűséget vezetnek be.
top_p 1.0 Lebegés (0,1] A nukleusz mintavételezéséhez használt valószínűségi küszöbérték.
top_k null null, ami azt jelenti, hogy nincs korlát, vagy nullánál nagyobb egész szám Meghatározza a top-k szűréshez használt legvalószínűbb k token számát. Állítsa ezt az értéket 1 értékre a kimenetek determinisztikussá tétele érdekében.
stop [] Sztring vagy Lista[Sztring] A modell leállítja a további tokenek generálását, amikor a stop bármelyik sorozatát észleli.
n 1 Nullánál nagyobb egész szám Amikor meg van adva n, az API n független csevegési befejezéseket ad vissza. Olyan számítási feladatokhoz ajánlott, amelyek több befejezést hoznak létre ugyanazon a bemeneten a további következtetési hatékonyság és költségmegtakarítás érdekében. Csak kiosztott átviteli sebességű végpontokhoz érhető el.
tool_choice none Karakterlánc vagy ToolChoiceObject Csak a tools mezővel együtt használható. tool_choice számos kulcsszósztringet támogat, például auto, requiredés none. auto azt jelenti, hogy ön hagyja, hogy a modell döntse el, melyik (ha van ilyen) eszköz használható. Ha auto a modell nem hiszi, hogy a benne lévő tools eszközök relevánsak, a modell eszközhívás helyett egy szabványos segédüzenetet hoz létre. required azt jelenti, hogy a modell a tools legrelevánsabb eszközét választja ki, és eszközhívást kell létrehoznia. none azt jelenti, hogy a modell nem hoz létre eszközhívásokat, ehelyett szabványos segédüzenetet kell létrehoznia. Ha egy konkrét eszközt szeretne hívni, amelyet a toolshatároz meg, használja a ToolChoiceObject-et. Alapértelmezés szerint, ha a tools mező fel van töltve tool_choice = "auto". Máskülönben a tools mező alapértelmezés szerint tool_choice = "none" lesz.
tools null ToolObject A modell által meghívható tools listája. Jelenleg function az egyetlen támogatott tool típus, és legfeljebb 32 függvény támogatott.
response_format null Válaszformátum Objektum Egy objektum, amely megadja a modell által kiadandó formátumot. Az elfogadott típusok a következők: text, json_schema vagy json_object
A { "type": "json_schema", "json_schema": {...} } beállítása strukturált kimeneteket tesz lehetővé, amelyek biztosítják, hogy a modell kövesse a megadott JSON-sémát.
A { "type": "json_object" } beállítása biztosítja, hogy a modell által generált válaszok érvényes JSON-alapúak legyenek, de nem biztosítja, hogy a válaszok egy adott sémát kövessenek.
logprobs false logikai Ez a paraméter jelzi, hogy meg kell-e adni a token mintavételezésének logaritmikus valószínűségét.
top_logprobs null Egész szám Ez a paraméter szabályozza, hogy az egyes mintavételezési lépések során hány legvalószínűbb tokenjelölt logaritmikus valószínűségét adja vissza. Lehet 0-20. Ha ezt a mezőt használja, akkor a logprobs-nak true-nek kell lennie.
reasoning_effort "medium" Karakterlánc Szabályozza a modell által a válaszok generálásakor alkalmazandó érvelési erőfeszítést. Az elfogadott értékek a következők"minimal": , "low""medium"vagy "high". A nagyobb érvelési erőfeszítések átgondoltabb és pontosabb válaszokat eredményezhetnek, de növelhetik a késést és a tokenhasználatot. Ezt a paramétert csak korlátozott számú modell fogadja el, beleértve databricks-gpt-oss-120b és databricks-gpt-oss-20b. Az elfogadott értékek és az alapértelmezett értékek modellenként eltérőek. A modellenkénti részletekért tekintse meg a lekérdezési érvelési modelleket .
service_tier null Karakterlánc Állítsa be úgy "priority" , hogy a kérést prioritási módba állítsa, amely a szokásos, jogkivonatonkénti fizetéses forgalom előtt fogadja el a kérést a konzisztensebb késés és rendelkezésre állás érdekében. A támogatott modellekhez és régiókhoz tartozó alapmodell API-k esetében lásd a prioritási jogkivonatonkénti fizetést . "default" Az alapértelmezett jogkivonatonkénti fizetéses termék explicit használatára van beállítva. A kihagyás service_tier egyenértékű az átadással "default". Bármely érték, amely nem "default""priority" vagy csak hibát ad vissza.

ChatMessage

Mező Típus Leírás
role Karakterlánc Kötelező. Az üzenet szerzőjének szerepe. Lehet "system", "user", "assistant" vagy "tool".
content Karakterlánc Az üzenet tartalma. Eszközhívásokat nem tartalmazó csevegési feladatokhoz szükséges.
tool_calls ToolCall lista A modell által létrehozott tool_calls listája. role kell legyen "assistant", és nem lehet specifikáció megadva a content mezőhöz.
tool_call_id Karakterlánc Amikor role"tool", a ToolCall-hez társított azonosító, amelyre az üzenet válaszol. Más role beállítások esetében üresnek kell lennie.

A system szerepkör csak egyszer használható a beszélgetés első üzeneteként. Felülbírálja a modell alapértelmezett rendszerkérését.

ToolCall

Eszközhívási műveletjavaslat a modell szerint. Lásd: Függvényhívás az Azure Databricks-on.

Mező Típus Leírás
id Karakterlánc Kötelező. Az eszköz hívási javaslatának egyedi azonosítója.
type Karakterlánc Kötelező. Csak "function" támogatott.
function FunctionCallCompletion Kötelező. A modell javasolta függvényhívás.
cache_control Karakterlánc Engedélyezi a kérés gyorsítótárazását. Ezt a paramétert csak a Databricks által üzemeltetett Claude-modellek fogadják el. Lásd: Gyorsítótárazás példát.

FunctionCallCompletion

Mező Típus Leírás
name Karakterlánc Szükséges. A modell által javasolt függvény neve.
arguments Tárgy Szükséges. A függvény argumentumai szerializált JSON-szótárként.

Megjegyzés: ToolChoiceObject, ToolObjectés FunctionObject a Válaszok API szakaszban vannak definiálva, és mindkét API-k között meg vannak osztva.

ResponseFormatObject

Lásd a(z) Azure Databricks strukturált kimeneteit.

Mező Típus Leírás
type Karakterlánc Kötelező. A definiált válaszformátum típusa. Strukturálatlan szöveghez text, strukturálatlan JSON-objektumokhoz json_object, vagy egy adott sémához tartozó JSON-objektumok json_schema.
json_schema JsonSchemaObject Kötelező. A követendő JSON-séma, ha type értéke json_schema lesz.

JsonSchemaObject

Lásd a(z) Azure Databricks strukturált kimeneteit.

Mező Típus Leírás
name Karakterlánc Kötelező. A válaszformátum neve.
description Karakterlánc A válaszformátum célját leíró információ, amelyet a modell arra használ, hogy meghatározza, hogyan válaszoljon az adott formátumban.
schema Tárgy Kötelező. A válaszformátum sémája, amely JSON-sémaobjektumként van leírva.
strict logikai A kimenet létrehozásakor engedélyezze-e a szigorú sémabetartást. Ha trueértékre van állítva, a modell a sémamezőben meghatározott sémát követi. Csak a JSON-séma egy részhalmaza támogatott, ha szigorú üzemmód true van beállítva.

Csevegési válasz

A nem streamelt kérések esetén a válasz egyetlen csevegésbefejezési objektum. Streamelési kérelmek esetén a válasz egy text/event-stream, amelyben minden esemény egy befejező adattömb objektum. A befejezés és a chunk objektumok legfelső szintű struktúrája szinte azonos: csak choices más típusú.

Mező Típus Leírás
id Karakterlánc A csevegés befejezésének egyedi azonosítója.
choices List[ChatCompletionChoice] vagy List[ChatCompletionChunk] (streamelés) A csevegés befejező szövegeinek listája. n n paraméter megadása esetén a rendszer visszaadja a választási lehetőségeket.
object Karakterlánc Az objektum típusa. Megfelel "chat.completions"-nek nem streamelés esetén vagy "chat.completion.chunk"-nek streamelés esetén.
created Egész szám A csevegés befejezésének időpontja másodpercben adva.
model Karakterlánc A válasz létrehozásához használt modellverzió.
usage Használat Token használati metaadatai. Előfordulhat, hogy az adatfolyam válaszok nem jelennek meg.
service_tier Karakterlánc A kéréshez használt szolgáltatási szint. Akkor adja "priority" vissza, ha prioritási módra volt szükség, ellenkező esetben "default".

ChatCompletionChoice

Mező Típus Leírás
index Egész szám A választott választás indexe a létrehozott választási lehetőségek listájában.
message ChatÜzenet A modell által visszaadott csevegésbefejezési üzenet. A szerepkör assistant lesz.
finish_reason Karakterlánc Az ok, amiért a modell leállította a tokenek létrehozását.
extra_fields Karakterlánc Külső modellszolgáltatók által védett modellek használata esetén a szolgáltató API-k további metaadatokat is tartalmazhatnak a válaszokban. A Databricks szűri ezeket a válaszokat, és csak a szolgáltató eredeti mezőinek egy részét adja vissza. A safetyRating az egyetlen további mező, amely jelenleg támogatott. További részletekért tekintse meg a Gemini dokumentációt.

ChatCompletionChunk

Mező Típus Leírás
index Egész szám A választott választás indexe a létrehozott választási lehetőségek listájában.
delta ChatÜzenet A modell által létrehozott, streamelt válaszok egyik csevegőüzenet része. Csak az első adattömb garantáltan tartalmazza a role értéket.
finish_reason Karakterlánc Az ok, amiért a modell leállította a tokenek létrehozását. Csak az utolsó adattömb lesz ily módon kitöltve.

Beágyazási API

A feladatok beágyazása a bemeneti sztringeket beágyazási vektorokba alakítja. Számos input kötegelhető egyetlen kérésbe. Lásd POST /serving-endpoints/{name}/invocations a végpontparaméterek lekérdezéséhez.

Beágyazási kérelem

Mező Típus Leírás
input Sztring vagy Lista[Sztring] Kötelező. A beágyazandó bemeneti szöveg. Lehet karakterlánc vagy karakterlánclista.
instruction Karakterlánc Opcionális utasítás a beágyazási modellnek való továbbításhoz.
dimensions Egész szám Opcionális. Az eredményként kapott kimeneti beágyazások dimenzióinak száma. A 32 és 1024 közötti tartományban 2 hatványának kell lennie. Csak a databricks-qwen3-embedding-0-6b támogatott.

Az utasítások nem kötelezőek, és kifejezetten modellspecifikusak. A BGE-szerzők például nem javasolnak utasítást az adattömbök indexelésekor, és azt javasolják, hogy használja az utasítást "Represent this sentence for searching relevant passages:" a lekérdezések lekéréséhez. A Qwen3-Embedding szerzők egy feladatspecifikus utasítást javasolnak, mint például "Given a web search query, retrieve relevant passages that answer the query" a visszakeresési lekérdezésekhez, és amikor nem adnak meg utasítást a visszakeresendő dokumentumok beágyazásakor. Más modellek, például Instructor-XL számos utasítási sztringet támogatnak.

Beágyazási válasz

Mező Típus Leírás
id Karakterlánc A beágyazás egyedi azonosítója.
object Karakterlánc Az objektum típusa. Egyenlő a következővel: "list".
model Karakterlánc A beágyazás létrehozásához használt beágyazási modell neve.
data BeágyazottObjektum A beágyazási objektum.
usage Használat Token használati metaadatai.

EmbeddingObject

Mező Típus Leírás
object Karakterlánc Az objektum típusa. Egyenlő a következővel: "embedding".
index Egész szám A beágyazás indexe a modell által létrehozott beágyazások listájában.
embedding Lista[float] A beágyazási vektor. Minden modell egy rögzített méretű vektort ad vissza (1024 BGE-Large)

Befejezési API

A szövegkiegészítési feladatok egyetlen kérdésre adott válaszok létrehozására használhatók. A Csevegéssel ellentétben ez a feladat támogatja a kötegelt bemeneteket: több független kérés küldhető egyetlen kérelemben. Lásd POST /serving-endpoints/{name}/invocations a végpontparaméterek lekérdezéséhez.

Befejezési kérelem

Mező Alapértelmezett Típus Leírás
prompt Sztring vagy Lista[Sztring] Kötelező. A modell utasításai.
max_tokens null null, ami azt jelenti, hogy nincs korlát, vagy nullánál nagyobb egész szám A létrehozandó tokenek maximális száma.
stream true logikai A kérések részleges eredményének lehetővé tétele érdekében visszakérheti a válaszokat egy ügyfélnek. Ha ez a paraméter szerepel a kérelemben, a rendszer a válaszokat a kiszolgáló által küldött események standard használatával küldi el.
temperature 1.0 Lebegőpontos szám a [0,2] tartományban A mintavételi hőmérséklet. A 0 determinisztikus, és a magasabb értékek nagyobb véletlenszerűséget vezetnek be.
top_p 1.0 Lebegés (0,1] A nukleusz mintavételezéséhez használt valószínűségi küszöbérték.
top_k null null, ami azt jelenti, hogy nincs korlát, vagy nullánál nagyobb egész szám Meghatározza a top-k szűréshez használt legvalószínűbb k token számát. Állítsa ezt az értéket 1 értékre a kimenetek determinisztikussá tétele érdekében.
error_behavior "error" "truncate" vagy "error" Időtúllépések és a környezet hosszát túllépő hibák esetén. Az egyik: "truncate" (a lehető legtöbb tokeneket adja vissza) vagy "error" (hibát ad vissza). Ezt a paramétert csak tokenenkénti fizetésű végpontok fogadnak el.
n 1 Nullánál nagyobb egész szám Amikor meg van adva n, az API n független csevegési befejezéseket ad vissza. Olyan számítási feladatokhoz ajánlott, amelyek több befejezést hoznak létre ugyanazon a bemeneten a további következtetési hatékonyság és költségmegtakarítás érdekében. Csak kiosztott átviteli sebességű végpontokhoz érhető el.
stop [] Sztring vagy Lista[Sztring] A modell leállítja a további tokenek generálását, amikor a stop bármelyik sorozatát észleli.
suffix "" Karakterlánc Egy karakterlánc, amelyet minden befejezés végére hozzáfűznek.
echo false logikai A befejezéssel együtt adja vissza az utasítást.
use_raw_prompt true az előfizetett átviteli sebességhez, false a tokenenkénti fizetéshez logikai Ha true, adja át a prompt közvetlenül a modellbe átalakítás nélkül. Alapértelmezetten az true előfizetett átviteli sebességű végpontokra és false jogkivonatonkénti fizetéses végpontokra.

Befejezési válasz

Mező Típus Leírás
id Karakterlánc A szövegkiegészítés egyedi azonosítója.
choices BefejezésVálasztása A szövegkiegészítések listája. Minden átadott kérés esetén n választási lehetőségek jönnek létre, ha n van megadva. Az alapértelmezett n 1.
object Karakterlánc Az objektum típusa. Egyenlő "text_completion"
created Egész szám A generálás befejezésének ideje másodpercekben.
usage Használat Token használati metaadatai.

CompletionChoice

Mező Típus Leírás
index Egész szám A kérésben lévő prompt indexe.
text Karakterlánc A generált befejezés.
finish_reason Karakterlánc Az ok, amiért a modell leállította a tokenek létrehozását.

További erőforrások

  • Last updated on