Create chat completion

POST

https://api.openai.com/v1/chat/completions

Erstellt eine Modellantwort für die angegebene Chat-Konversation. Erfahren Sie mehr in den Textgenerierungs- , Visions- und Audioguides .

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/chat/completions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Hello!"}]
}'

Response Example

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

application/json

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

model

string

required

ID des zu verwendenden Modells. Einzelheiten dazu, welche Modelle mit der Chat-API funktionieren, finden Sie in der Modell-Endpunkt-Kompatibilitätstabelle .

messages

array [object {2}]

required

Eine Liste der Nachrichten, aus denen die Konversation bisher bestand. Beispiel-Python-Code .

role

string

optional

Die Rolle des Nachrichtenautors. Entweder system , user , assistant oder function .

content

string

optional

Der Inhalt der Nachricht. content ist für alle Nachrichten erforderlich, außer für Assistentennachrichten mit Funktionsaufrufen.

temperature

integer

optional

Welche Probentemperatur verwendet werden soll, liegt zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministischer machen. Wir empfehlen im Allgemeinen, this oder top_p zu ändern, jedoch nicht beide.

top_p

integer

optional

Eine Alternative zur Probenahme mit Temperatur, genannt Kernprobenahme, bei der das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse top_p berücksichtigt. 0,1 bedeutet also, dass nur die Token berücksichtigt werden, die die höchste Wahrscheinlichkeitsmasse von 10 % aufweisen. Wir empfehlen im Allgemeinen, diese oder temperature zu ändern, jedoch nicht beide.

integer

optional

Wie viele Chat-Abschlussoptionen für jede Eingabenachricht generiert werden sollen.

stream

boolean

optional

Wenn festgelegt, werden teilweise Nachrichtendeltas gesendet, wie in ChatGPT. Token werden als vom Server gesendete Nur-Daten-Ereignisse gesendet, sobald sie verfügbar sind, wobei der Stream durch eine data: [DONE] beendet wird. Beispiel-Python-Code .

stop

string

optional

Bis zu 4 Sequenzen, in denen die API die Generierung weiterer Token stoppt.

max_tokens

integer

optional

Die maximale Anzahl an Token, die beim Chat-Abschluss generiert werden sollen. Die Gesamtlänge der Eingabetokens und generierten Tokens ist durch die Kontextlänge des Modells begrenzt. Beispiel-Python-Code zum Zählen von Token.

presence_penalty

number

optional

Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend darauf, ob sie bisher im Text vorkommen, und erhöhen so die Wahrscheinlichkeit, dass das Modell über neue Themen spricht. Weitere Informationen zu Häufigkeits- und Anwesenheitsstrafen finden Sie hier.

frequency_penalty

number

optional

Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token aufgrund ihrer bisherigen Häufigkeit im Text und verringern so die Wahrscheinlichkeit des Modells, dieselbe Zeile wörtlich zu wiederholen. Weitere Informationen zu Häufigkeits- und Anwesenheitsstrafen finden Sie hier.

logit_bias

null

optional

Ändern Sie die Wahrscheinlichkeit, dass bestimmte Token in der Vervollständigung erscheinen. Akzeptiert ein JSON-Objekt, das Token (angegeben durch ihre Token-ID im Tokenizer) einem zugehörigen Bias-Wert von -100 bis 100 zuordnet. Mathematisch gesehen wird der Bias zu den vom Modell vor der Stichprobe generierten Logits hinzugefügt. Der genaue Effekt variiert je nach Modell, aber Werte zwischen -1 und 1 sollten die Auswahlwahrscheinlichkeit verringern oder erhöhen. Werte wie -100 oder 100 sollten zu einem Verbot oder einer exklusiven Auswahl des entsprechenden Tokens führen.

user

string

optional

Eine eindeutige Kennung, die Ihren Endbenutzer repräsentiert und OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. Erfahren Sie mehr .

Examples

Responses

🟢200OK

application/json

Body

string

required

object

string

required

created

integer

required

choices

array [object {3}]

required

index

integer

optional

message

object

optional

finish_reason

string

optional

usage

object

required

prompt_tokens

integer

required

completion_tokens

integer

required

total_tokens

integer

required

Modified at 2024-12-23 04:18:57

Übersetzung erstellen

Create embeddings