Référence de l'API REST Foundation Model

Cet article fournit des informations générales sur l'API pour les APIs de modèle de fondation Databricks et les modèles qu'elles prennent en charge. Les APIs Foundation Model sont conçues pour être similaires à l'API REST d'OpenAI afin de faciliter la migration des projets existants. Les Endpoint de throughput provisionné et de paiement au jeton acceptent tous deux le même format de requête d'API REST.

Endpoint

Les APIs de modèle de fondation prennent en charge les endpoints de paiement au jeton et les endpoints de throughput provisionné.

Un Endpoint préconfiguré est disponible dans votre Workspace pour chaque modèle pris en charge avec paiement par jeton, et les utilisateurs peuvent interagir avec ces Endpoints à l'aide de requêtes HTTP POST. Pour les modèles pris en charge, consultez la page Modèles de fondation pris en charge sur Model Serving.

Les endpoints de débit throughput peuvent être créés à l'aide de l'API ou de l'interface utilisateur de Serving. Ces Endpoint prennent en charge plusieurs modèles par Endpoint pour les tests A/B, tant que les deux modèles déployés exposent le même format d'API. Par exemple, les deux modèles sont des modèles de chat. Voir POST /api/2.0/serving-endpoints pour les paramètres de configuration de l'endpoint.

Les requêtes et les réponses utilisent JSON, la structure JSON exacte dépend du type de tâche d'un endpoint. Les endpoints de chat et de complétion prennent en charge les réponses en streaming.

Utilisation

Les réponses incluent un sous-message usage qui indique le nombre de jetons dans la requête et la réponse. Le format de ce sous-message est le même pour tous les types de tâches.

Champ	Type	Description
completion_tokens	Entier	Nombre de jetons générés. Non inclus dans les réponses d'intégration.
prompt_tokens	Entier	Nombre de jetons des invites d'entrée.
total_tokens	Entier	Nombre total de jetons.
reasoning_tokens	Entier	Nombre de jetons de réflexion. Ceci n'est applicable qu'aux modèles de raisonnement.

Champ	Type	Description
completion_tokens	Entier	Nombre de jetons générés. Non inclus dans les réponses d'intégration.
prompt_tokens	Entier	Nombre de jetons des invites d'entrée.
total_tokens	Entier	Nombre total de jetons.
reasoning_tokens	Entier	Nombre de jetons de réflexion. Ceci n'est applicable qu'aux modèles de raisonnement.

Pour les modèles comme databricks-meta-llama-3-3-70b-instruct, une requête utilisateur est transformée à l’aide d’un template de prompt avant d’être transmise au modèle. Pour les Endpoint au paiement par jeton, une invite système peut également être ajoutée. prompt_tokens comprend tout le texte ajouté par notre serveur.

API Responses

important

Cette référence de l'API de réponses s'applique aux modèles OpenAI. Pour utiliser le format de requête de réponses avec Anthropic Claude, Google Gemini ou des modèles ouverts hébergés par Databricks, consultez Query un modèle avec l'API Open Responses.

L'API Réponses permet des conversations multi-tours avec un modèle. Contrairement aux Complétions de chat, l'API Réponses utilise input au lieu de messages.

Requêtes API

Champ	Par défaut	Type	Description
model		Chaîne	Obligatoire . ID du modèle utilisé pour générer la réponse.
input		Chaîne ou List[ResponsesInput]	Obligatoire . Entrées de texte, d'image ou de fichier pour le modèle, utilisées pour générer une réponse. Contrairement à messages, ce champ utilise input pour spécifier le contenu de la conversation.
instructions	null	Chaîne	Un message système (ou de développeur) inséré dans le contexte du modèle.
max_output_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Une limite supérieure pour le nombre de jetons pouvant être générés pour une réponse, incluant les jetons de sortie visibles et les jetons de raisonnement.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
stream	false	Booléen	Si la valeur est true, les données de réponse du modèle seront Stream au client au fur et à mesure de leur génération à l’aide d’événements envoyés par le serveur.
stream_options	null	StreamOptions	Options pour les réponses en streaming. Ne le définissez que lorsque vous définissez stream: true.
text	null	TextConfig	Options de configuration pour une réponse textuelle du modèle. Peut être du texte brut ou des données JSON structurées.
reasoning	null	ReasoningConfig	Configuration du raisonnement pour les modèles gpt-5 et o-series.
tool_choice	"auto"	Chaîne ou ToolChoiceObject	Comment le modèle doit sélectionner l'outil (ou les outils) à utiliser lors de la génération d'une réponse. Consultez le paramètre tools pour voir comment spécifier les outils que le modèle peut appeler.
tools	null	Liste[ToolObject]	Un ensemble d'outils que le modèle peut appeler lors de la génération d'une réponse. Note : L'interpréteur de code et les outils de recherche web ne sont pas pris en charge par Databricks.
parallel_tool_calls	true	Booléen	S’il faut autoriser le modèle à exécuter des appels d'outil en parallèle.
max_tool_calls	null	Entier supérieur à zéro	Le nombre maximal d'appels totaux aux outils intégrés pouvant être traités dans une réponse.
metadata	null	Objet	Ensemble de 16 paires clé-valeur pouvant être associées à un objet.
prompt_cache_key	null	Chaîne	Utilisé pour mettre en cache les réponses pour des requêtes similaires afin d'optimiser les taux de réussite du cache. Remplace le champ user.
prompt_cache_retention	null	Chaîne	La politique de rétention pour le cache de requêtes. Définissez sur "24h" pour activer la mise en cache étendue des invites, ce qui maintient les préfixes mis en cache actifs plus longtemps, jusqu'à un maximum de 24 heures.
safety_identifier	null	Chaîne	Un identifiant stable utilisé pour aider à détecter les utilisateurs de votre application qui pourraient violer les politiques d'utilisation.
user	null	Chaîne	Obsolète . Utilisez safety_identifier et prompt_cache_key à la place.
truncation	null	Chaîne	La stratégie de troncation à utiliser pour la réponse du modèle.
top_logprobs	null	Entier	Un entier entre 0 et 20 spécifiant le nombre de jetons les plus probables à retourner à chaque position de jeton, chacun avec une probabilité logarithmique associée.
include	null	Liste[Chaîne]	Spécifiez des données de sortie supplémentaires à inclure dans la réponse du modèle.
prompt	null	Objet	Référence à un Template de prompt et à ses variables.

