Eine Textantwort erstellen

Wählen Sie diese API, wenn Ihre Anwendung das Responses-Textnachrichtenformat verwendet. Übermitteln Sie das Gespräch bei jeder Anfrage; Antworten werden nicht für eine spätere Abrufung gespeichert.

Eine Anfrage senden#

curl --fail-with-body --request POST \
  "https://api.shareai.now/api/v1/responses" \
  -H "Authorization: Bearer $SHAREAI_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "provider": {
    "sort": {
      "by": "price",
      "direction": "asc"
    }
  },
  "model": "YOUR_CHAT_MODEL",
  "input": "Explain semantic search in two sentences.",
  "instructions": "Use plain language.",
  "store": false,
  "stream": false
}'

import json
import os
import urllib.request

headers = {"Authorization": "Bearer " + os.environ["SHAREAI_API_KEY"]}
headers["Content-Type"] = "application/json"
payload = {'provider': {'sort': {'by': 'price', 'direction': 'asc'}}, 'model': 'YOUR_CHAT_MODEL', 'input': 'Explain semantic search in two sentences.', 'instructions': 'Use plain language.', 'store': False, 'stream': False}
data = json.dumps(payload).encode()
request = urllib.request.Request('https://api.shareai.now/api/v1/responses', data=data, headers=headers, method='POST')
with urllib.request.urlopen(request, timeout=60) as response:
    print(json.load(response))

const url = "https://api.shareai.now/api/v1/responses";
const headers: Record = {
  Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`,
};
headers["Content-Type"] = "application/json";
const payload = {
  "provider": {
    "sort": {
      "by": "price",
      "direction": "asc"
    }
  },
  "model": "YOUR_CHAT_MODEL",
  "input": "Explain semantic search in two sentences.",
  "instructions": "Use plain language.",
  "store": false,
  "stream": false
};
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify(payload) });
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Anforderungsfelder#

Ein Gespräch fortsetzen#

Senden Sie frühere Nachrichten in input zusammen mit der nächsten Benutzernachricht. Unterstützte Rollen sind user, assistant, system und developer. Entwickleranweisungen verwenden intern die Systemrolle. Nachrichteninhalte können Text oder input_text/output_text Teile sein.

{
  "model": "YOUR_CHAT_MODEL",
  "input": [
    {
      "role": "user",
      "content": "What is semantic search?"
    },
    {
      "role": "assistant",
      "content": "It finds results by meaning rather than exact words."
    },
    {
      "role": "user",
      "content": "Give one example."
    }
  ],
  "store": false
}

Das Ergebnis lesen#

Die JSON-Antwort ist ein response Objekt. Lesen Sie den Assistententext aus output[].content[] Einträgen mit Typ output_text. Überprüfen Sie den Antwortstatus: completed ist eine abgeschlossene Antwort; incomplete kann ein Token-Limit anzeigen. Öffentlich usage ist derzeit null; verwenden Sie Konsolennutzung, um verarbeitete Nutzung zu überprüfen.

Streamen Sie eine Antwort#

Legen Sie stream: true und SSE analysieren. Ereignisse umfassen response.created, response.output_text.delta und einen terminalen response.completed, response.incomplete oder response.failed. Fügen Sie Text-Deltas in der Reihenfolge an und behandeln Sie den terminalen Status explizit.

Unterstützter Teilbereich#

Dieser Endpunkt unterstützt die Textgenerierung. Gespeicherte Antworten, previous_response_id, Abruf/Löschung, Tools, Bildeingabe, Hintergrundanfragen und Generierungseinstellungen wie temperature werden nicht unterstützt und abgelehnt. Für nachrichtenbasierte Generierungseinstellungen, die von Chat Completions unterstützt werden, verwenden Sie Chat-Abschlüsse.

Verwenden Sie ein OAuth-Zugriffstoken#

Ersetzen Sie den API-Schlüssel im Authorization-Header durch ein genehmigtes OAuth-Zugriffstoken. Die surcharge Scope und akzeptierter Nutzungsplan sind erforderlich für kontofinanzierte Inferenz. Scopes, die nur die Identität betreffen, autorisieren keine Ausgaben. Siehe Scopes und Berechtigungen.

Modellidentität und Ausführungsanbieter#

Kopieren Sie die genaue, auf dem Creator basierende Modellkennung von Modelle. Wählen Sie die Infrastruktur separat mit dem optionalen provider Objekt aus. Standardmäßig werden berechtigte Anbieter nach Preis sortiert, beginnend mit dem niedrigsten. Anbieter auswählen oder konsultieren Sie die vollständige Richtlinienreferenz.