Sdílet prostřednictvím

Get Chat Completions - Get Chat Completions

  • Reference
Služba:
AI Foundry
Verze rozhraní API:
2024-05-01-preview

Získá dokončování chatu pro poskytnuté zprávy chatu. Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy. Metoda provede volání rozhraní REST API na trasu /chat/completions na daném koncovém bodu.

POST https:///chat/completions?api-version=2024-05-01-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
extra-parameters

ExtraParameters

Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje. Tím se nastaví hlavička požadavku HTTP extra-parameters.

Text požadavku

Name Vyžadováno Typ Description
messages True ChatRequestMessage[]:

Kolekce kontextových zpráv přidružených k tomuto požadavku na dokončení chatu. Typické použití začíná chatovou zprávou pro roli Systém, která poskytuje pokyny pro chování asistenta, následované alternací zpráv mezi rolemi Uživatel a Asistent.
frequency_penalty

number (float)

minimum: -2
maximum: 2

Hodnota, která ovlivňuje pravděpodobnost vygenerovaných tokenů zobrazených na základě jejich kumulativní frekvence ve generovaném textu. Kladné hodnoty způsobí, že se tokeny budou zobrazovat s menší pravděpodobností, když se jejich frekvence zvýší a sníží pravděpodobnost opakování stejného doslovného znění modelu. Podporovaný rozsah je [-2, 2].
max_tokens

integer (int32)

minimum: 0

Maximální počet tokenů, které se mají vygenerovat.
modalities

ChatCompletionsModality[]

Způsoby, které model může použít pro odpověď na dokončení chatu. Výchozí způsob je text. Označení nepodporované kombinace způsobů způsobí chybu 422.
model

string

ID konkrétního modelu AI, který se má použít, pokud je v koncovém bodu k dispozici více než jeden model.
presence_penalty

number (float)

minimum: -2
maximum: 2

Hodnota, která ovlivňuje pravděpodobnost vygenerovaných tokenů, která se zobrazuje na základě jejich stávající přítomnosti ve generovaném textu. Kladné hodnoty způsobí, že se tokeny budou zobrazovat méně pravděpodobné, když už existují, a zvýší pravděpodobnost modelu výstupu nových témat. Podporovaný rozsah je [-2, 2].
response_format ChatCompletionsResponseFormat:

Objekt určující formát, který musí model vypíše.

Nastavení na { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON.

Nastavení pro { "type": "json_object" } povolí režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON.

Důležité: při použití režimu JSON musíte také dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což označuje, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.
seed

integer (int64)

Pokud je zadáno, systém se bude snažit vzorkovat deterministicky tak, aby opakované požadavky se stejnými počátečními a parametry měly vrátit stejný výsledek. Determinismus není zaručen.
stop

string[]

Kolekce textových sekvencí, které ukončí generování dokončení.
stream

boolean

Hodnota označující, jestli se mají dokončení chatu streamovat pro tento požadavek.
temperature

number (float)

minimum: 0
maximum: 1

Teplota vzorkování, která řídí zdánlivou kreativitu vygenerovaných dokončení. Vyšší hodnoty způsobí, že výstup bude náhodný, zatímco nižší hodnoty budou výsledky více zaměřené a deterministické. Nedoporučuje se měnit teplotu a top_p pro stejnou žádost o dokončení, protože interakce těchto dvou nastavení je obtížné předpovědět. Podporovaný rozsah je [0, 1].
tool_choice

Pokud je zadaný, model nakonfiguruje, které z poskytnutých nástrojů může použít pro odpověď na dokončení chatu.
tools

ChatCompletionsToolDefinition[]

Seznam nástrojů, které model může požádat o volání. V současné době se jako nástroj podporují jenom funkce. Model může odpovědět pomocí požadavku na volání funkce a poskytnout vstupní argumenty ve formátu JSON pro tuto funkci.
top_p

number (float)

minimum: 0
maximum: 1

Alternativou k odběru vzorků s teplotou označovanou jako vzorkování vzorků. Tato hodnota způsobí, že model vezme v úvahu výsledky tokenů s poskytnutou pravděpodobností. Například hodnota 0,15 způsobí, že se považují pouze tokeny obsahující prvních 15% pravděpodobnostní hmotnosti. Nedoporučuje se měnit teplotu a top_p pro stejnou žádost o dokončení, protože interakce těchto dvou nastavení je obtížné předpovědět. Podporovaný rozsah je [0, 1].

Odpovědi

Name Typ Description
200 OK

ChatCompletions

Požadavek byl úspěšný.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name Description
https://ml.azure.com/.default

Příklady

Audio modality chat completion
maximum set chat completion
minimum set chat completion

Audio modality chat completion

Ukázkový požadavek

POST https:///chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text",
    "audio"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    },
    {
      "role": "assistant",
      "content": null,
      "audio": {
        "id": "abcdef1234"
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    }
  ],
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "seed": 21,
  "model": "my-model-name"
}