Champ	Par défaut	Type	Description
model		Chaîne	Obligatoire . ID du modèle utilisé pour générer la réponse.
input		Chaîne ou List[ResponsesInput]	Obligatoire . Entrées de texte, d'image ou de fichier pour le modèle, utilisées pour générer une réponse. Contrairement à messages, ce champ utilise input pour spécifier le contenu de la conversation.
instructions	null	Chaîne	Un message système (ou de développeur) inséré dans le contexte du modèle.
max_output_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Une limite supérieure pour le nombre de jetons pouvant être générés pour une réponse, incluant les jetons de sortie visibles et les jetons de raisonnement.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
stream	false	Booléen	Si la valeur est true, les données de réponse du modèle seront Stream au client au fur et à mesure de leur génération à l’aide d’événements envoyés par le serveur.
stream_options	null	StreamOptions	Options pour les réponses en streaming. Ne le définissez que lorsque vous définissez stream: true.
text	null	TextConfig	Options de configuration pour une réponse textuelle du modèle. Peut être du texte brut ou des données JSON structurées.
reasoning	null	ReasoningConfig	Configuration du raisonnement pour les modèles gpt-5 et o-series.
tool_choice	"auto"	Chaîne ou ToolChoiceObject	Comment le modèle doit sélectionner l'outil (ou les outils) à utiliser lors de la génération d'une réponse. Consultez le paramètre tools pour voir comment spécifier les outils que le modèle peut appeler.
tools	null	Liste[ToolObject]	Un ensemble d'outils que le modèle peut appeler lors de la génération d'une réponse. Note : L'interpréteur de code et les outils de recherche web ne sont pas pris en charge par Databricks.
parallel_tool_calls	true	Booléen	S’il faut autoriser le modèle à exécuter des appels d'outil en parallèle.
max_tool_calls	null	Entier supérieur à zéro	Le nombre maximal d'appels totaux aux outils intégrés pouvant être traités dans une réponse.
metadata	null	Objet	Ensemble de 16 paires clé-valeur pouvant être associées à un objet.
prompt_cache_key	null	Chaîne	Utilisé pour mettre en cache les réponses pour des requêtes similaires afin d'optimiser les taux de réussite du cache. Remplace le champ user.
prompt_cache_retention	null	Chaîne	La politique de rétention pour le cache de requêtes. Définissez sur "24h" pour activer la mise en cache étendue des invites, ce qui maintient les préfixes mis en cache actifs plus longtemps, jusqu'à un maximum de 24 heures.
safety_identifier	null	Chaîne	Un identifiant stable utilisé pour aider à détecter les utilisateurs de votre application qui pourraient violer les politiques d'utilisation.
user	null	Chaîne	Obsolète . Utilisez safety_identifier et prompt_cache_key à la place.
truncation	null	Chaîne	La stratégie de troncation à utiliser pour la réponse du modèle.
top_logprobs	null	Entier	Un entier entre 0 et 20 spécifiant le nombre de jetons les plus probables à retourner à chaque position de jeton, chacun avec une probabilité logarithmique associée.
include	null	Liste[Chaîne]	Spécifiez des données de sortie supplémentaires à inclure dans la réponse du modèle.
prompt	null	Objet	Référence à un Template de prompt et à ses variables.

Paramètres non pris en charge : Les paramètres suivants ne sont pas pris en charge par Databricks et renverront une erreur 400 s'ils sont spécifiés.

• background - Le traitement en arrière-plan n'est pas pris en charge
• store - Les réponses stockées ne sont pas prises en charge
• conversation - L'API de conversation n'est pas prise en charge
• service_tier - La sélection du niveau de service est gérée par Databricks

ResponsesInput

Le champ input accepte soit une chaîne de caractères, soit une liste d'objets de message d'entrée avec rôle et contenu.

Champ	Type	Description
role	Chaîne	Obligatoire . Le rôle de l'auteur du message. Peut être "user" ou "assistant".
content	Chaîne ou Liste[ResponsesContentBlock]	Obligatoire . Le contenu du message, soit sous forme de chaîne de caractères, soit sous forme de tableau de blocs de contenu.

Champ	Type	Description
role	Chaîne	Obligatoire . Le rôle de l'auteur du message. Peut être "user" ou "assistant".
content	Chaîne ou Liste[ResponsesContentBlock]	Obligatoire . Le contenu du message, soit sous forme de chaîne de caractères, soit sous forme de tableau de blocs de contenu.

ResponsesContentBlock

Les blocs de contenu définissent le type de contenu dans les messages d'entrée et de sortie. Le type de bloc de contenu est déterminé par le champ type.

InputText

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_text".
text	Chaîne	Obligatoire . Le contenu textuel.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_text".
text	Chaîne	Obligatoire . Le contenu textuel.

OutputText

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "output_text".
text	Chaîne	Obligatoire . Le contenu textuel.
annotations	List[Objet]	Annotations facultatives pour le contenu textuel.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "output_text".
text	Chaîne	Obligatoire . Le contenu textuel.
annotations	List[Objet]	Annotations facultatives pour le contenu textuel.

InputImage

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_image".
image_url	Chaîne	Obligatoire . URL ou URI de données encodées en base64 de l'image.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_image".
image_url	Chaîne	Obligatoire . URL ou URI de données encodées en base64 de l'image.

InputFile

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_file".
file_id	Chaîne	Identifiant du fichier si vous utilisez des fichiers upload.
filename	Chaîne	Le nom du fichier.
file_data	Chaîne	URI de données encodée en Base64 avec préfixe de format. Par exemple, les fichiers PDF utilisent le format data:application/pdf;base64,<base64 data>.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "input_file".
file_id	Chaîne	Identifiant du fichier si vous utilisez des fichiers upload.
filename	Chaîne	Le nom du fichier.
file_data	Chaîne	URI de données encodée en Base64 avec préfixe de format. Par exemple, les fichiers PDF utilisent le format data:application/pdf;base64,<base64 data>.

FunctionCall

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "function_call".
id	Chaîne	Obligatoire . Identifiant unique pour l'appel de fonction.
call_id	Chaîne	Obligatoire . L'identifiant d'appel.
name	Chaîne	Obligatoire . Le nom de la fonction appelée.
arguments	Objet/Chaîne	Obligatoire . Les arguments de fonction en tant qu'objet JSON ou chaîne.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "function_call".
id	Chaîne	Obligatoire . Identifiant unique pour l'appel de fonction.
call_id	Chaîne	Obligatoire . L'identifiant d'appel.
name	Chaîne	Obligatoire . Le nom de la fonction appelée.
arguments	Objet/Chaîne	Obligatoire . Les arguments de fonction en tant qu'objet JSON ou chaîne.

FunctionCallOutput

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "function_call_output".
call_id	Chaîne	Obligatoire . L'identifiant d'appel auquel correspond cette sortie.
output	Chaîne/Objet	Obligatoire . La sortie de la fonction sous forme de chaîne ou d'objet JSON.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "function_call_output".
call_id	Chaîne	Obligatoire . L'identifiant d'appel auquel correspond cette sortie.
output	Chaîne/Objet	Obligatoire . La sortie de la fonction sous forme de chaîne ou d'objet JSON.

CustomToolCall

Renvoie dans le tableau output de la réponse lorsqu'un outil personnalisé est appelé. Contrairement aux appels de fonction, les appels d'outils personnalisés renvoient du texte brut input au lieu de JSON arguments.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "custom_tool_call".
id	Chaîne	Obligatoire . Identifiant unique pour cet appel d'outil personnalisé.
call_id	Chaîne	Obligatoire . L'identifiant d'appel.
name	Chaîne	Obligatoire . Le nom de l'outil personnalisé appelé.
input	Chaîne	Obligatoire . L’entrée de l’outil en texte brut (pas en JSON).
status	Chaîne	L'état de l'appel de l'outil. L’un des éléments suivants : completed, in_progress.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "custom_tool_call".
id	Chaîne	Obligatoire . Identifiant unique pour cet appel d'outil personnalisé.
call_id	Chaîne	Obligatoire . L'identifiant d'appel.
name	Chaîne	Obligatoire . Le nom de l'outil personnalisé appelé.
input	Chaîne	Obligatoire . L’entrée de l’outil en texte brut (pas en JSON).
status	Chaîne	L'état de l'appel de l'outil. L’un des éléments suivants : completed, in_progress.

CustomToolCallOutput

Utilisez ce type d'entrée pour fournir le résultat d'un appel d'outil personnalisé au modèle dans une conversation à plusieurs tours.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "custom_tool_call_output".
call_id	Chaîne	Obligatoire . L'identifiant d'appel auquel correspond cette sortie.
output	Chaîne	Obligatoire . La sortie de l'outil personnalisé sous forme de chaîne.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être "custom_tool_call_output".
call_id	Chaîne	Obligatoire . L'identifiant d'appel auquel correspond cette sortie.
output	Chaîne	Obligatoire . La sortie de l'outil personnalisé sous forme de chaîne.

