@azure/ai-agents package

Classes

AgentsClient
ToolSet	Représente un ensemble d’outils avec leurs définitions et ressources.
ToolUtility	Classe utilitaire pour la création de différents outils.

Interfaces

AISearchIndexResource	Une ressource d’index de recherche IA.
Agent	Représente un agent qui peut appeler le modèle et utiliser des outils.
AgentDeletionStatus	État d’une opération de suppression d’agent.
AgentErrorDetail	Décrit les informations d’erreur renvoyées par l’API des agents.
AgentEventMessage	Chaque événement d’un flux d’événements envoyés par le serveur a une propriété event et data : * * Exemple événement : thread.created data : {"id » : « thread_123 », « object » : « thread », ...} Nous émettons des événements chaque fois qu’un nouvel objet est créé, passe à un nouvel état ou est en cours diffusées en parties (deltas). Par exemple, nous émettons thread.run.created lors d’une nouvelle exécution est créé, thread.run.completed lorsqu’une exécution est terminée, et ainsi de suite. Lorsqu’un agent choisit pour créer un message pendant une exécution, nous émettons un thread.message.created event, un thread.message.in_progress événement, de nombreux événements thread.message.delta, et enfin un thread.message.completed événement. Nous pouvons ajouter des événements supplémentaires au fil du temps. Nous vous recommandons donc de gérer correctement les événements inconnus dans votre code.
AgentEventMessageStream	Représente un flux de message d’événement de l’agent.
AgentThread	Informations sur un thread unique associé à un agent.
AgentThreadCreationOptions	Détails utilisés pour créer un thread d’agent.
AgentV1Error	Charge utile d’erreur renvoyée par l’API des agents.
AgentsClientOptionalParams	Paramètres facultatifs pour le client.
AgentsNamedToolChoice	Spécifie un outil que le modèle doit utiliser. Utilisez-le pour forcer le modèle à appeler un outil spécifique.
AgentsResponseFormat	Un objet décrivant la sortie attendue du modèle. Si json_object, seul les types de functiontools sont autorisés à être passés à l’exécution. Si text, le modèle peut retourner du texte ou n’importe quelle valeur nécessaire.
AzureAISearchToolDefinition	Informations de définition d’entrée pour un outil de recherche Azure AI utilisé pour configurer un agent.
AzureAISearchToolResource	Ensemble de ressources d’index utilisées par l’outil azure_ai_search.
AzureFunctionBinding	Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.
AzureFunctionDefinition	Définition de la fonction Azure.
AzureFunctionStorageQueue	Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.
AzureFunctionToolDefinition	Informations de définition d’entrée pour un outil de fonction Azure, comme utilisé pour configurer un agent.
BingGroundingSearchConfiguration	Configuration de recherche pour Bing Grounding
BingGroundingSearchToolParameters	Paramètres de l’outil de recherche de mise à la terre Bing.
BingGroundingToolDefinition	Informations de définition d’entrée pour un outil de recherche bing grounding tel qu’utilisé pour configurer un agent.
CodeInterpreterToolDefinition	Informations de définition d’entrée pour un outil d’interpréteur de code tel qu’utilisé pour configurer un agent.
CodeInterpreterToolResource	Ensemble de ressources utilisées par l’outil code_interpreter.
ConnectedAgentDetails	Informations permettant de connecter un agent à un autre en tant qu’outil
ConnectedAgentToolDefinition	Informations de définition d’entrée pour un outil d’agent connecté qui définit un sous-agent spécifique à un domaine
CreateAgentOptionalParams	Paramètres facultatifs.
CreateThreadAndRunOptionalParams	Paramètres facultatifs.
DeleteAgentOptionalParams	Paramètres facultatifs.
FileDeletionStatus	Réponse d’état d’une opération de suppression de fichier.
FileInfo	Représente un agent qui peut appeler le modèle et utiliser des outils.
FileListResponse	Données de réponse d’une opération de liste de fichiers.
FileSearchRankingOptions	Options de classement pour la recherche de fichiers.
FileSearchToolCallContent	Objet de contenu de résultat de la recherche de fichiers.
FileSearchToolDefinition	Informations de définition d’entrée pour un outil de recherche de fichiers tel qu’il est utilisé pour configurer un agent.
FileSearchToolDefinitionDetails	Les options remplacent l’outil de recherche de fichiers.
FileSearchToolResource	Ensemble de ressources utilisées par l’outil file_search.
FilesDeleteFileOptionalParams	Paramètres facultatifs.
FilesGetFileContentOptionalParams	Paramètres facultatifs.
FilesGetFileOptionalParams	Paramètres facultatifs.
FilesListFilesOptionalParams	Paramètres facultatifs.
FilesOperations	Interface représentant une opération Files.
FilesUploadFileOptionalParams	Paramètres facultatifs.
FunctionDefinition	Informations de définition d’entrée pour une fonction.
FunctionName	Nom de la fonction qui sera utilisé, si vous utilisez l’outil function
FunctionToolDefinition	Informations de définition d’entrée d’un outil de fonction comme utilisé pour configurer un agent.
GetAgentOptionalParams	Paramètres facultatifs.
IncompleteRunDetails	Détails sur la raison pour laquelle l’exécution est incomplète. Sera null si l’exécution n’est pas incomplète.
ListAgentsOptionalParams	Paramètres facultatifs.
MessageAttachment	Cela décrit les outils auxquels un fichier a été attaché.
MessageContent	Représentation abstraite d’un élément unique de contenu de message de thread.
MessageDelta	Représente la charge utile « delta » typée dans un bloc delta de message de diffusion en continu.
MessageDeltaChunk	Représente un delta de message, c’est-à-dire les champs modifiés d’un message pendant la diffusion en continu.
MessageDeltaContent	Représentation de base abstraite d’une charge utile de contenu de message diffusée en continu partielle.
MessageDeltaImageFileContent	Représente une partie de contenu de fichier image diffusée dans un segment delta de message de diffusion en continu.
MessageDeltaImageFileContentObject	Représente la charge utile « image_file » dans le contenu du fichier image de streaming.
MessageDeltaTextAnnotation	Représentation de base abstraite de l’annotation de texte d’un composant de contenu de texte en continu.
MessageDeltaTextContent	Représente une partie de contenu texte en continu dans un segment delta de message de diffusion en continu.
MessageDeltaTextContentObject	Représente les données d’une partie de contenu texte diffusée dans un segment delta de message de diffusion en continu.
MessageDeltaTextFileCitationAnnotation	Représente une citation de fichier en continu appliquée à une partie de contenu texte de diffusion en continu.
MessageDeltaTextFileCitationAnnotationObject	Représente les données d’une citation de fichier en continu telle qu’appliquée à une partie de contenu texte de diffusion en continu.
MessageDeltaTextFilePathAnnotation	Représente une annotation de chemin d’accès de fichier en continu appliquée à une partie de contenu de texte de diffusion en continu.
MessageDeltaTextFilePathAnnotationObject	Représente les données d’une annotation de chemin d’accès de fichier en continu telle qu’elle est appliquée à une partie de contenu de texte de diffusion en continu.
MessageDeltaTextUrlCitationAnnotation	Une citation dans le message qui pointe vers une URL spécifique associée au message. Généré lorsque l’agent utilise des outils tels que « bing_grounding » pour effectuer des recherches sur Internet.
MessageDeltaTextUrlCitationDetails	Représentation d’une citation d’URL, telle qu’elle est utilisée dans le contenu d’un message de fil de discussion.
MessageImageFileContent	Représentation du contenu du fichier image dans un message de thread.
MessageImageFileDetails	Référence d’image, telle qu’elle est représentée dans le contenu du message de thread.
MessageImageFileParam	Définit la façon dont un fichier image téléchargé en interne est référencé lors de la création d’un bloc de fichier image.
MessageImageUrlParam	Définit la façon dont l’URL d’une image externe est référencée lors de la création d’un bloc d’URL d’image.
MessageIncompleteDetails	Informations fournissant des détails supplémentaires sur un message entrant un état incomplet.
MessageInputContentBlock	Définit un bloc de contenu unique lors de la création d’un message. Le champ « type » détermine s’il s’agit d’un texte, d’un fichier image ou d’une URL d’image externe, etc.
MessageInputImageFileBlock	Un bloc image-file dans un nouveau message, référençant une image téléchargée en interne par ID de fichier.
MessageInputImageUrlBlock	Un bloc image-URL dans un nouveau message, référençant une image externe par URL.
MessageInputTextBlock	Bloc de texte d’un nouveau message, contenant du contenu en texte brut.
MessageTextAnnotation	Représentation abstraite d’une annotation au contenu du message de thread de texte.
MessageTextContent	Représentation d’un élément textuel de contenu de message de thread.
MessageTextDetails	Texte et annotations associées pour un seul élément de contenu de message de thread d’agent.
MessageTextFileCitationAnnotation	Citation dans le message qui pointe vers une citation spécifique d’un fichier spécifique associé à l’agent ou au message. Généré lorsque l’agent utilise l’outil « file_search » pour rechercher des fichiers.
MessageTextFileCitationDetails	Représentation d’une citation de texte basée sur un fichier, telle qu’utilisée dans une annotation basée sur un fichier de contenu de message de thread de texte.
MessageTextFilePathAnnotation	Citation dans le message qui pointe vers un fichier situé à un chemin d’accès spécifique.
MessageTextFilePathDetails	Encapsulation d’un ID de fichier image, tel qu’utilisé par le contenu de l’image de message.
MessageTextUrlCitationAnnotation	Une citation dans le message qui pointe vers une URL spécifique associée au message. Généré lorsque l’agent utilise des outils tels que « bing_grounding » pour effectuer des recherches sur Internet.
MessageTextUrlCitationDetails	Représentation d’une citation d’URL, telle qu’elle est utilisée dans le contenu d’un message de fil de discussion.
MessagesCreateMessageOptionalParams	Paramètres facultatifs.
MessagesGetMessageOptionalParams	Paramètres facultatifs.
MessagesListMessagesOptionalParams	Paramètres facultatifs.
MessagesOperations	Interface représentant une opération Messages.
MessagesUpdateMessageOptionalParams	Paramètres facultatifs.
OpenApiAnonymousAuthDetails	Détails de sécurité pour l’authentification anonyme OpenApi
OpenApiAuthDetails	détails d’authentification pour OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Détails de sécurité pour l’authentification de connexion OpenApi
OpenApiConnectionSecurityScheme	Schéma de sécurité pour l’authentification openApi managed_identity
OpenApiFunctionDefinition	Informations de définition d’entrée pour une fonction openapi.
OpenApiManagedAuthDetails	Détails de sécurité pour l’authentification openApi managed_identity
OpenApiManagedSecurityScheme	Schéma de sécurité pour l’authentification openApi managed_identity
OpenApiToolDefinition	Informations de définition d’entrée pour un outil OpenAPI tel qu’utilisé pour configurer un agent.
PageSettings	Options de la méthode byPage
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
PollingOptions	Options de configuration du comportement d’interrogation.
PollingOptionsParams	Paramètres facultatifs configurant le comportement d’interrogation.
RequiredAction	Représentation abstraite d’une action requise pour qu’un thread d’agent s’exécute pour continuer.
RequiredFunctionToolCall	Représentation d’un appel demandé à un outil de fonction, nécessaire par le modèle pour poursuivre l’évaluation d’une exécution.
RequiredFunctionToolCallDetails	Informations détaillées pour un appel de fonction, comme fourni par une action requise appelant un outil de fonction, qui inclut le nom et les arguments de la fonction.
RequiredToolCall	Représentation abstraite d’un appel d’outil nécessaire par le modèle pour poursuivre une exécution.
ResponseFormatJsonSchema	Une description de à quoi sert le format de réponse, utilisée par le modèle pour déterminer comment répondre dans ce format.
ResponseFormatJsonSchemaType	Type de format de réponse défini : json_schema
RunCompletionUsage	Statistiques d’utilisation relatives à l’exécution. Cette valeur est null si l’exécution n’est pas dans un état terminal (c’est-à-dire in_progress, queued, etc.).
RunError	Détails d’une erreur rencontrée par l’exécution d’un thread d’agent.
RunStep	Informations détaillées sur une seule étape de l’exécution d’un thread d’agent.
RunStepAzureAISearchToolCall	Enregistrement d’un appel à un outil Recherche d’IA Azure, émis par le modèle lors de l’évaluation d’un outil défini, qui représente la recherche Azure AI exécutée.
RunStepBingGroundingToolCall	Enregistrement d’un appel à un outil bing grounding, émis par le modèle lors de l’évaluation d’un outil défini, qui représente la recherche exécutée avec la mise au point bing.
RunStepCodeInterpreterImageOutput	Représentation d’une sortie d’image émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
RunStepCodeInterpreterImageReference	Référence d’image émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
RunStepCodeInterpreterLogOutput	Représentation d’une sortie de journal émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
RunStepCodeInterpreterToolCall	Enregistrement d’un appel à un outil d’interpréteur de code, émis par le modèle lors de l’évaluation d’un outil défini, qui représente les entrées et sorties consommées et émises par l’interpréteur de code.
RunStepCodeInterpreterToolCallDetails	Informations détaillées sur un appel d’interpréteur de code par le modèle.
RunStepCodeInterpreterToolCallOutput	Représentation abstraite d’une sortie émise à partir d’un outil d’interpréteur de code.
RunStepCompletionUsage	Statistiques d’utilisation relatives à l’étape d’exécution.
RunStepDelta	Représente la charge utile delta dans un segment delta d’exécution de streaming.
RunStepDeltaChunk	Représente le delta d’une étape d’exécution, c’est-à-dire les champs modifiés d’une étape d’exécution pendant la diffusion en continu.
RunStepDeltaCodeInterpreterDetailItemObject	Représente les données d’appel de l’outil Interpréteur de code dans les appels d’outils de l’étape d’exécution de streaming.
RunStepDeltaCodeInterpreterImageOutput	Représente une sortie d’image telle que produite par l’outil interpréteur de code et représentée dans la collection d’appels de l’outil delta de l’étape d’exécution de streaming.
RunStepDeltaCodeInterpreterImageOutputObject	Représente les données de la sortie de l’image de l’outil Interpréteur de code d’une étape de diffusion en continu.
RunStepDeltaCodeInterpreterLogOutput	Représente une sortie de journal générée par l’outil Interpréteur de code et représentée dans la collection d’appels de l’outil delta de l’étape d’exécution de streaming.
RunStepDeltaCodeInterpreterOutput	Représentation abstraite de base d’une sortie de l’outil d’interpréteur de code d’un outil d’exécution de streaming.
RunStepDeltaCodeInterpreterToolCall	Représente un appel d’outil Interpréteur de code dans les détails de l’appel d’outil de l’étape d’exécution de streaming.
RunStepDeltaDetail	Représente un élément détaillé d’étape d’exécution unique dans la charge utile delta d’une étape d’exécution de streaming.
RunStepDeltaFileSearchToolCall	Représente un appel d’outil de recherche de fichiers dans les détails de l’appel d’outil de l’étape d’exécution de streaming.
RunStepDeltaFunction	Représente les données de fonction dans un appel d’outil de fonction de l’étape de diffusion en continu.
RunStepDeltaFunctionToolCall	Représente un appel d’outil de fonction dans les détails de l’appel d’outil d’une étape d’exécution de streaming.
RunStepDeltaMessageCreation	Représente une création de message au sein d’un delta d’étape d’exécution de streaming.
RunStepDeltaMessageCreationObject	Représente les données d’un objet de réponse de création de message d’étape de diffusion en continu.
RunStepDeltaToolCall	Représentation abstraite d’un appel d’outil unique dans les détails de l’appel de l’outil delta d’une étape d’exécution de streaming.
RunStepDeltaToolCallObject	Représente un appel d’appels d’outils dans le cadre d’une étape d’exécution de streaming.
RunStepDetails	Représentation abstraite des détails d’une étape d’exécution.
RunStepError	Informations d’erreur associées à une étape d’exécution ayant échoué.
RunStepFileSearchToolCall	Enregistrement d’un appel à un outil de recherche de fichiers, émis par le modèle lors de l’évaluation d’un outil défini, qui représente la recherche de fichiers exécutée.
RunStepFileSearchToolCallResult	Résultat de l’appel de l’outil de recherche de fichiers.
RunStepFileSearchToolCallResults	Résultats de la recherche de fichiers.
RunStepFunctionToolCall	Enregistrement d’un appel à un outil de fonction, émis par le modèle lors de l’évaluation d’un outil défini, qui représente les entrées et sortie consommées et émises par la fonction spécifiée.
RunStepFunctionToolCallDetails	Informations détaillées sur la fonction appelée par le modèle.
RunStepMessageCreationDetails	Informations détaillées associées à une étape d’exécution de création de message.
RunStepMessageCreationReference	Détails d’un message créé dans le cadre d’une étape d’exécution.
RunStepOpenAPIToolCall	Enregistrement d’un appel à un outil OpenAPI, émis par le modèle en évaluation d’un outil défini, qui représente les opérations OpenAPI exécutées.
RunStepToolCall	Représentation abstraite d’un appel d’outil détaillé tel qu’enregistré dans une étape d’exécution pour une exécution existante.
RunStepToolCallDetails	Informations détaillées associées à des outils d’appel d’étape d’exécution.
RunStepsGetRunStepOptionalParams	Paramètres facultatifs.
RunStepsListRunStepsOptionalParams	Paramètres facultatifs.
RunStepsOperations	Interface représentant une opération RunSteps.
RunsCancelRunOptionalParams	Paramètres facultatifs.
RunsCreateRunOptionalParams	Paramètres facultatifs.
RunsGetRunOptionalParams	Paramètres facultatifs.
RunsListRunsOptionalParams	Paramètres facultatifs.
RunsOperations	Interface représentant une opération Exécutes.
RunsSubmitToolOutputsToRunOptionalParams	Paramètres facultatifs.
RunsUpdateRunOptionalParams	Paramètres facultatifs.
SubmitToolOutputsAction	Détails des appels d’outil requis qui doivent être envoyés pour qu’un thread d’agent s’exécute pour continuer.
SubmitToolOutputsDetails	Détails décrivant les outils qui doivent être appelés pour envoyer des sorties d’outil.
ThreadDeletionStatus	État d’une opération de suppression de thread.
ThreadMessage	Message unique existant au sein d’un thread d’agent.
ThreadMessageOptions	Message unique au sein d’un thread d’agent, tel que fourni pendant la création de ce thread pour son état initial.
ThreadRun	Données représentant une seule exécution d’évaluation d’un thread d’agent.
ThreadsCreateThreadOptionalParams	Paramètres facultatifs.
ThreadsDeleteThreadOptionalParams	Paramètres facultatifs.
ThreadsGetThreadOptionalParams	Paramètres facultatifs.
ThreadsListThreadsOptionalParams	Paramètres facultatifs.
ThreadsOperations	Interface représentant une opération Threads.
ThreadsUpdateThreadOptionalParams	Paramètres facultatifs.
ToolDefinition	Représentation abstraite d’une définition d’outil d’entrée qu’un agent peut utiliser.
ToolOutput	Les données fournies lors d’une soumission d’outil génère une soumission pour résoudre les appels d’outils en attente et permettre au modèle de continuer.
ToolResources	Ensemble de ressources utilisées par les outils de l’agent. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’ID de fichiers, tandis que l’outil file_search nécessite une liste d’ID de magasins de vecteurs.
TruncationObject	Contrôle la façon dont un thread sera tronqué avant l’exécution. Utilisez cette option pour contrôler la fenêtre de contexte initial de l’exécution.
UpdateAgentOptionalParams	Paramètres facultatifs.
VectorStore	Un magasin de vecteurs est une collection de fichiers traités qui peuvent être utilisés par l’outil file_search.
VectorStoreAutoChunkingStrategyRequest	Stratégie par défaut. Cette stratégie utilise actuellement une max_chunk_size_tokens de 800 et chunk_overlap_tokens de 400.
VectorStoreAutoChunkingStrategyResponse	Cet élément est retourné quand la stratégie de segmentation est inconnue. En règle générale, cela est dû au fait que le fichier a été indexé avant que le concept de chunking_strategy ait été introduit dans l’API.
VectorStoreChunkingStrategyRequest	Représentation abstraite d’une configuration de stratégie de segmentation de magasin de vecteurs.
VectorStoreChunkingStrategyResponse	Représentation abstraite d’une configuration de stratégie de segmentation de magasin de vecteurs.
VectorStoreConfiguration	La configuration du stockage vectoriel est la liste des sources de données utilisées lorsque plusieurs fichiers peuvent être utilisés pour la recherche de fichiers d’entreprise.
VectorStoreConfigurations	Structure contenant la liste des configurations de stockage vectoriel, c’est-à-dire la liste des ID de ressources Azure.
VectorStoreDataSource	Structure, contenant le chemin de l’URI de ressource Azure et le type de ressource du fichier utilisé comme source de données pour la recherche de fichiers d’entreprise.
VectorStoreDeletionStatus	Objet response pour la suppression d’un magasin vectoriel.
VectorStoreExpirationPolicy	La stratégie d’expiration d’un magasin de vecteurs.
VectorStoreFile	Description d’un fichier attaché à un magasin de vecteurs.
VectorStoreFileBatch	Un lot de fichiers attaché à un magasin de vecteurs.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Paramètres facultatifs.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Paramètres facultatifs.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Paramètres facultatifs.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Paramètres facultatifs.
VectorStoreFileBatchesOperations	Interface représentant une opération VectorStoreFileBatches.
VectorStoreFileCount	Nombres de fichiers traités ou traités par ce magasin vectoriel regroupés par état.
VectorStoreFileDeletionStatus	Objet de réponse pour la suppression d’une relation de fichier de magasin de vecteurs.
VectorStoreFileError	Détails sur l’erreur qui peut s’être produite lors du traitement d’un fichier pour ce magasin vectoriel
VectorStoreFilesCreateVectorStoreFileOptionalParams	Paramètres facultatifs.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Paramètres facultatifs.
VectorStoreFilesGetVectorStoreFileOptionalParams	Paramètres facultatifs.
VectorStoreFilesListVectorStoreFilesOptionalParams	Paramètres facultatifs.
VectorStoreFilesOperations	Interface représentant une opération VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Options de configuration d’une stratégie de segmentation statique de magasin de vecteurs.
VectorStoreStaticChunkingStrategyRequest	Stratégie de segmentation configurée statiquement.
VectorStoreStaticChunkingStrategyResponse	Stratégie de segmentation configurée statiquement.
VectorStoresCreateVectorStoreOptionalParams	Paramètres facultatifs.
VectorStoresDeleteVectorStoreOptionalParams	Paramètres facultatifs.
VectorStoresGetVectorStoreOptionalParams	Paramètres facultatifs.
VectorStoresListVectorStoresOptionalParams	Paramètres facultatifs.
VectorStoresModifyVectorStoreOptionalParams	Paramètres facultatifs.
VectorStoresOperations	Interface représentant une opération VectorStores.

Alias de type

AgentEventStreamData	Représente des données d’événement de flux dans l’agent.
AgentRunResponse	L’agent exécute la réponse avec prise en charge du flux.
AgentStreamEvent	Alias de AgentStreamEvent
AgentsNamedToolChoiceType	Types d’outils disponibles pour les agents nommés tools.
AgentsResponseFormatMode	Représente le mode dans lequel le modèle gérera le format de retour d’un appel d’outil.
AgentsResponseFormatOption	Alias pour AgentsResponseFormatOption
AgentsToolChoiceOption	Alias pour AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Spécifie comment le choix de l’outil sera utilisé
AzureAISearchQueryType	Types de requêtes disponibles pour l’outil de recherche Azure AI.
ContinuablePage	Interface qui décrit une page de résultats.
FileContents	Valeurs valides pour le contenu d’un fichier binaire.
FilePurpose	Valeurs possibles indiquant l’utilisation prévue d’un fichier.
FileState	État du fichier.
ImageDetailLevel	Spécifie le niveau de détail d’une image. Il peut s’agir de « auto », « low », « high » ou d’une valeur future inconnue.
IncompleteDetailsReason	La raison pour laquelle l’exécution est incomplète. Cela pointe vers quelle limite de jeton spécifique a été atteinte au cours de l’exécution.
ListSortOrder	Les options de tri disponibles lors de la demande d’une liste d’objets de réponse.
MessageAttachmentToolDefinition	Alias pour MessageAttachmentToolDefinition
MessageBlockType	Spécifie le type de bloc de contenu dans un message. Il peut s’agir de texte, d’un fichier image, d’une URL d’image externe ou d’un type futur inconnu.
MessageContentUnion	Alias de MessageContentUnion
MessageDeltaContentUnion	Alias de MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias de MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Ensemble de raisons expliquant pourquoi un message est marqué comme incomplet.
MessageInputContent	Alias de MessageInputContent
MessageInputContentBlockUnion	Alias de MessageInputContentBlockUnion
MessageRole	Valeurs possibles pour les rôles attribués aux messages dans un fil de discussion.
MessageStatus	Valeurs d’état d’exécution possibles pour un message de thread.
MessageTextAnnotationUnion	Alias de MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias de OpenApiAuthDetailsUnion
OpenApiAuthType	Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont les suivants : Anonyme (aucune authentification requise) Connexion (nécessite connection_id pour le point de terminaison, tel que configuré dans AI Foundry) Managed_Identity (nécessite un public pour l’authentification basée sur l’identité)
RequiredActionUnion	Alias de RequiredActionUnion
RequiredToolCallUnion	Alias de RequiredToolCallUnion
ResponseFormat	Formats de réponse API possibles.
RunAdditionalFieldList	Liste des champs supplémentaires à inclure dans la réponse.
RunStatus	Valeurs possibles pour l’état de l’exécution d’un thread d’agent.
RunStepCodeInterpreterToolCallOutputUnion	Alias de RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias de RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias de RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias de RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias de RunStepDetailsUnion
RunStepErrorCode	Valeurs de code d’erreur possibles attribuables à l’échec d’une étape d’exécution.
RunStepStatus	Valeurs possibles pour l’état d’une étape d’exécution.
RunStepToolCallUnion	Alias de RunStepToolCallUnion
RunStepType	Types d’étapes d’exécution possibles.
ToolDefinitionUnion	Alias de ToolDefinitionUnion
TruncationStrategy	Stratégies de troncature possibles pour le fil.
VectorStoreChunkingStrategyRequestType	Type de stratégie de chunking
VectorStoreChunkingStrategyRequestUnion	Alias de VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Type de stratégie de chunking
VectorStoreChunkingStrategyResponseUnion	Alias de VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Décrit la relation entre les jours et l’expiration de ce magasin de vecteurs
VectorStoreFileBatchStatus	État du lot de fichiers de stockage vectoriel.
VectorStoreFileErrorCode	Variantes de code d’erreur pour le traitement des fichiers de stockage vectoriel
VectorStoreFileStatus	État du fichier de stockage vectoriel
VectorStoreFileStatusFilter	Filtre de paramètres de requête pour le point de terminaison de récupération de fichiers de stockage vectoriel
VectorStoreStatus	Statut possible du magasin de vecteurs

Énumérations

DoneEvent	Événement terminal indiquant la fin réussie d’un flux.
ErrorEvent	Événement terminal indiquant une erreur côté serveur lors de la diffusion en continu.
KnownVersions	Versions de l’API des agents Azure AI
MessageStreamEvent	Événements de streaming liés à l’opération de message
RunStepStreamEvent	Exécuter des événements de streaming liés à l’opération d’étape
RunStreamEvent	Exécuter des événements de streaming liés à l’opération
ThreadStreamEvent	Événements de streaming liés à l’opération de thread
VectorStoreDataSourceAssetType	Type de ressource de stockage vectoriel. Le type d’actif peut être un uri_asset, dans ce cas, il doit contenir l’ID d’URI de l’actif, dans le cas de id_asset il doit contenir l’ID de données.
connectionToolType	Types d’outils de connexion utilisés pour configurer un agent

Functions

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Détermine si la sortie donnée est du type spécifié.

Informations relatives à la fonction

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Détermine si la sortie donnée est du type spécifié.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Paramètres

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Action à vérifier, qui peut être de type RequiredAction, RequiredToolCallou ToolDefinitionUnion.

type

string

Type auquel vérifier l’action.

Retours

output

Valeur booléenne indiquant si l’action est du type spécifié.