Ukázková odpověď

Stavový kód:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1696522361,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16,
    "completion_tokens_details": {
      "audio_tokens": 5,
      "total_tokens": 5
    },
    "prompt_tokens_details": {
      "audio_tokens": 10,
      "cached_tokens": 0
    }
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": null,
        "audio": {
          "id": "abcdef1234",
          "format": "wav",
          "data": "<base64 encoded audio data>",
          "expires_at": 1896522361,
          "transcript": "This is a sample transcript"
        }
      }
    }
  ]
}

maximum set chat completion

Ukázkový požadavek

POST https:///chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    },
    {
      "role": "assistant",
      "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594."
    },
    {
      "role": "user",
      "content": "Ist it proved?"
    }
  ],
  "frequency_penalty": 0,
  "stream": true,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "max_tokens": 255,
  "response_format": {
    "type": "text"
  },
  "stop": [
    "<|endoftext|>"
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "my-function-name",
        "description": "A function useful to know if a theroem is proved or not"
      }
    }
  ],
  "seed": 21,
  "model": "my-model-name"
}

Ukázková odpověď

Stavový kód:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 18,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16
  },
  "choices": [
    {
      "index": 7,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "yrobmilsrugmbwukmzo",
            "type": "function",
            "function": {
              "name": "my-function-name",
              "arguments": "{ \"arg1\": \"value1\", \"arg2\": \"value2\" }"
            }
          }
        ]
      }
    }
  ]
}

minimum set chat completion

Ukázkový požadavek

POST https:///chat/completions?api-version=2024-05-01-preview

{
  "messages": [
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    }
  ]
}

Ukázková odpověď

Stavový kód:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 205,
    "completion_tokens": 5,
    "total_tokens": 210
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594"
      }
    }
  ]
}

Definice

Name Description
AudioContentFormat

Reprezentace možných zvukových formátů pro zvuk.
Azure.Core.Foundations.Error

Objekt chyby.
Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ChatChoice

Reprezentace jednoho dokončení výzvy jako součást celkové žádosti o dokončení chatu. Obecně platí, že n volby se generují podle zadané výzvy s výchozí hodnotou 1. Limity tokenů a další nastavení můžou omezit počet vygenerovaných voleb.
ChatCompletions

Reprezentace dat odpovědí z žádosti o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy.
ChatCompletionsAudio

Reprezentace zvuku generovaného modelem.
ChatCompletionsModality

Způsoby, které model může použít pro odpověď na dokončení chatu.
ChatCompletionsOptions

Informace o konfiguraci žádosti o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy.
ChatCompletionsResponseFormatJsonObject

Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON. Všimněte si, že pokud chcete povolit režim JSON, některé modely AI můžou také vyžadovat, abyste model instruoval, aby vytvořil JSON prostřednictvím systémové nebo uživatelské zprávy.
ChatCompletionsResponseFormatJsonSchema

Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON se schématem JSON určeným volajícím.
ChatCompletionsResponseFormatJsonSchemaDefinition

Definice požadovaného schématu JSON v odpovědi a přidružených metadat.
ChatCompletionsResponseFormatText

Formát odpovědi pro dokončování chatu, který generuje textové odpovědi. Toto je výchozí formát odpovědi.
ChatCompletionsToolCall

Volání nástroje funkcí požadované modelem AI
ChatCompletionsToolDefinition

Definice nástroje pro dokončování chatu, který může volat funkci.
ChatRequestAssistantMessage