StreamOptions

Configuration pour les réponses en streaming. Utilisé uniquement lorsque stream: true.

Champ	Type	Description
include_usage	Booléen	Si vrai, incluez les informations d'utilisation des jetons dans le Stream. default est false.

Champ	Type	Description
include_usage	Booléen	Si vrai, incluez les informations d'utilisation des jetons dans le Stream. default est false.

TextConfig

Configuration de la sortie de texte, y compris les sorties structurées.

Champ	Type	Description
format	Objet Format des réponses	La spécification de format pour la sortie de texte.

Champ	Type	Description
format	Objet Format des réponses	La spécification de format pour la sortie de texte.

ResponsesFormatObject

Spécifie le format de sortie pour les réponses textuelles.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de format : "text" pour le texte brut, "json_object" pour JSON ou "json_schema" pour le JSON structuré.
json_schema	Objet	**Obligatoire** type lorsque "json_schema" est. L'objet schéma JSON qui définit la structure de la sortie.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de format : "text" pour le texte brut, "json_object" pour JSON ou "json_schema" pour le JSON structuré.
json_schema	Objet	**Obligatoire** type lorsque "json_schema" est. L'objet schéma JSON qui définit la structure de la sortie.

L'objet json_schema a la même structure que JsonSchemaObject documenté dans l'API Chat Completions.

ReasoningConfig

Configuration du comportement de raisonnement dans les modèles de raisonnement (modèles de la série O et gpt-5).

Champ	Type	Description
effort	Chaîne	Le niveau d'effort de raisonnement : "low", "medium" ou "high". La valeur par default est "medium".
encrypted_content	Chaîne	Contenu de raisonnement chiffré pour le mode sans état. Fourni par le modèle dans les réponses précédentes.

Champ	Type	Description
effort	Chaîne	Le niveau d'effort de raisonnement : "low", "medium" ou "high". La valeur par default est "medium".
encrypted_content	Chaîne	Contenu de raisonnement chiffré pour le mode sans état. Fourni par le modèle dans les réponses précédentes.

ToolObject

Consultez Appel de fonction sur Databricks.

remarque

L'API de réponses prend en charge les types d'outils suivants : function, custom, mcp, image_generation, shell. Les outils personnalisés et les formats de sortie basés sur la grammaire ne sont disponibles qu'avec les modèles de la série GPT-5 (gpt-5, gpt-5.1, gpt-5.2).

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de l'outil. Voir la note ci-dessus pour les valeurs prises en charge.
function	ObjetFonction	Requis lorsque type est function. La définition de la fonction associée à l'outil.
name	Chaîne	Requis lorsque type est custom. Le nom de l'outil personnalisé.
description	Chaîne	Requis lorsque type est custom. Description de ce que fait l'outil personnalisé.
format	CustomFormat	Facultatif. Lorsque type est custom, spécifie le format de sortie. Par default à {"type": "text"}. Peut également utiliser {"type": "grammar", "definition": "<grammar>", "syntax": "lark"} pour la sortie structurée. Pris en charge uniquement avec les modèles de la série GPT-5.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de l'outil. Voir la note ci-dessus pour les valeurs prises en charge.
function	ObjetFonction	Requis lorsque type est function. La définition de la fonction associée à l'outil.
name	Chaîne	Requis lorsque type est custom. Le nom de l'outil personnalisé.
description	Chaîne	Requis lorsque type est custom. Description de ce que fait l'outil personnalisé.
format	CustomFormat	Facultatif. Lorsque type est custom, spécifie le format de sortie. Par default à {"type": "text"}. Peut également utiliser {"type": "grammar", "definition": "<grammar>", "syntax": "lark"} pour la sortie structurée. Pris en charge uniquement avec les modèles de la série GPT-5.

CustomToolObject

Les outils personnalisés permettent au modèle de renvoyer une sortie de chaîne arbitraire au lieu d'arguments de fonction formatés en JSON. Ceci est utile pour la génération de code, l'application de correctifs ou d'autres cas d'utilisation où le JSON structuré n'est pas requis.

remarque

Les outils personnalisés ne sont pris en charge qu'avec les modèles de la série GPT-5 (gpt-5, gpt-5.1, gpt-5.2) via l'API Responses.

Exemple d'outil personnalisé :

JSON

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

Exemple d’outil personnalisé avec grammaire :

JSON

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

Lorsqu'un outil personnalisé est appelé, la réponse contient un élément de sortie custom_tool_call avec du texte brut input au lieu de JSON arguments.

CustomFormat

Les formats de sortie basés sur la grammaire ne sont pris en charge qu’avec les modèles de la série GPT-5.

Champ	Type	Description
type	Chaîne	Obligatoire . Soit "text" pour une sortie en texte brut, soit "grammar" pour une sortie contrainte par la grammaire.
definition	Chaîne	Requis lorsque type est "grammar". La chaîne de définition de grammaire utilisant la syntaxe Lark.
syntax	Chaîne	Requis lorsque type est "grammar". La syntaxe grammaticale. Actuellement, seul "lark" est pris en charge.

Champ	Type	Description
type	Chaîne	Obligatoire . Soit "text" pour une sortie en texte brut, soit "grammar" pour une sortie contrainte par la grammaire.
definition	Chaîne	Requis lorsque type est "grammar". La chaîne de définition de grammaire utilisant la syntaxe Lark.
syntax	Chaîne	Requis lorsque type est "grammar". La syntaxe grammaticale. Actuellement, seul "lark" est pris en charge.

FunctionObject

Champ	Type	Description
name	Chaîne	Obligatoire . Le nom de la fonction à appeler.
description	Objet	Obligatoire . La description détaillée de la fonction. Le modèle utilise cette description pour comprendre la pertinence de la fonction par rapport à l'invite et générer les appels d'outils avec une plus grande précision.
parameters	Objet	Les paramètres que la fonction accepte, décrits comme un objet de schéma JSON valide. Si l'outil est appelé, l'appel de l'outil est conforme au schéma JSON fourni. L'omission de paramètres définit une fonction sans aucun paramètre. Le nombre de properties est limité à 15 clés.
strict	Booléen	Faut-il activer l'adhérence stricte au schéma lors de la génération de l'appel de fonction. Si défini sur true, le modèle suit le schéma exact défini dans le champ du schéma. Seul un sous-ensemble du schéma JSON est pris en charge lorsque strict est true

Champ	Type	Description
name	Chaîne	Obligatoire . Le nom de la fonction à appeler.
description	Objet	Obligatoire . La description détaillée de la fonction. Le modèle utilise cette description pour comprendre la pertinence de la fonction par rapport à l'invite et générer les appels d'outils avec une plus grande précision.
parameters	Objet	Les paramètres que la fonction accepte, décrits comme un objet de schéma JSON valide. Si l'outil est appelé, l'appel de l'outil est conforme au schéma JSON fourni. L'omission de paramètres définit une fonction sans aucun paramètre. Le nombre de properties est limité à 15 clés.
strict	Booléen	Faut-il activer l'adhérence stricte au schéma lors de la génération de l'appel de fonction. Si défini sur true, le modèle suit le schéma exact défini dans le champ du schéma. Seul un sous-ensemble du schéma JSON est pris en charge lorsque strict est true

ToolChoiceObject

