Créer une réponse textuelle

Choisissez cette API lorsque votre application utilise le format de message texte Responses. Fournissez la conversation à chaque requête ; les réponses ne sont pas stockées pour une récupération ultérieure.

Envoyez une requête#

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 '{
  "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 = {'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 = {
  "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());

Champs de la requête#

Continuer une conversation#

Envoyez les messages précédents dans input avec le prochain message utilisateur. Les rôles pris en charge sont user, assistant, system et developer. Les instructions pour les développeurs utilisent le rôle système en interne. Le contenu des messages peut être du texte ou input_text/output_text des parties.

{
  "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
}

Lire le résultat#

La réponse JSON est un response objet. Lisez le texte de l'assistant à partir des output[].content[] entrées avec le type output_text. Vérifiez le statut de la réponse : completed est une réponse terminée ; incomplete peut indiquer une limite de jetons. Public usage est actuellement nul ; utilisez Console Usage pour inspecter l'utilisation traitée.

Diffusez une réponse#

Définissez stream: true et analysez SSE. Les événements incluent response.created, response.output_text.delta et un terminal response.completed, response.incomplete ou response.failed. Ajoutez les deltas de texte dans l'ordre et gérez explicitement le statut terminal.

Sous-ensemble pris en charge#

Ce point de terminaison prend en charge la génération de texte. Les réponses stockées, previous_response_id, récupération/suppression, outils, entrée d'image, requêtes en arrière-plan et paramètres de génération tels que temperature ne sont pas pris en charge et sont rejetés. Pour les paramètres de génération basés sur des messages pris en charge par Chat Completions, utilisez Achèvements de chat.

Utilisez un jeton d'accès OAuth#

Remplacez la clé API dans l'en-tête Authorization par un jeton d'accès OAuth approuvé. Le surcharge périmètre et le plan d'utilisation accepté sont requis pour l'inférence financée par le compte. Les périmètres d'identité uniquement n'autorisent pas les dépenses. Voir périmètres et autorisations.