Žádost o chatovou zprávu představující odpověď nebo akci od asistenta.
ChatRequestAudioReference

Odkaz na zvukovou odpověď vygenerovanou modelem.
ChatRequestSystemMessage

Požadovaná zpráva chatu obsahující systémové pokyny, které ovlivňují, jak model vygeneruje odpověď na dokončení chatu.
ChatRequestToolMessage

Žádost o chatovou zprávu představující požadovaný výstup z nakonfigurovaného nástroje.
ChatRequestUserMessage

Žádost o chatovou zprávu představující vstup uživatele asistentovi.
ChatResponseMessage

Reprezentace chatové zprávy jako přijatá v odpovědi
ChatRole

Popis zamýšleného účelu zprávy v rámci interakce s dokončením chatu.
CompletionsFinishReason

Vyjádření způsobu, jakým byla ukončena odpověď na dokončení.
CompletionsUsage

Reprezentace počtu tokenů zpracovaných pro žádost o dokončení Počty berou v úvahu všechny tokeny napříč výzvami, volbami, alternativami voleb, best_of generacemi a dalšími uživateli.
CompletionsUsageDetails

Rozpis tokenů použitých při dokončování
ExtraParameters

Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje.
FunctionCall

Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.
FunctionDefinition

Definice funkce zadané volajícího, která může dokončení chatu vyvolat v reakci na odpovídající vstup uživatele.
PromptUsageDetails

Rozpis tokenů použitých v historii výzvy nebo chatu

AudioContentFormat

Výčet

Reprezentace možných zvukových formátů pro zvuk.

Hodnota Description
mp3

Určuje zvuk ve formátu MP3.
wav

Určuje zvuk ve formátu WAV.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