Consultez Appel de fonction sur Databricks.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de l'outil à forcer. Les valeurs prises en charge correspondent aux types d'outils dans ToolObject: "function", "custom", etc.
function	Objet	Requis lorsque type est "function". Un objet de la forme {"name": "my_function"} où "my_function" est le nom d'un FunctionObject dans le champ tools.
name	Chaîne	Requis lorsque type est "custom". Nom de l'outil personnalisé à forcer. Prise en charge uniquement avec les modèles de la série GPT-5.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de l'outil à forcer. Les valeurs prises en charge correspondent aux types d'outils dans ToolObject: "function", "custom", etc.
function	Objet	Requis lorsque type est "function". Un objet de la forme {"name": "my_function"} où "my_function" est le nom d'un FunctionObject dans le champ tools.
name	Chaîne	Requis lorsque type est "custom". Nom de l'outil personnalisé à forcer. Prise en charge uniquement avec les modèles de la série GPT-5.

Réponse de l'API de réponses

Pour les requêtes non-streaming, la réponse est un objet de réponse unique. Pour les requêtes de streaming, la réponse est un text/event-stream où chaque événement est un segment de réponse.

Champ	Type	Description
id	Chaîne	Identifiant unique pour la réponse. Note : Databricks chiffre cet ID pour des raisons de sécurité.
object	Chaîne	Le type d'objet. Égal à "response".
created_at	Entier	L'Unix Timestamp (en secondes) lorsque la réponse a été créée.
status	Chaîne	Le statut de la réponse. Un de : completed, failed, in_progress, cancelled, queued, ou incomplete.
model	Chaîne	La version du modèle utilisée pour générer la réponse.
output	Liste[ResponsesMessage]	La sortie générée par le modèle, contenant généralement des objets de message.
usage	Utilisation	Métadonnées d'utilisation des jetons.
error	Erreur	informations d'erreur si la réponse a échoué.
incomplete_details	Détails incomplets	Détails expliquant pourquoi la réponse est incomplète, le cas échéant.
instructions	Chaîne	Les instructions fournies dans la requête.
max_output_tokens	Entier	Le nombre maximal de jetons de sortie spécifié dans la requête.
temperature	Présentation libre	La température utilisée pour la génération.
top_p	Présentation libre	La valeur top_p utilisée pour la génération.
tools	Liste[ToolObject]	Les outils spécifiés dans la requête.
tool_choice	Chaîne ou ToolChoiceObject	Le paramètre tool_choice de la requête.
parallel_tool_calls	Booléen	Si les appels d'outils parallèles ont été activés.
store	Booléen	Si la réponse a été stockée.
metadata	Objet	Les métadonnées attachées à la réponse.

Champ	Type	Description
id	Chaîne	Identifiant unique pour la réponse. Note : Databricks chiffre cet ID pour des raisons de sécurité.
object	Chaîne	Le type d'objet. Égal à "response".
created_at	Entier	L'Unix Timestamp (en secondes) lorsque la réponse a été créée.
status	Chaîne	Le statut de la réponse. Un de : completed, failed, in_progress, cancelled, queued, ou incomplete.
model	Chaîne	La version du modèle utilisée pour générer la réponse.
output	Liste[ResponsesMessage]	La sortie générée par le modèle, contenant généralement des objets de message.
usage	Utilisation	Métadonnées d'utilisation des jetons.
error	Erreur	informations d'erreur si la réponse a échoué.
incomplete_details	Détails incomplets	Détails expliquant pourquoi la réponse est incomplète, le cas échéant.
instructions	Chaîne	Les instructions fournies dans la requête.
max_output_tokens	Entier	Le nombre maximal de jetons de sortie spécifié dans la requête.
temperature	Présentation libre	La température utilisée pour la génération.
top_p	Présentation libre	La valeur top_p utilisée pour la génération.
tools	Liste[ToolObject]	Les outils spécifiés dans la requête.
tool_choice	Chaîne ou ToolChoiceObject	Le paramètre tool_choice de la requête.
parallel_tool_calls	Booléen	Si les appels d'outils parallèles ont été activés.
store	Booléen	Si la réponse a été stockée.
metadata	Objet	Les métadonnées attachées à la réponse.

ResponsesMessage

Objets de message dans le champ output contenant le contenu de la réponse du modèle.

Champ	Type	Description
id	Chaîne	Obligatoire . Identifiant unique pour le message.
role	Chaîne	Obligatoire . Le rôle du message. Soit "user", soit "assistant".
content	Liste[ResponsesContentBlock]	Obligatoire . Les blocs de contenu dans le message.
status	Chaîne	Le statut du traitement des messages.
type	Chaîne	Obligatoire . Le type d’objet. Égal à "message".

Champ	Type	Description
id	Chaîne	Obligatoire . Identifiant unique pour le message.
role	Chaîne	Obligatoire . Le rôle du message. Soit "user", soit "assistant".
content	Liste[ResponsesContentBlock]	Obligatoire . Les blocs de contenu dans le message.
status	Chaîne	Le statut du traitement des messages.
type	Chaîne	Obligatoire . Le type d’objet. Égal à "message".

Error

Informations d'erreur lorsqu'une réponse échoue.

Champ	Type	Description
code	Chaîne	Obligatoire . Le code d'erreur.
message	Chaîne	Obligatoire . Un message d'erreur lisible par l'homme.
param	Chaîne	Le parameter qui a causé l’erreur, le cas échéant.
type	Chaîne	Obligatoire . Le type d'erreur.

Champ	Type	Description
code	Chaîne	Obligatoire . Le code d'erreur.
message	Chaîne	Obligatoire . Un message d'erreur lisible par l'homme.
param	Chaîne	Le parameter qui a causé l’erreur, le cas échéant.
type	Chaîne	Obligatoire . Le type d'erreur.

IncompleteDetails

Détails expliquant pourquoi une réponse est incomplète.

Champ	Type	Description
reason	Chaîne	Obligatoire . La raison pour laquelle la réponse est incomplète.

Champ	Type	Description
reason	Chaîne	Obligatoire . La raison pour laquelle la réponse est incomplète.

API Chat Completions

L'API Chat Completions permet des conversations multi-tours avec un modèle. La réponse du modèle fournit le assistant message suivant dans la conversation. Voir POST /serving-endpoints/{name}/invocations pour interroger les parameters d'endpoint.

Demande de chat

Champ	Par défaut	Type	Description
messages		Liste ChatMessage	Obligatoire . Une liste de messages représentant la conversation actuelle.
max_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Le nombre maximum de jetons à générer.
stream	true	Booléen	Stream responses back to a client in order to allow partial results for requests. Si ce parameter est inclus dans la requête, les réponses sont envoyées à l'aide de la norme des événements envoyés par le serveur.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
top_k	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Définit le nombre de k jetons les plus probables à utiliser pour le filtrage top-k. Définissez cette valeur sur 1 pour rendre les sorties déterministes.
stop	[]	Chaîne ou Liste[Chaîne]	Le modèle arrête de générer des jetons supplémentaires lorsque l'une des séquences de stop est rencontrée.
n	1	Entier supérieur à zéro	L'API renvoie n achèvements de chat indépendants lorsque n est spécifié. Recommandé pour les charges de travail qui génèrent plusieurs complétions sur la même entrée pour une efficacité d'inférence et des économies de coûts supplémentaires. Disponible uniquement pour les endpoints de throughput provisionné.
tool_choice	none	Chaîne ou ToolChoiceObject	Utilisé uniquement en conjonction avec le champ tools. tool_choice prend en charge une variété de chaînes de mots-clés, telles que auto, required et none. auto signifie que vous laissez le modèle décider quel outil (le cas échéant) est pertinent à utiliser. Avec auto, si le modèle n'estime qu'aucun des outils dans tools n'est pertinent, il génère un message d'assistant standard au lieu d'un appel d'outil. required signifie que le modèle choisit l'outil le plus pertinent dans tools et doit générer un appel d'outil. none signifie que le modèle ne génère aucun appel d'outil et doit plutôt générer un message d'assistant standard. Pour forcer un appel d'outil avec un outil spécifique défini dans tools, utilisez un ToolChoiceObject. By default, si le champ tools est rempli, tool_choice = "auto". Sinon, le champ tools est par default tool_choice = "none"
tools	null	Objet d'outil	Une liste de tools que le modèle peut appeler. Actuellement, function est le seul type tool pris en charge et un maximum de 32 fonctions sont prises en charge.
response_format	null	ResponseFormatObject	Un objet spécifiant le format que le modèle doit générer en sortie. Les types acceptés sont text, json_schema ou json_object Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées, ce qui garantit que le modèle respecte le schéma JSON que vous avez fourni. La définition à { "type": "json_object" } garantit que les réponses générées par le modèle sont du JSON valide, mais ne garantit pas que les réponses suivent un schéma spécifique.
logprobs	false	Booléen	Ce paramètre indique s'il faut fournir la probabilité logarithmique d'échantillonnage d'un jeton.
top_logprobs	null	Entier	Ce parameter contrôle le nombre de candidats de jetons les plus probables pour lesquels retourner les probabilités logarithmiques à chaque étape d'échantillonnage. Peut être de 0 à 20. logprobs doit être true si vous utilisez ce champ.
reasoning_effort	"medium"	Chaîne	Contrôle le niveau d'effort de raisonnement que le modèle doit appliquer lors de la génération des réponses. Les valeurs acceptées sont "low", "medium" ou "high". Un effort de raisonnement plus élevé peut entraîner des réponses plus réfléchies et précises, mais peut augmenter la latence et l'utilisation des jetons. Ce parameter n'est accepté que par un ensemble limité de modèles, y compris databricks-gpt-oss-120b et databricks-gpt-oss-20b.

