RunsCreateRunOptionalParams interface

Paquet:

@azure/ai-agents

Paramètres facultatifs.

Extends

OperationOptions,PollingOptionsParams

Propriétés

additionalInstructions	Instructions supplémentaires à ajouter à la fin des instructions pour l’exécution. Cela est utile pour modifier le comportement lors de chaque exécution sans remplacer d’autres instructions.
additionalMessages	Ajoute des messages supplémentaires au thread avant de créer l’exécution.
include	Liste des champs supplémentaires à inclure dans la réponse. Actuellement, la seule valeur prise en charge est step_details.tool_calls[*].file_search.results[*].content, qui permet d'extraire le contenu du résultat de la recherche de fichiers.
instructions	Instructions système substituées que l’agent doit utiliser pour exécuter le thread.
maxCompletionTokens	Le nombre maximal de jetons de saisie semi-automatique qui peuvent être utilisés au cours de l’exécution. L’exécution fera le meilleur effort pour utiliser uniquement le nombre de jetons d’achèvement spécifié, à travers plusieurs tours de l’exécution. Si l’exécution dépasse le nombre de jetons d’achèvement spécifié, l’exécution se termine avec l’état incomplete. Pour plus d'informations, consultez incomplete_details.
maxPromptTokens	Le nombre maximal de jetons de prompt qui peuvent être utilisés au cours de l’exécution. L’exécution fera le meilleur effort pour utiliser uniquement le nombre de jetons de prompt spécifié, à travers plusieurs tours de l’exécution. Si l’exécution dépasse le nombre de jetons de prompt spécifié, l’exécution se termine avec l’état incomplete. Pour plus d'informations, consultez incomplete_details.
metadata	Ensemble de 16 paires clé/valeur pouvant être attachées à un objet, utilisées pour stocker des informations supplémentaires sur cet objet dans un format structuré. Les clés peuvent comporter jusqu’à 64 caractères et les valeurs peuvent atteindre jusqu’à 512 caractères.
model	Nom de modèle substitué que l’agent doit utiliser pour exécuter le thread.
parallelToolCalls	Si true fonctions s’exécutent en parallèle pendant l’utilisation de l’outil.
responseFormat	Spécifie le format de sortie du modèle.
stream	Si true, retourne un flux d’événements qui se produisent lors de l’exécution en tant qu’événements envoyés par le serveur et s’arrête lorsque l’exécution entre dans un état terminal avec un message data: [DONE].
temperature	Température d’échantillonnage à utiliser, entre 0 et 2. Des valeurs plus élevées telles que 0,8 rendent la sortie plus aléatoire, tandis que des valeurs inférieures telles que 0,2 la rendent plus ciblée et déterministe.
toolChoice	Contrôle si l’outil est appelé ou non par le modèle.
toolResources	Ressources d’outil activées remplacées que l’agent doit utiliser pour exécuter le thread.
tools	Liste substituée des outils activés que l’agent doit utiliser pour exécuter le thread.
topP	Alternative à l’échantillonnage avec la température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec la masse de probabilité top_p. Par conséquent, 0,1 signifie que seuls les jetons comprenant la masse de probabilité supérieure de 10 % sont considérés. Nous vous recommandons généralement de modifier this ou température, mais pas les deux.
truncationStrategy	Stratégie à utiliser pour supprimer des messages à mesure que les fenêtres de contexte avancent.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
pollingOptions	Options de configuration du comportement d’interrogation.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

additionalInstructions

Instructions supplémentaires à ajouter à la fin des instructions pour l’exécution. Cela est utile pour modifier le comportement lors de chaque exécution sans remplacer d’autres instructions.

additionalInstructions?: null | string

Valeur de propriété

null | string

additionalMessages

Ajoute des messages supplémentaires au thread avant de créer l’exécution.

additionalMessages?: null | ThreadMessageOptions[]

Valeur de propriété

null | ThreadMessageOptions[]

include

Liste des champs supplémentaires à inclure dans la réponse. Actuellement, la seule valeur prise en charge est step_details.tool_calls[*].file_search.results[*].content, qui permet d'extraire le contenu du résultat de la recherche de fichiers.

