ChatCompletionSkill interface

Paquet:

@azure/search-documents

Compétence qui appelle un modèle de langage via le point de terminaison Complétion de conversation d’Azure AI Foundry.

Extends

WebApiSkill

Propriétés

apiKey	Clé API pour l’authentification au modèle. apiKey et authIdentity ne peuvent pas être spécifiés en même temps.
commonModelParameters	Paramètres de modèle de langage commun que les clients peuvent modifier. S’ils sont omis, des valeurs par défaut raisonnables seront appliquées.
extraParameters	Dictionnaire de type ouvert pour les paramètres spécifiques au modèle qui doivent être ajoutés à l’appel de complétion de conversation. Suit le modèle d’extensibilité d’Azure AI Foundry.
extraParametersBehavior	Comment les paramètres supplémentaires sont gérés par Azure AI Foundry. La valeur par défaut est 'error'.
odatatype	Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être
responseFormat	Détermine comment le LLM doit formater sa réponse. Par défaut, le type de réponse « texte ».

Propriétés héritées

authIdentity	Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si un authResourceId est fourni et qu’il n’est pas spécifié, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’indexeur, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si la valeur est « none », la valeur de cette propriété est effacée.
authResourceId	S’applique aux compétences personnalisées qui se connectent à du code externe dans une fonction Azure ou une autre application qui fournit les transformations. Cette valeur doit être l’ID d’application créé pour la fonction ou l’application lors de son inscription auprès d’Azure Active Directory. Lorsqu’elle est spécifiée, la compétence personnalisée se connecte à la fonction ou à l’application à l’aide d’un ID managé (attribué par le système ou par l’utilisateur) du service de recherche et du jeton d’accès de la fonction ou de l’application, en utilisant cette valeur comme ID de ressource pour la création de l’étendue du jeton d’accès.
batchSize	La taille de lot souhaitée qui indique le nombre de documents.
context	Représente le niveau auquel les opérations ont lieu, tel que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.
degreeOfParallelism	S’il est défini, le nombre d’appels parallèles qui peuvent être effectués vers l’API Web.
description	Description de la compétence, qui décrit les entrées, les sorties et l’utilisation de la compétence.
httpHeaders	Les en-têtes nécessaires pour effectuer la requête http.
httpMethod	Méthode de la requête http.
inputs	Les entrées des compétences peuvent être une colonne dans l’ensemble de données source ou la sortie d’une compétence en amont.
name	Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini se verra attribuer un nom par défaut de son index de base 1 dans le tableau des compétences, préfixé par le caractère « # ».
outputs	La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée en tant qu’entrée par une autre compétence.
timeout	Délai d’expiration souhaité pour la demande. La valeur par défaut est de 30 secondes.
uri	L’URL de l’API Web.

Détails de la propriété

apiKey

Clé API pour l’authentification au modèle. apiKey et authIdentity ne peuvent pas être spécifiés en même temps.

apiKey?: string

Valeur de propriété

string

commonModelParameters

Paramètres de modèle de langage commun que les clients peuvent modifier. S’ils sont omis, des valeurs par défaut raisonnables seront appliquées.

commonModelParameters?: CommonModelParameters

Valeur de propriété

CommonModelParameters

extraParameters

Dictionnaire de type ouvert pour les paramètres spécifiques au modèle qui doivent être ajoutés à l’appel de complétion de conversation. Suit le modèle d’extensibilité d’Azure AI Foundry.

extraParameters?: {[propertyName: string]: unknown}

Valeur de propriété

{[propertyName: string]: unknown}

extraParametersBehavior

Comment les paramètres supplémentaires sont gérés par Azure AI Foundry. La valeur par défaut est 'error'.

extraParametersBehavior?: string

Valeur de propriété

string

odatatype

Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être

odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill"

Valeur de propriété

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Détermine comment le LLM doit formater sa réponse. Par défaut, le type de réponse « texte ».

responseFormat?: ChatCompletionResponseFormat

Valeur de propriété

ChatCompletionResponseFormat

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

authIdentity

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si un authResourceId est fourni et qu’il n’est pas spécifié, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’indexeur, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si la valeur est « none », la valeur de cette propriété est effacée.

authIdentity?: SearchIndexerDataIdentity

Valeur de propriété

SearchIndexerDataIdentity

Hérité deWebApiSkill.authIdentity

authResourceId

S’applique aux compétences personnalisées qui se connectent à du code externe dans une fonction Azure ou une autre application qui fournit les transformations. Cette valeur doit être l’ID d’application créé pour la fonction ou l’application lors de son inscription auprès d’Azure Active Directory. Lorsqu’elle est spécifiée, la compétence personnalisée se connecte à la fonction ou à l’application à l’aide d’un ID managé (attribué par le système ou par l’utilisateur) du service de recherche et du jeton d’accès de la fonction ou de l’application, en utilisant cette valeur comme ID de ressource pour la création de l’étendue du jeton d’accès.

authResourceId?: string

Valeur de propriété

string

Hérité deWebApiSkill.authResourceId

batchSize

La taille de lot souhaitée qui indique le nombre de documents.

batchSize?: number

Valeur de propriété

number

Hérité deWebApiSkill.batchSize

context

Représente le niveau auquel les opérations ont lieu, tel que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.

context?: string

Valeur de propriété

string

Hérité deWebApiSkill.context

degreeOfParallelism

S’il est défini, le nombre d’appels parallèles qui peuvent être effectués vers l’API Web.

degreeOfParallelism?: number

Valeur de propriété

number

Hérité deWebApiSkill.degreeOfParallelism

description

Description de la compétence, qui décrit les entrées, les sorties et l’utilisation de la compétence.

description?: string

Valeur de propriété

string

Hérité deWebApiSkill.description

httpHeaders

Les en-têtes nécessaires pour effectuer la requête http.

httpHeaders?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

Hérité deWebApiSkill.httpHeaders

httpMethod

Méthode de la requête http.

httpMethod?: string

Valeur de propriété

string

Hérité deWebApiSkill.httpMethod

inputs

Les entrées des compétences peuvent être une colonne dans l’ensemble de données source ou la sortie d’une compétence en amont.

inputs: InputFieldMappingEntry[]

Valeur de propriété

InputFieldMappingEntry[]

Hérité deWebApiSkill.inputs

name

Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini se verra attribuer un nom par défaut de son index de base 1 dans le tableau des compétences, préfixé par le caractère « # ».

name?: string

Valeur de propriété

string

Hérité deWebApiSkill.name

outputs

La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée en tant qu’entrée par une autre compétence.

outputs: OutputFieldMappingEntry[]

Valeur de propriété

OutputFieldMappingEntry[]

Hérité deWebApiSkill.outputs

timeout

Délai d’expiration souhaité pour la demande. La valeur par défaut est de 30 secondes.

timeout?: string

Valeur de propriété

string

Hérité deWebApiSkill.timeout

uri

L’URL de l’API Web.

uri: string

Valeur de propriété

string

Hérité deWebApiSkill.uri