Champ	Par défaut	Type	Description
messages		Liste ChatMessage	Obligatoire . Une liste de messages représentant la conversation actuelle.
max_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Le nombre maximum de jetons à générer.
stream	true	Booléen	Stream responses back to a client in order to allow partial results for requests. Si ce parameter est inclus dans la requête, les réponses sont envoyées à l'aide de la norme des événements envoyés par le serveur.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
top_k	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Définit le nombre de k jetons les plus probables à utiliser pour le filtrage top-k. Définissez cette valeur sur 1 pour rendre les sorties déterministes.
stop	[]	Chaîne ou Liste[Chaîne]	Le modèle arrête de générer des jetons supplémentaires lorsque l'une des séquences de stop est rencontrée.
n	1	Entier supérieur à zéro	L'API renvoie n achèvements de chat indépendants lorsque n est spécifié. Recommandé pour les charges de travail qui génèrent plusieurs complétions sur la même entrée pour une efficacité d'inférence et des économies de coûts supplémentaires. Disponible uniquement pour les endpoints de throughput provisionné.
tool_choice	none	Chaîne ou ToolChoiceObject	Utilisé uniquement en conjonction avec le champ tools. tool_choice prend en charge une variété de chaînes de mots-clés, telles que auto, required et none. auto signifie que vous laissez le modèle décider quel outil (le cas échéant) est pertinent à utiliser. Avec auto, si le modèle n'estime qu'aucun des outils dans tools n'est pertinent, il génère un message d'assistant standard au lieu d'un appel d'outil. required signifie que le modèle choisit l'outil le plus pertinent dans tools et doit générer un appel d'outil. none signifie que le modèle ne génère aucun appel d'outil et doit plutôt générer un message d'assistant standard. Pour forcer un appel d'outil avec un outil spécifique défini dans tools, utilisez un ToolChoiceObject. By default, si le champ tools est rempli, tool_choice = "auto". Sinon, le champ tools est par default tool_choice = "none"
tools	null	Objet d'outil	Une liste de tools que le modèle peut appeler. Actuellement, function est le seul type tool pris en charge et un maximum de 32 fonctions sont prises en charge.
response_format	null	ResponseFormatObject	Un objet spécifiant le format que le modèle doit générer en sortie. Les types acceptés sont text, json_schema ou json_object Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées, ce qui garantit que le modèle respecte le schéma JSON que vous avez fourni. La définition à { "type": "json_object" } garantit que les réponses générées par le modèle sont du JSON valide, mais ne garantit pas que les réponses suivent un schéma spécifique.
logprobs	false	Booléen	Ce paramètre indique s'il faut fournir la probabilité logarithmique d'échantillonnage d'un jeton.
top_logprobs	null	Entier	Ce parameter contrôle le nombre de candidats de jetons les plus probables pour lesquels retourner les probabilités logarithmiques à chaque étape d'échantillonnage. Peut être de 0 à 20. logprobs doit être true si vous utilisez ce champ.
reasoning_effort	"medium"	Chaîne	Contrôle le niveau d'effort de raisonnement que le modèle doit appliquer lors de la génération des réponses. Les valeurs acceptées sont "low", "medium" ou "high". Un effort de raisonnement plus élevé peut entraîner des réponses plus réfléchies et précises, mais peut augmenter la latence et l'utilisation des jetons. Ce parameter n'est accepté que par un ensemble limité de modèles, y compris databricks-gpt-oss-120b et databricks-gpt-oss-20b.

ChatMessage

Champ	Type	Description
role	Chaîne	Obligatoire . Le rôle de l'auteur du message. Peut être "system", "user", "assistant" ou "tool".
content	Chaîne ou Liste[ContentItem]	Obligatoire pour les tâches de chat qui n'impliquent pas d'appels d'outils. Le contenu peut être une chaîne de caractères ou un tableau qui contient une série d'éléments multimodaux dans une seule interaction de chat. Ces éléments suivent la séquence dans laquelle ils sont traités comme entrées ou sorties par les modèles. Cette entrée de tableau est spécifiquement conçue pour une utilisation avec des modèles propriétaires accessibles uniquement par l'intermédiaire de fournisseurs de modèles externes. Actuellement, seuls les modèles Claude sont pris en charge. Utilisez du contenu de type chaîne de caractères pour d'autres fournisseurs de modèles externes, des modèles open source (Llama) ou des modèles hébergés par des clients sur Databricks. list[ContentItem] n'est pas compatible avec les spécifications d'OpenAI.
tool_calls	ToolCall liste	La liste de tool_calls que le modèle a générée. Doit avoir role comme "assistant" et aucune spécification pour le champ content.
tool_call_id	Chaîne	Lorsque role est "tool", l'ID associé au ToolCall auquel le message répond. Doit être vide pour les autres options role.

Champ	Type	Description
role	Chaîne	Obligatoire . Le rôle de l'auteur du message. Peut être "system", "user", "assistant" ou "tool".
content	Chaîne ou Liste[ContentItem]	Obligatoire pour les tâches de chat qui n'impliquent pas d'appels d'outils. Le contenu peut être une chaîne de caractères ou un tableau qui contient une série d'éléments multimodaux dans une seule interaction de chat. Ces éléments suivent la séquence dans laquelle ils sont traités comme entrées ou sorties par les modèles. Cette entrée de tableau est spécifiquement conçue pour une utilisation avec des modèles propriétaires accessibles uniquement par l'intermédiaire de fournisseurs de modèles externes. Actuellement, seuls les modèles Claude sont pris en charge. Utilisez du contenu de type chaîne de caractères pour d'autres fournisseurs de modèles externes, des modèles open source (Llama) ou des modèles hébergés par des clients sur Databricks. list[ContentItem] n'est pas compatible avec les spécifications d'OpenAI.
tool_calls	ToolCall liste	La liste de tool_calls que le modèle a générée. Doit avoir role comme "assistant" et aucune spécification pour le champ content.
tool_call_id	Chaîne	Lorsque role est "tool", l'ID associé au ToolCall auquel le message répond. Doit être vide pour les autres options role.