include?: "step_details.tool_calls[*].file_search.results[*].content"[]

Valeur de propriété

"step_details.tool_calls[].file_search.results[].content"[]

instructions

Instructions système substituées que l’agent doit utiliser pour exécuter le thread.

instructions?: null | string

Valeur de propriété

null | string

maxCompletionTokens

Le nombre maximal de jetons de saisie semi-automatique qui peuvent être utilisés au cours de l’exécution. L’exécution fera le meilleur effort pour utiliser uniquement le nombre de jetons d’achèvement spécifié, à travers plusieurs tours de l’exécution. Si l’exécution dépasse le nombre de jetons d’achèvement spécifié, l’exécution se termine avec l’état incomplete. Pour plus d'informations, consultez incomplete_details.

maxCompletionTokens?: null | number

Valeur de propriété

null | number

maxPromptTokens

Le nombre maximal de jetons de prompt qui peuvent être utilisés au cours de l’exécution. L’exécution fera le meilleur effort pour utiliser uniquement le nombre de jetons de prompt spécifié, à travers plusieurs tours de l’exécution. Si l’exécution dépasse le nombre de jetons de prompt spécifié, l’exécution se termine avec l’état incomplete. Pour plus d'informations, consultez incomplete_details.

maxPromptTokens?: null | number

Valeur de propriété

null | number

metadata

Ensemble de 16 paires clé/valeur pouvant être attachées à un objet, utilisées pour stocker des informations supplémentaires sur cet objet dans un format structuré. Les clés peuvent comporter jusqu’à 64 caractères et les valeurs peuvent atteindre jusqu’à 512 caractères.

metadata?: null | Record<string, string>

Valeur de propriété

null | Record<string, string>

model

Nom de modèle substitué que l’agent doit utiliser pour exécuter le thread.

model?: null | string

Valeur de propriété

null | string

parallelToolCalls

Si true fonctions s’exécutent en parallèle pendant l’utilisation de l’outil.

parallelToolCalls?: boolean

Valeur de propriété

boolean

responseFormat

Spécifie le format de sortie du modèle.

responseFormat?: null | AgentsResponseFormatOption

Valeur de propriété

null | AgentsResponseFormatOption

stream

Si true, retourne un flux d’événements qui se produisent lors de l’exécution en tant qu’événements envoyés par le serveur et s’arrête lorsque l’exécution entre dans un état terminal avec un message data: [DONE].

stream?: boolean

Valeur de propriété

boolean

temperature

Température d’échantillonnage à utiliser, entre 0 et 2. Des valeurs plus élevées telles que 0,8 rendent la sortie plus aléatoire, tandis que des valeurs inférieures telles que 0,2 la rendent plus ciblée et déterministe.

temperature?: null | number

Valeur de propriété

null | number

toolChoice

Contrôle si l’outil est appelé ou non par le modèle.

toolChoice?: null | AgentsToolChoiceOption

Valeur de propriété

null | AgentsToolChoiceOption

toolResources

Ressources d’outil activées remplacées que l’agent doit utiliser pour exécuter le thread.

toolResources?: null | ToolResources

Valeur de propriété

null | ToolResources

tools

Liste substituée des outils activés que l’agent doit utiliser pour exécuter le thread.

tools?: null | ToolDefinitionUnion[]

Valeur de propriété

null | ToolDefinitionUnion[]

topP

Alternative à l’échantillonnage avec la température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec la masse de probabilité top_p. Par conséquent, 0,1 signifie que seuls les jetons comprenant la masse de probabilité supérieure de 10 % sont considérés.

Nous vous recommandons généralement de modifier this ou température, mais pas les deux.

topP?: null | number

Valeur de propriété

null | number

truncationStrategy

Stratégie à utiliser pour supprimer des messages à mesure que les fenêtres de contexte avancent.

truncationStrategy?: null | TruncationObject

Valeur de propriété

null | TruncationObject

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

héritée de OperationOptions.onResponse

pollingOptions

Options de configuration du comportement d’interrogation.

pollingOptions?: PollingOptions

Valeur de propriété

PollingOptions

héritée dePollingOptionsParams.pollingOptions

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

héritée de OperationOptions.requestOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée de OperationOptions.tracingOptions