ChatCompletionSkill interface

Pacchetto:

@azure/search-documents

Una competenza che chiama un modello linguistico tramite l'endpoint di completamento chat di Azure AI Foundry.

Extends

WebApiSkill

Proprietà

apiKey	Chiave API per l'autenticazione al modello. Non è possibile specificare contemporaneamente apiKey e authIdentity.
commonModelParameters	Parametri del modello di linguaggio comune che i clienti possono modificare. Se omesso, verranno applicate impostazioni predefinite ragionevoli.
extraParameters	Dizionario di tipo aperto per i parametri specifici del modello che devono essere aggiunti alla chiamata di completamento della chat. Segue il modello di estendibilità di Azure AI Foundry.
extraParametersBehavior	Modalità di gestione dei parametri aggiuntivi da Azure AI Foundry. Il valore predefinito è 'error'.
odatatype	Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere
responseFormat	Determina il modo in cui l'LLM deve formattare la sua risposta. Il valore predefinito è il tipo di risposta "testo".

Proprietà ereditate

authIdentity	Identità gestita assegnata dall'utente utilizzata per le connessioni in uscita. Se viene fornito un authResourceId che non viene specificato, viene usata l'identità gestita assegnata dal sistema. Quando si aggiorna l'indicizzatore, se l'identità non è specificata, il valore rimane invariato. Se impostato su "none", il valore di questa proprietà viene cancellato.
authResourceId	Si applica alle competenze personalizzate che si connettono al codice esterno in una funzione di Azure o in un'altra applicazione che fornisce le trasformazioni. Questo valore deve essere l'ID applicazione creato per la funzione o l'app quando è stata registrata con Azure Active Directory. Se specificata, la competenza personalizzata si connette alla funzione o all'app usando un ID gestito (assegnato dal sistema o dall'utente) del servizio di ricerca e il token di accesso della funzione o dell'app, usando questo valore come ID risorsa per la creazione dell'ambito del token di accesso.
batchSize	La dimensione del batch desiderata che indica il numero di documenti.
context	Rappresenta il livello in cui vengono eseguite le operazioni, ad esempio la radice del documento o il contenuto del documento (ad esempio, /document o /document/content). Il valore predefinito è /document.
degreeOfParallelism	Se impostato, il numero di chiamate parallele che possono essere effettuate all'API Web.
description	La descrizione dell'abilità che descrive gli input, gli output e l'utilizzo dell'abilità.
httpHeaders	Le intestazioni necessarie per effettuare la richiesta http.
httpMethod	Il metodo per la richiesta http.
inputs	Gli input delle competenze possono essere una colonna nel set di dati di origine o l'output di una competenza a monte.
name	Il nome della competenza che la identifica in modo univoco all'interno del set di competenze. A un'abilità senza nome definito verrà assegnato un nome predefinito del suo indice in base 1 nell'array di abilità, preceduto dal carattere '#'.
outputs	L'output di una competenza è un campo in un indice di ricerca o un valore che può essere utilizzato come input da un'altra competenza.
timeout	Il timeout desiderato per la richiesta. Il valore predefinito è 30 secondi.
uri	URL per l'API Web.

Dettagli proprietà

apiKey

Chiave API per l'autenticazione al modello. Non è possibile specificare contemporaneamente apiKey e authIdentity.

apiKey?: string

Valore della proprietà

string

commonModelParameters

Parametri del modello di linguaggio comune che i clienti possono modificare. Se omesso, verranno applicate impostazioni predefinite ragionevoli.

commonModelParameters?: CommonModelParameters

Valore della proprietà

CommonModelParameters

extraParameters

Dizionario di tipo aperto per i parametri specifici del modello che devono essere aggiunti alla chiamata di completamento della chat. Segue il modello di estendibilità di Azure AI Foundry.

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

Valore della proprietà

{[propertyName: string]: unknown}

extraParametersBehavior

Modalità di gestione dei parametri aggiuntivi da Azure AI Foundry. Il valore predefinito è 'error'.

extraParametersBehavior?: string

Valore della proprietà

string

odatatype

Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere

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

Valore della proprietà

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Determina il modo in cui l'LLM deve formattare la sua risposta. Il valore predefinito è il tipo di risposta "testo".

responseFormat?: ChatCompletionResponseFormat

Valore della proprietà

ChatCompletionResponseFormat

Dettagli proprietà ereditate

authIdentity

Identità gestita assegnata dall'utente utilizzata per le connessioni in uscita. Se viene fornito un authResourceId che non viene specificato, viene usata l'identità gestita assegnata dal sistema. Quando si aggiorna l'indicizzatore, se l'identità non è specificata, il valore rimane invariato. Se impostato su "none", il valore di questa proprietà viene cancellato.

authIdentity?: SearchIndexerDataIdentity

Valore della proprietà

SearchIndexerDataIdentity

Ereditato daWebApiSkill.authIdentity

authResourceId

Si applica alle competenze personalizzate che si connettono al codice esterno in una funzione di Azure o in un'altra applicazione che fornisce le trasformazioni. Questo valore deve essere l'ID applicazione creato per la funzione o l'app quando è stata registrata con Azure Active Directory. Se specificata, la competenza personalizzata si connette alla funzione o all'app usando un ID gestito (assegnato dal sistema o dall'utente) del servizio di ricerca e il token di accesso della funzione o dell'app, usando questo valore come ID risorsa per la creazione dell'ambito del token di accesso.

authResourceId?: string

Valore della proprietà

string

Ereditato daWebApiSkill.authResourceId

batchSize

La dimensione del batch desiderata che indica il numero di documenti.

batchSize?: number

Valore della proprietà

number

Ereditato daWebApiSkill.batchSize

context

Rappresenta il livello in cui vengono eseguite le operazioni, ad esempio la radice del documento o il contenuto del documento (ad esempio, /document o /document/content). Il valore predefinito è /document.

context?: string

Valore della proprietà

string

Ereditato daWebApiSkill.context

degreeOfParallelism

Se impostato, il numero di chiamate parallele che possono essere effettuate all'API Web.

degreeOfParallelism?: number

Valore della proprietà

number

Ereditato daWebApiSkill.degreeOfParallelism

description

La descrizione dell'abilità che descrive gli input, gli output e l'utilizzo dell'abilità.

description?: string

Valore della proprietà

string

Ereditato daWebApiSkill.description

httpHeaders

Le intestazioni necessarie per effettuare la richiesta http.

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

Valore della proprietà

{[propertyName: string]: string}

Ereditato daWebApiSkill.httpHeaders

httpMethod

Il metodo per la richiesta http.

httpMethod?: string

Valore della proprietà

string

Ereditato daWebApiSkill.httpMethod

inputs

Gli input delle competenze possono essere una colonna nel set di dati di origine o l'output di una competenza a monte.

inputs: InputFieldMappingEntry[]

Valore della proprietà

InputFieldMappingEntry[]

Ereditato daWebApiSkill.inputs

name

Il nome della competenza che la identifica in modo univoco all'interno del set di competenze. A un'abilità senza nome definito verrà assegnato un nome predefinito del suo indice in base 1 nell'array di abilità, preceduto dal carattere '#'.

name?: string

Valore della proprietà

string

ereditato daWebApiSkill.name

outputs

L'output di una competenza è un campo in un indice di ricerca o un valore che può essere utilizzato come input da un'altra competenza.

outputs: OutputFieldMappingEntry[]

Valore della proprietà

OutputFieldMappingEntry[]

Ereditato daWebApiSkill.outputs

timeout

Il timeout desiderato per la richiesta. Il valore predefinito è 30 secondi.

timeout?: string

Valore della proprietà

string

Ereditato daWebApiSkill.timeout

uri

URL per l'API Web.

uri: string

Valore della proprietà

string

Ereditato daWebApiSkill.uri