Le rôle system ne peut être utilisé qu’une seule fois, comme premier message dans une conversation. Il ignore l'invite système par default du modèle.

ContentItem

ContentItem est l'un des types de contenu suivants : TextContent, ReasoningContent, DocumentContent ou ImageContent

TextContent

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un texte.
text	Chaîne	Contenu textuel requis.
citations	Liste[Citation]	Informations de citation facultatives. Consultez le tableau ci-dessous.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter n'est accepté que par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un texte.
text	Chaîne	Contenu textuel requis.
citations	Liste[Citation]	Informations de citation facultatives. Consultez le tableau ci-dessous.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter n'est accepté que par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

Les champs de citations sont les suivants :

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être char_location.
cited_text	Chaîne	Le texte extrait du document.
document_index	Entier	L'index du document cité.
document_title	Chaîne	Le titre du document cité.
start_char_index	Entier	L'index de début du texte cité dans le document.
end_char_index	Entier	L'index de fin du texte cité dans le document.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être char_location.
cited_text	Chaîne	Le texte extrait du document.
document_index	Entier	L'index du document cité.
document_title	Chaîne	Le titre du document cité.
start_char_index	Entier	L'index de début du texte cité dans le document.
end_char_index	Entier	L'index de fin du texte cité dans le document.

ImageContent

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) image_url.
image_url	ImageURL	Équivalent à l'objet image_url d'OpenAI.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce paramètre est accepté uniquement par le modèle Claude hébergé par Databricks. Le contenu du message d'image doit utiliser les données encodées comme source. Les URL ne sont actuellement pas prises en charge. Voir Mise en cache des prompts pour un exemple.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) image_url.
image_url	ImageURL	Équivalent à l'objet image_url d'OpenAI.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce paramètre est accepté uniquement par le modèle Claude hébergé par Databricks. Le contenu du message d'image doit utiliser les données encodées comme source. Les URL ne sont actuellement pas prises en charge. Voir Mise en cache des prompts pour un exemple.

Les champs ImageURL sont ci-dessous :

Champ	Type	Description
url	Chaîne	Données d'image encodées en Base64. Doit être une chaîne base64 valide générée à partir d'un format de fichier image pris en charge (JPEG, PNG, GIF, WebP, etc.).
detail	Chaîne	Spécifie le niveau de détail de l'image.

Champ	Type	Description
url	Chaîne	Données d'image encodées en Base64. Doit être une chaîne base64 valide générée à partir d'un format de fichier image pris en charge (JPEG, PNG, GIF, WebP, etc.).
detail	Chaîne	Spécifie le niveau de détail de l'image.

ReasoningContent

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) reasoning.
summary	List[Résumé]	Contenus textuels de raisonnement. Le résumé peut être TextSummary ou EncryptedTextSummary
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter est uniquement accepté par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) reasoning.
summary	List[Résumé]	Contenus textuels de raisonnement. Le résumé peut être TextSummary ou EncryptedTextSummary
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter est uniquement accepté par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

TextSummary

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) summary_text.
text	Chaîne	Un bref résumé du raisonnement utilisé par le modèle lors de la génération de la réponse.
signature	Chaîne	Jetons cryptographiques facultatifs pour vérifier l'authenticité des données.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un(e) summary_text.
text	Chaîne	Un bref résumé du raisonnement utilisé par le modèle lors de la génération de la réponse.
signature	Chaîne	Jetons cryptographiques facultatifs pour vérifier l'authenticité des données.

EncryptedTextSummary

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un summary_encrypted_text.
data	Chaîne	Contenu texte chiffré qui n'est pas lisible par l'homme pour des raisons de sécurité.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un summary_encrypted_text.
data	Chaîne	Contenu texte chiffré qui n'est pas lisible par l'homme pour des raisons de sécurité.

DocumentContent

DocumentContent est uniquement destiné aux requêtes.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être document.
title	Chaîne	Titre du document.
context	Chaîne	Description du document.
source	Source	Obligatoire . Fournit plus d’informations sur le document, y compris son format et son contenu.
citations	Map[string, bool]	Mappage avec un champ unique « enabled » qui correspond à un booléen indiquant s'il faut activer les citations pour le document.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être document.
title	Chaîne	Titre du document.
context	Chaîne	Description du document.
source	Source	Obligatoire . Fournit plus d’informations sur le document, y compris son format et son contenu.
citations	Map[string, bool]	Mappage avec un champ unique « enabled » qui correspond à un booléen indiquant s'il faut activer les citations pour le document.