Azure.Core.Foundations.Error[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message

string

Čitelné znázornění chyby člověkem.
target

string

Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name Typ Description
error

Azure.Core.Foundations.Error

Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
innererror

Azure.Core.Foundations.InnerError

Vnitřní chyba.

ChatChoice

Objekt

Reprezentace jednoho dokončení výzvy jako součást celkové žádosti o dokončení chatu. Obecně platí, že n volby se generují podle zadané výzvy s výchozí hodnotou 1. Limity tokenů a další nastavení můžou omezit počet vygenerovaných voleb.

Name Typ Description
finish_reason

CompletionsFinishReason

Důvod, proč tato volba dokončení chatu dokončila jeho vygenerování.
index

integer (int32)

Seřazený index přidružený k této volbě dokončení chatu.
message

ChatResponseMessage

Výzva k dokončení chatu v chatu

ChatCompletions

Objekt

Reprezentace dat odpovědí z žádosti o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy.

Name Typ Description
choices

ChatChoice[]

Kolekce možností dokončení přidružených k této odpovědi dokončení Obecně platí, že n volby se generují podle zadané výzvy s výchozí hodnotou 1. Limity tokenů a další nastavení můžou omezit počet vygenerovaných voleb.
created

integer (unixtime)

První časové razítko přidružené k aktivitě generování pro tuto odezvu dokončení, reprezentované jako sekundy od začátku unixové epochy 00:00 1. 1970.
id

string

Odpověď na dokončení chatu je přidružený jedinečný identifikátor.
model

string

Model použitý k dokončení chatu.
object enum:

chat.completion

Typ objektu odpovědi, který je vždy chat.completion.
usage

CompletionsUsage

Informace o využití pro tokeny zpracovávané a generované v rámci této operace dokončení

ChatCompletionsAudio

Objekt

Reprezentace zvuku generovaného modelem.

Name Typ Description
data

string

Zakódovaná zvuková data base64
expires_at

integer (unixtime)

Časové razítko unixu (v sekundách), u kterého vyprší platnost zvukové části a na kterou už není možné odkazovat pomocí ID v konverzacích s více servery.
format

AudioContentFormat

Formát zvukového obsahu. Pokud formát není zadaný, bude odpovídat formátu použitému ve vstupním zvukovém požadavku.
id

string

Jedinečný identifikátor odpovědi na zvuk. Tuto hodnotu lze použít ve zprávách historie chatu místo předání celého zvukového objektu.
transcript

string

Přepis zvukového souboru.

ChatCompletionsModality

Výčet

Způsoby, které model může použít pro odpověď na dokončení chatu.

Hodnota Description
audio

Model může generovat zvuk.
text

Model může generovat pouze text.

ChatCompletionsOptions

Objekt

Informace o konfiguraci žádosti o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy.

Name Typ Default value Description
frequency_penalty

number (float)

minimum: -2
maximum: 2 		0

Hodnota, která ovlivňuje pravděpodobnost vygenerovaných tokenů zobrazených na základě jejich kumulativní frekvence ve generovaném textu. Kladné hodnoty způsobí, že se tokeny budou zobrazovat s menší pravděpodobností, když se jejich frekvence zvýší a sníží pravděpodobnost opakování stejného doslovného znění modelu. Podporovaný rozsah je [-2, 2].
max_tokens

integer (int32)

minimum: 0

Maximální počet tokenů, které se mají vygenerovat.
messages ChatRequestMessage[]:

Kolekce kontextových zpráv přidružených k tomuto požadavku na dokončení chatu. Typické použití začíná chatovou zprávou pro roli Systém, která poskytuje pokyny pro chování asistenta, následované alternací zpráv mezi rolemi Uživatel a Asistent.
modalities

ChatCompletionsModality[]

Způsoby, které model může použít pro odpověď na dokončení chatu. Výchozí způsob je text. Označení nepodporované kombinace způsobů způsobí chybu 422.
model

string

ID konkrétního modelu AI, který se má použít, pokud je v koncovém bodu k dispozici více než jeden model.
presence_penalty

number (float)

minimum: -2
maximum: 2 		0

Hodnota, která ovlivňuje pravděpodobnost vygenerovaných tokenů, která se zobrazuje na základě jejich stávající přítomnosti ve generovaném textu. Kladné hodnoty způsobí, že se tokeny budou zobrazovat méně pravděpodobné, když už existují, a zvýší pravděpodobnost modelu výstupu nových témat. Podporovaný rozsah je [-2, 2].
response_format ChatCompletionsResponseFormat:

Objekt určující formát, který musí model vypíše.

Nastavení na { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON.

Nastavení pro { "type": "json_object" } povolí režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON.

Důležité: při použití režimu JSON musíte také dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což označuje, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.
seed

integer (int64)

Pokud je zadáno, systém se bude snažit vzorkovat deterministicky tak, aby opakované požadavky se stejnými počátečními a parametry měly vrátit stejný výsledek. Determinismus není zaručen.
stop

string[]

Kolekce textových sekvencí, které ukončí generování dokončení.
stream

boolean

Hodnota označující, jestli se mají dokončení chatu streamovat pro tento požadavek.
temperature

number (float)

minimum: 0
maximum: 1 		0.7

Teplota vzorkování, která řídí zdánlivou kreativitu vygenerovaných dokončení. Vyšší hodnoty způsobí, že výstup bude náhodný, zatímco nižší hodnoty budou výsledky více zaměřené a deterministické. Nedoporučuje se měnit teplotu a top_p pro stejnou žádost o dokončení, protože interakce těchto dvou nastavení je obtížné předpovědět. Podporovaný rozsah je [0, 1].
tool_choice

Pokud je zadaný, model nakonfiguruje, které z poskytnutých nástrojů může použít pro odpověď na dokončení chatu.
tools

ChatCompletionsToolDefinition[]

Seznam nástrojů, které model může požádat o volání. V současné době se jako nástroj podporují jenom funkce. Model může odpovědět pomocí požadavku na volání funkce a poskytnout vstupní argumenty ve formátu JSON pro tuto funkci.
top_p

number (float)

minimum: 0
maximum: 1 		1

Alternativou k odběru vzorků s teplotou označovanou jako vzorkování vzorků. Tato hodnota způsobí, že model vezme v úvahu výsledky tokenů s poskytnutou pravděpodobností. Například hodnota 0,15 způsobí, že se považují pouze tokeny obsahující prvních 15% pravděpodobnostní hmotnosti. Nedoporučuje se měnit teplotu a top_p pro stejnou žádost o dokončení, protože interakce těchto dvou nastavení je obtížné předpovědět. Podporovaný rozsah je [0, 1].

ChatCompletionsResponseFormatJsonObject

Objekt

Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON. Všimněte si, že pokud chcete povolit režim JSON, některé modely AI můžou také vyžadovat, abyste model instruoval, aby vytvořil JSON prostřednictvím systémové nebo uživatelské zprávy.

Name Typ Description
type string:

json_object

Typ formátu odpovědi, který se má použít pro dokončování chatu.

ChatCompletionsResponseFormatJsonSchema

Objekt

Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON se schématem JSON určeným volajícím.

Name Typ Description
json_schema

ChatCompletionsResponseFormatJsonSchemaDefinition

Definice požadovaného schématu JSON v odpovědi a přidružených metadat.
type string:

json_schema

Typ formátu odpovědi, který se má použít pro dokončování chatu.

ChatCompletionsResponseFormatJsonSchemaDefinition

Objekt

Definice požadovaného schématu JSON v odpovědi a přidružených metadat.

Name Typ Default value Description
description

string

Popis formátu odpovědi, který model AI používá k určení způsobu generování odpovědí v tomto formátu.
name

string

Název formátu odpovědi. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.
schema

Definice schématu JSON
strict

boolean

False

Zda povolit přísné dodržování schématu při generování výstupu. Pokud je nastavená hodnota true, model bude vždy dodržovat přesné schéma definované v poli schema. Pokud je stricttrue, podporuje se pouze podmnožina schématu JSON.

ChatCompletionsResponseFormatText

Objekt

Formát odpovědi pro dokončování chatu, který generuje textové odpovědi. Toto je výchozí formát odpovědi.

Name Typ Description
type string:

text

Typ formátu odpovědi, který se má použít pro dokončování chatu.

ChatCompletionsToolCall

Objekt

Volání nástroje funkcí požadované modelem AI

Name Typ Description
function

FunctionCall

Podrobnosti volání funkce požadované modelem AI.
id

string

ID volání nástroje.
type enum:

function

Typ volání nástroje. V současné době se podporuje pouze function.

ChatCompletionsToolDefinition

Objekt

Definice nástroje pro dokončování chatu, který může volat funkci.

Name Typ Description
function

FunctionDefinition

Podrobnosti definice funkce pro nástroj funkce.
type enum:

function

Typ nástroje. V současné době se podporuje pouze function.

ChatRequestAssistantMessage

Objekt

Žádost o chatovou zprávu představující odpověď nebo akci od asistenta.

Name Typ Description
audio

ChatRequestAudioReference

Zvuk vygenerovaný předchozí odpovědí v konverzaci s vícenásobným otáčením
content

string

Obsah zprávy.
role string:

assistant

Role chatu přidružená k této zprávě.
tool_calls

ChatCompletionsToolCall[]

Volání nástroje, která musí být vyřešena a mají jejich výstupy připojené k následným vstupním zprávám pro žádost o dokončení chatu, aby se vyřešily podle konfigurace.

ChatRequestAudioReference

Objekt

Odkaz na zvukovou odpověď vygenerovanou modelem.

Name Typ Description
id

string

Jedinečný identifikátor odpovědi na zvuk. Tato hodnota odpovídá ID předchozího dokončení zvuku.

ChatRequestSystemMessage

Objekt

Požadovaná zpráva chatu obsahující systémové pokyny, které ovlivňují, jak model vygeneruje odpověď na dokončení chatu.

Name Typ Description
content

string

Obsah systémové zprávy.
role string:

system

Role chatu přidružená k této zprávě.

ChatRequestToolMessage

Objekt

Žádost o chatovou zprávu představující požadovaný výstup z nakonfigurovaného nástroje.

Name Typ Description
content

string

Obsah zprávy.
role string:

tool

Role chatu přidružená k této zprávě.
tool_call_id

string

ID volání nástroje vyřešené poskytnutým obsahem.

ChatRequestUserMessage

Objekt

Žádost o chatovou zprávu představující vstup uživatele asistentovi.

Name Typ Description
content

Obsah zprávy uživatele s dostupnými vstupními typy se liší podle vybraného modelu.
role string:

user

Role chatu přidružená k této zprávě.

ChatResponseMessage

Objekt

Reprezentace chatové zprávy jako přijatá v odpovědi

Name Typ Description
audio

ChatCompletionsAudio

Zvuk vygenerovaný modelem jako odpověď na zprávy, pokud je model nakonfigurovaný tak, aby vygeneroval zvuk.
content

string

Obsah zprávy.
role

ChatRole

Role chatu přidružená ke zprávě.
tool_calls

ChatCompletionsToolCall[]

Volání nástroje, která musí být vyřešena a mají jejich výstupy připojené k následným vstupním zprávám pro žádost o dokončení chatu, aby se vyřešily podle konfigurace.

ChatRole

Výčet

Popis zamýšleného účelu zprávy v rámci interakce s dokončením chatu.

Hodnota Description
assistant

Role, která poskytuje odpovědi na vstup s pokynem systému a uživatelem.
developer

Role, která poskytuje pokyny k modelu s prioritou před uživatelskými zprávami.
system

Role, která dává pokyn nebo nastavuje chování asistenta.
tool

Role, která představuje aktivitu nástroje rozšíření v rámci operace dokončení chatu.
user

Role, která poskytuje vstup pro dokončování chatu.

CompletionsFinishReason

Výčet

Vyjádření způsobu, jakým byla ukončena odpověď na dokončení.

Hodnota Description
content_filter

Dokončování vygenerovalo odpověď, která byla identifikována jako potenciálně citlivá na zásady moderování obsahu.
length

Dokončení vyčerpalo dostupné limity tokenů před dokončením generování.
stop

Dokončení skončilo normálně a dosáhlo konce generování tokenů.
tool_calls

Dokončení skončilo modelem voláním poskytnutého nástroje pro výstup.

CompletionsUsage

Objekt

Reprezentace počtu tokenů zpracovaných pro žádost o dokončení Počty berou v úvahu všechny tokeny napříč výzvami, volbami, alternativami voleb, best_of generacemi a dalšími uživateli.

Name Typ Description
completion_tokens

integer (int32)

Počet tokenů vygenerovaných napříč všemi emisemi dokončení.
completion_tokens_details

CompletionsUsageDetails

Rozpis tokenů použitých při dokončování
prompt_tokens

integer (int32)

Počet tokenů v zadaných výzev k dokončení žádosti.
prompt_tokens_details

PromptUsageDetails

Rozpis tokenů použitých v historii výzvy nebo chatu
total_tokens

integer (int32)

Celkový počet tokenů zpracovaných pro požadavek na dokončení a odpověď.

CompletionsUsageDetails

Objekt

Rozpis tokenů použitých při dokončování

Name Typ Description
audio_tokens

integer (int32)

Počet tokenů odpovídajících zvukovému vstupu.
total_tokens

integer (int32)

Celkový počet tokenů zpracovaných pro požadavek na dokončení a odpověď.

ExtraParameters

Výčet

Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje.

Hodnota Description
drop

Služba bude v datové části požadavku ignorovat (vynechat) další parametry. Předá pouze známé parametry modelu AI back-endu.
error

Pokud služba zjistila v datové části požadavku další parametry, dojde k chybě. Toto je výchozí služba.
pass-through

Služba předá back-endový model AI další parametry.

FunctionCall

Objekt

Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.

Name Typ Description
arguments

string

Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný json a může halucinovat parametry, které nejsou definovány schématem vaší funkce. Před voláním funkce ověřte argumenty v kódu.
name

string

Název funkce, která se má volat.

FunctionDefinition

Objekt

Definice funkce zadané volajícího, která může dokončení chatu vyvolat v reakci na odpovídající vstup uživatele.

Name Typ Description
description

string

Popis toho, co funkce dělá. Tento popis použije model při výběru funkce a interpretaci jejích parametrů.
name

string

Název funkce, která se má volat.
parameters

Parametry, které funkce přijímá, jsou popsány jako objekt schématu JSON.

PromptUsageDetails

Objekt

Rozpis tokenů použitých v historii výzvy nebo chatu

Name Typ Description
audio_tokens

integer (int32)

Počet tokenů odpovídajících zvukovému vstupu.
cached_tokens

integer (int32)

Celkový počet tokenů uložených v mezipaměti.