Source

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être l’un des suivants : base64 (PDF), text, content ou url (URLPDFSource).
media_type	Chaîne	Requis pour le type PDF et texte. - Doit être application ou pdf pour PDF. - Doit être text ou plain pour le texte.
data	Chaîne	Obligatoire pour les PDF et le texte. Les données contenant la source du document.
content	Chaîne ou Liste[Contenu textuel] ou Liste[Contenu d'image]	Obligatoire pour le type content. Le contenu du document.
url	Chaîne	Obligatoire pour le type URLPDFSource. L'URL du document PDF.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être l’un des suivants : base64 (PDF), text, content ou url (URLPDFSource).
media_type	Chaîne	Requis pour le type PDF et texte. - Doit être application ou pdf pour PDF. - Doit être text ou plain pour le texte.
data	Chaîne	Obligatoire pour les PDF et le texte. Les données contenant la source du document.
content	Chaîne ou Liste[Contenu textuel] ou Liste[Contenu d'image]	Obligatoire pour le type content. Le contenu du document.
url	Chaîne	Obligatoire pour le type URLPDFSource. L'URL du document PDF.

FileContent

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un fichier.
file	Fichier	Obligatoire Contenu du fichier.

Champ	Type	Description
type	Chaîne	Obligatoire . Doit être un fichier.
file	Fichier	Obligatoire Contenu du fichier.

Les champs du fichier sont ci-dessous :

Champ	Type	Description
filename	Chaîne	Le nom du fichier.
file_data	Chaîne	Obligatoire . Données de fichier encodées en base64 compatibles avec OpenAI. Cela commence par le format de fichier suivi des données encodées en base64. Par exemple, un fichier PDF a un format en data:application/pdf;base64,<base64 data>.
url	Chaîne	L'URL du fichier accessible publiquement. Pris en charge uniquement pour les modèles Gemini.

Champ	Type	Description
filename	Chaîne	Le nom du fichier.
file_data	Chaîne	Obligatoire . Données de fichier encodées en base64 compatibles avec OpenAI. Cela commence par le format de fichier suivi des données encodées en base64. Par exemple, un fichier PDF a un format en data:application/pdf;base64,<base64 data>.
url	Chaîne	L'URL du fichier accessible publiquement. Pris en charge uniquement pour les modèles Gemini.

ToolCall

Une suggestion d'action d'appel d'outil par le modèle. Voir l'appel de fonction sur Databricks.

Champ	Type	Description
id	Chaîne	Obligatoire . Un identifiant unique pour cette suggestion d'appel d'outil.
type	Chaîne	Obligatoire . Seul "function" est pris en charge.
function	Achèvement de l'appel de fonction	Obligatoire . Un appel de fonction suggéré par le modèle.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter n'est accepté que par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

Champ	Type	Description
id	Chaîne	Obligatoire . Un identifiant unique pour cette suggestion d'appel d'outil.
type	Chaîne	Obligatoire . Seul "function" est pris en charge.
function	Achèvement de l'appel de fonction	Obligatoire . Un appel de fonction suggéré par le modèle.
cache_control	Chaîne	Active la mise en cache de votre requête. Ce parameter n'est accepté que par les modèles Claude hébergés par Databricks. Pour un exemple, consultez Mise en cache des prompts.

FunctionCallCompletion

Champ	Type	Description
name	Chaîne	Obligatoire. Le nom de la fonction recommandée par le modèle.
arguments	Objet	Obligatoire. Arguments de la fonction sous forme de dictionnaire JSON sérialisé.

Champ	Type	Description
name	Chaîne	Obligatoire. Le nom de la fonction recommandée par le modèle.
arguments	Objet	Obligatoire. Arguments de la fonction sous forme de dictionnaire JSON sérialisé.

**Remarque**ToolChoiceObject ToolObject:, et FunctionObject sont définis dans la section APIs Réponses et sont partagés entre les deux API.

ResponseFormatObject

Consultez les sorties structurées sur Databricks.

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de format de réponse en cours de définition. Soit text pour du texte non structuré, json_object pour des objets JSON non structurés, ou json_schema pour des objets JSON respectant un schéma spécifique.
json_schema	JsonSchemaObject	Obligatoire . Le schéma JSON à respecter si type est défini sur json_schema

Champ	Type	Description
type	Chaîne	Obligatoire . Le type de format de réponse en cours de définition. Soit text pour du texte non structuré, json_object pour des objets JSON non structurés, ou json_schema pour des objets JSON respectant un schéma spécifique.
json_schema	JsonSchemaObject	Obligatoire . Le schéma JSON à respecter si type est défini sur json_schema

JsonSchemaObject

Consultez les sorties structurées sur Databricks.

Champ	Type	Description
name	Chaîne	Obligatoire . Le nom du format de réponse.
description	Chaîne	Une description de l'objectif du format de réponse, utilisée par le modèle pour déterminer comment répondre dans ce format.
schema	Objet	Obligatoire . Le schéma du format de réponse, décrit comme un objet de schéma JSON.
strict	Booléen	S'il faut activer une adhésion stricte au schéma lors de la génération de la sortie. Si défini sur true, le modèle suit le schéma exact défini dans le champ du schéma. Seul un sous-ensemble du schéma JSON est pris en charge lorsque strict est true

Champ	Type	Description
name	Chaîne	Obligatoire . Le nom du format de réponse.
description	Chaîne	Une description de l'objectif du format de réponse, utilisée par le modèle pour déterminer comment répondre dans ce format.
schema	Objet	Obligatoire . Le schéma du format de réponse, décrit comme un objet de schéma JSON.
strict	Booléen	S'il faut activer une adhésion stricte au schéma lors de la génération de la sortie. Si défini sur true, le modèle suit le schéma exact défini dans le champ du schéma. Seul un sous-ensemble du schéma JSON est pris en charge lorsque strict est true

Réponse du chat

Pour les requêtes non-streaming, la réponse est un seul objet d'achèvement du chat. Pour les requêtes de streaming, la réponse est un text/event-stream où chaque événement est un objet de bloc de complétion. La structure de niveau supérieur des objets de complétion et de segment est presque identique : seul choices a un type différent.

Champ	Type	Description
id	Chaîne	Identifiant unique pour l'achèvement du chat.
choices	List[ChatCompletionChoice] ou List[ChatCompletionChunk] (streaming)	Liste des textes d'achèvement de chat. n choix sont renvoyés si le paramètre n est spécifié.
object	Chaîne	Le type d'objet. Égal à "chat.completions" pour le non-streaming ou à "chat.completion.chunk" pour le streaming.
created	Entier	L'heure à laquelle l'achèvement du chat a été généré en secondes.
model	Chaîne	La version du modèle utilisée pour générer la réponse.
usage	Utilisation	Métadonnées d'utilisation des jetons. Peut ne pas être présent sur les réponses de streaming.

Champ	Type	Description
id	Chaîne	Identifiant unique pour l'achèvement du chat.
choices	List[ChatCompletionChoice] ou List[ChatCompletionChunk] (streaming)	Liste des textes d'achèvement de chat. n choix sont renvoyés si le paramètre n est spécifié.
object	Chaîne	Le type d'objet. Égal à "chat.completions" pour le non-streaming ou à "chat.completion.chunk" pour le streaming.
created	Entier	L'heure à laquelle l'achèvement du chat a été généré en secondes.
model	Chaîne	La version du modèle utilisée pour générer la réponse.
usage	Utilisation	Métadonnées d'utilisation des jetons. Peut ne pas être présent sur les réponses de streaming.

ChatCompletionChoice

Champ	Type	Description
index	Entier	L'index du choix dans la liste des choix générés.
message	Message de chat	Un message de complétion de chat renvoyé par le modèle. Le rôle sera assistant.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons.
extra_fields	Chaîne	Lors de l'utilisation de modèles propriétaires provenant de fournisseurs de modèles externes, les APIs du fournisseur peuvent inclure des métadonnées supplémentaires dans les réponses. Databricks filtre ces réponses et ne renvoie qu'un sous-ensemble des champs d'origine du fournisseur. Le safetyRating est le seul champ supplémentaire pris en charge actuellement, consultez la documentation Gemini pour plus de détails.

Champ	Type	Description
index	Entier	L'index du choix dans la liste des choix générés.
message	Message de chat	Un message de complétion de chat renvoyé par le modèle. Le rôle sera assistant.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons.
extra_fields	Chaîne	Lors de l'utilisation de modèles propriétaires provenant de fournisseurs de modèles externes, les APIs du fournisseur peuvent inclure des métadonnées supplémentaires dans les réponses. Databricks filtre ces réponses et ne renvoie qu'un sous-ensemble des champs d'origine du fournisseur. Le safetyRating est le seul champ supplémentaire pris en charge actuellement, consultez la documentation Gemini pour plus de détails.

ChatCompletionChunk

Champ	Type	Description
index	Entier	L'index du choix dans la liste des choix générés.
delta	Message de chat	Une partie du message de complétion de chat des réponses générées en Stream par le modèle. Seul le premier segment est garanti d'avoir role renseigné.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons. Seul le dernier segment sera renseigné.

Champ	Type	Description
index	Entier	L'index du choix dans la liste des choix générés.
delta	Message de chat	Une partie du message de complétion de chat des réponses générées en Stream par le modèle. Seul le premier segment est garanti d'avoir role renseigné.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons. Seul le dernier segment sera renseigné.

API Embeddings

Les tâches d'intégration mappent les chaînes d'entrée en vecteurs d'intégration. De nombreuses entrées peuvent être regroupées par batch dans chaque requête. Voir POST /serving-endpoints/{name}/invocations pour interroger les paramètres d'endpoint.

Demande d'intégration

Champ	Type	Description
input	Chaîne ou Liste[Chaîne]	Obligatoire . Le texte d'entrée à intégrer. Peut être une chaîne ou une liste de chaînes.
instruction	Chaîne	Une instruction facultative à transmettre au modèle d'intégration.
dimensions	Entier	Facultatif. Le nombre de dimensions que les intégrations de sortie résultantes devraient avoir. Doit être une puissance de 2 allant de 32 à 1024. Pris en charge uniquement pour databricks-qwen3-embedding-0-6b.

Champ	Type	Description
input	Chaîne ou Liste[Chaîne]	Obligatoire . Le texte d'entrée à intégrer. Peut être une chaîne ou une liste de chaînes.
instruction	Chaîne	Une instruction facultative à transmettre au modèle d'intégration.
dimensions	Entier	Facultatif. Le nombre de dimensions que les intégrations de sortie résultantes devraient avoir. Doit être une puissance de 2 allant de 32 à 1024. Pris en charge uniquement pour databricks-qwen3-embedding-0-6b.

Les instructions sont facultatives et très spécifiques au modèle. Par exemple, les auteurs BGE recommandent de n'utiliser aucune instruction lors de l'indexation de fragments et recommandent d'utiliser l'instruction "Represent this sentence for searching relevant passages:" pour les queries de récupération. Les auteurs de Qwen3-Embedding recommandent une instruction spécifique à la tâche telle que "Given a web search query, retrieve relevant passages that answer the query" pour les queries de récupération, et aucune instruction lors de l'intégration de documents de récupération. D'autres modèles, comme Instructor-XL, prennent en charge un large éventail de chaînes d'instructions.

Réponse des intégrations

Champ	Type	Description
id	Chaîne	Identifiant unique pour l'intégration.
object	Chaîne	Le type d'objet. Égal à "list".
model	Chaîne	Le nom du modèle d'intégration utilisé pour créer l'intégration.
data	EmbeddingObject	L'objet d'intégration.
usage	Utilisation	Métadonnées d'utilisation des jetons.

Champ	Type	Description
id	Chaîne	Identifiant unique pour l'intégration.
object	Chaîne	Le type d'objet. Égal à "list".
model	Chaîne	Le nom du modèle d'intégration utilisé pour créer l'intégration.
data	EmbeddingObject	L'objet d'intégration.
usage	Utilisation	Métadonnées d'utilisation des jetons.

EmbeddingObject

Champ	Type	Description
object	Chaîne	Le type d'objet. Égal à "embedding".
index	Entier	L'index de l'embedding dans la liste des embeddings générés par le modèle.
embedding	Liste[Flottant]	Le vecteur d'intégration. Chaque modèle renverra un vecteur de taille fixe (1024 pour BGE-Large).

Champ	Type	Description
object	Chaîne	Le type d'objet. Égal à "embedding".
index	Entier	L'index de l'embedding dans la liste des embeddings générés par le modèle.
embedding	Liste[Flottant]	Le vecteur d'intégration. Chaque modèle renverra un vecteur de taille fixe (1024 pour BGE-Large).

API de complétions

Les tâches d'achèvement de texte servent à générer des réponses à une seule invite. Contrairement au Chat, cette tâche prend en charge les entrées groupées : plusieurs invites indépendantes peuvent être envoyées en une seule requête. Voir POST /serving-endpoints/{name}/invocations pour interroger les paramètres d'endpoint.

Demande de complétion

Champ	Par défaut	Type	Description
prompt		Chaîne ou Liste[Chaîne]	Obligatoire . Les prompts pour le modèle.
max_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Le nombre maximum de jetons à générer.
stream	true	Booléen	Stream responses back to a client in order to allow partial results for requests. Si ce parameter est inclus dans la requête, les réponses sont envoyées à l'aide de la norme des événements envoyés par le serveur.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
top_k	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Définit le nombre de k jetons les plus probables à utiliser pour le filtrage top-k. Définissez cette valeur sur 1 pour rendre les sorties déterministes.
error_behavior	"error"	"truncate" OU "error"	Pour les erreurs de délai d'attente et de dépassement de la longueur du contexte. L'un des éléments suivants : "truncate" (retourner autant de jetons que possible) et "error" (retourner une erreur). Ce paramètre n'est accepté que par les endpoints de paiement par jeton.
n	1	Entier supérieur à zéro	L'API renvoie n achèvements de chat indépendants lorsque n est spécifié. Recommandé pour les charges de travail qui génèrent plusieurs complétions sur la même entrée pour une efficacité d'inférence et des économies de coûts supplémentaires. Disponible uniquement pour les endpoints de throughput provisionné.
stop	[]	Chaîne ou Liste[Chaîne]	Le modèle arrête de générer des jetons supplémentaires lorsque l'une des séquences de stop est rencontrée.
suffix	""	Chaîne	Une chaîne qui est ajoutée à la fin de chaque achèvement.
echo	false	Booléen	Renvoie l'invite ainsi que la complétion.
use_raw_prompt	true pour le throughput provisionné, false pour le paiement au jeton	Booléen	Si true, passez prompt directement dans le modèle sans aucune Transformation. default à true sur les throughput Endpoints provisionné et false sur les throughput Endpoints de paiement au jeton.

Champ	Par défaut	Type	Description
prompt		Chaîne ou Liste[Chaîne]	Obligatoire . Les prompts pour le modèle.
max_tokens	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Le nombre maximum de jetons à générer.
stream	true	Booléen	Stream responses back to a client in order to allow partial results for requests. Si ce parameter est inclus dans la requête, les réponses sont envoyées à l'aide de la norme des événements envoyés par le serveur.
temperature	1.0	Présentation libre dans [0,2]	La température d'échantillonnage. 0 est déterministe et des valeurs plus élevées introduisent plus de caractère aléatoire.
top_p	1.0	Valeur flottante dans (0,1]	Le threshold de probabilité utilisé pour l'échantillonnage de noyau.
top_k	null	null, ce qui signifie aucune limite, ou un entier supérieur à zéro	Définit le nombre de k jetons les plus probables à utiliser pour le filtrage top-k. Définissez cette valeur sur 1 pour rendre les sorties déterministes.
error_behavior	"error"	"truncate" OU "error"	Pour les erreurs de délai d'attente et de dépassement de la longueur du contexte. L'un des éléments suivants : "truncate" (retourner autant de jetons que possible) et "error" (retourner une erreur). Ce paramètre n'est accepté que par les endpoints de paiement par jeton.
n	1	Entier supérieur à zéro	L'API renvoie n achèvements de chat indépendants lorsque n est spécifié. Recommandé pour les charges de travail qui génèrent plusieurs complétions sur la même entrée pour une efficacité d'inférence et des économies de coûts supplémentaires. Disponible uniquement pour les endpoints de throughput provisionné.
stop	[]	Chaîne ou Liste[Chaîne]	Le modèle arrête de générer des jetons supplémentaires lorsque l'une des séquences de stop est rencontrée.
suffix	""	Chaîne	Une chaîne qui est ajoutée à la fin de chaque achèvement.
echo	false	Booléen	Renvoie l'invite ainsi que la complétion.
use_raw_prompt	true pour le throughput provisionné, false pour le paiement au jeton	Booléen	Si true, passez prompt directement dans le modèle sans aucune Transformation. default à true sur les throughput Endpoints provisionné et false sur les throughput Endpoints de paiement au jeton.

Réponse de complétion

Champ	Type	Description
id	Chaîne	Identifiant unique pour la complétion de texte.
choices	CompletionChoice	Une liste de complétions de texte. Pour chaque invite transmise, n choix sont générés si n est spécifié. Default n est 1.
object	Chaîne	Le type d'objet. égal à "text_completion"
created	Entier	Le temps pendant lequel la complétion a été générée en secondes.
usage	Utilisation	Métadonnées d'utilisation des jetons.

Champ	Type	Description
id	Chaîne	Identifiant unique pour la complétion de texte.
choices	CompletionChoice	Une liste de complétions de texte. Pour chaque invite transmise, n choix sont générés si n est spécifié. Default n est 1.
object	Chaîne	Le type d'objet. égal à "text_completion"
created	Entier	Le temps pendant lequel la complétion a été générée en secondes.
usage	Utilisation	Métadonnées d'utilisation des jetons.

CompletionChoice

Champ	Type	Description
index	Entier	L’index du prompt dans la requête.
text	Chaîne	La complétion générée.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons.

Champ	Type	Description
index	Entier	L’index du prompt dans la requête.
text	Chaîne	La complétion générée.
finish_reason	Chaîne	La raison pour laquelle le modèle a cessé de générer des jetons.

Ressources supplémentaires

• Databricks Foundation Model APIs

• Utiliser les modèles de fondation

• Modèles de fondation hébergés par Databricks disponibles dans les API de modèles de fondation