ChatCompletionSkill interface

Paket:

@azure/search-documents

En färdighet som anropar en språkmodell via Azure AI Foundrys slutpunkt för chattslutföranden.

Extends

WebApiSkill

Egenskaper

apiKey	API-nyckel för autentisering till modellen. Det går inte att ange både apiKey och authIdentity samtidigt.
commonModelParameters	Parametrar för gemensamma språkmodeller som kunderna kan justera. Om det utelämnas kommer rimliga standardvärden att tillämpas.
extraParameters	Ordlista av öppen typ för modellspecifika parametrar som ska läggas till i chattens slutförandeanrop. Följer Azure AI Foundrys utökningsmönster.
extraParametersBehavior	Hur extra parametrar hanteras av Azure AI Foundry. Standardvärdet är "fel".
odatatype	Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara
responseFormat	Bestämmer hur LLM ska formatera sitt svar. Standardvärdet är svarstypen "text".

Ärvda egenskaper

authIdentity	Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId anges och det inte anges används den system tilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om värdet är "none" rensas värdet för den här egenskapen.
authResourceId	Gäller för anpassade kunskaper som ansluter till extern kod i en Azure-funktion eller något annat program som tillhandahåller transformeringarna. Det här värdet ska vara det program-ID som skapades för funktionen eller appen när den registrerades med Azure Active Directory. När det anges ansluter den anpassade färdigheten till funktionen eller appen med hjälp av ett hanterat ID (antingen system eller användartilldelat) för söktjänsten och åtkomsttoken för funktionen eller appen, med hjälp av det här värdet som resurs-ID för att skapa omfånget för åtkomsttoken.
batchSize	Önskad batchstorlek, som anger antalet dokument.
context	Representerar den nivå på vilken åtgärder utförs, till exempel dokumentets rot eller dokumentinnehåll (till exempel /document eller /document/content). Standardvärdet är /document.
degreeOfParallelism	Om detta anges antalet parallella anrop som kan göras till webb-API:et.
description	Beskrivningen av färdigheten som beskriver indata, utdata och användning av färdigheten.
httpHeaders	De rubriker som krävs för att göra http-begäran.
httpMethod	Metoden för http-begäran.
inputs	Indata för färdigheterna kan vara en kolumn i källdatauppsättningen eller utdata från en överordnad färdighet.
name	Namnet på färdigheten som unikt identifierar den i kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för dess 1-baserade index i kompetensmatrisen, med prefixet "#".
outputs	Utdata från en färdighet är antingen ett fält i ett sökindex eller ett värde som kan användas som indata av en annan färdighet.
timeout	Önskad tidsgräns för begäran. Standardvärdet är 30 sekunder.
uri	URL:en för webb-API:et.

Egenskapsinformation

apiKey

API-nyckel för autentisering till modellen. Det går inte att ange både apiKey och authIdentity samtidigt.

apiKey?: string

Egenskapsvärde

string

commonModelParameters

Parametrar för gemensamma språkmodeller som kunderna kan justera. Om det utelämnas kommer rimliga standardvärden att tillämpas.

commonModelParameters?: CommonModelParameters

Egenskapsvärde

CommonModelParameters

extraParameters

Ordlista av öppen typ för modellspecifika parametrar som ska läggas till i chattens slutförandeanrop. Följer Azure AI Foundrys utökningsmönster.

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

Egenskapsvärde

{[propertyName: string]: unknown}

extraParametersBehavior

Hur extra parametrar hanteras av Azure AI Foundry. Standardvärdet är "fel".

extraParametersBehavior?: string

Egenskapsvärde

string

odatatype

Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara

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

Egenskapsvärde

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Bestämmer hur LLM ska formatera sitt svar. Standardvärdet är svarstypen "text".

responseFormat?: ChatCompletionResponseFormat

Egenskapsvärde

ChatCompletionResponseFormat

Information om ärvda egenskaper

authIdentity

Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId anges och det inte anges används den system tilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om värdet är "none" rensas värdet för den här egenskapen.

authIdentity?: SearchIndexerDataIdentity

Egenskapsvärde

SearchIndexerDataIdentity

Ärvd frånWebApiSkill.authIdentity

authResourceId

Gäller för anpassade kunskaper som ansluter till extern kod i en Azure-funktion eller något annat program som tillhandahåller transformeringarna. Det här värdet ska vara det program-ID som skapades för funktionen eller appen när den registrerades med Azure Active Directory. När det anges ansluter den anpassade färdigheten till funktionen eller appen med hjälp av ett hanterat ID (antingen system eller användartilldelat) för söktjänsten och åtkomsttoken för funktionen eller appen, med hjälp av det här värdet som resurs-ID för att skapa omfånget för åtkomsttoken.

authResourceId?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.authResourceId

batchSize

Önskad batchstorlek, som anger antalet dokument.

batchSize?: number

Egenskapsvärde

number

Ärvd frånWebApiSkill.batchSize

context

Representerar den nivå på vilken åtgärder utförs, till exempel dokumentets rot eller dokumentinnehåll (till exempel /document eller /document/content). Standardvärdet är /document.

context?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.context

degreeOfParallelism

Om detta anges antalet parallella anrop som kan göras till webb-API:et.

degreeOfParallelism?: number

Egenskapsvärde

number

Ärvt frånWebApiSkill.degreeOfParallelism

description

Beskrivningen av färdigheten som beskriver indata, utdata och användning av färdigheten.

description?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.description

httpHeaders

De rubriker som krävs för att göra http-begäran.

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

Egenskapsvärde

{[propertyName: string]: string}

Ärvt frånWebApiSkill.httpHeaders

httpMethod

Metoden för http-begäran.

httpMethod?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.httpMethod

inputs

Indata för färdigheterna kan vara en kolumn i källdatauppsättningen eller utdata från en överordnad färdighet.

inputs: InputFieldMappingEntry[]

Egenskapsvärde

InputFieldMappingEntry[]

Ärvd frånWebApiSkill.inputs

name

Namnet på färdigheten som unikt identifierar den i kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för dess 1-baserade index i kompetensmatrisen, med prefixet "#".

name?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.name

outputs

Utdata från en färdighet är antingen ett fält i ett sökindex eller ett värde som kan användas som indata av en annan färdighet.

outputs: OutputFieldMappingEntry[]

Egenskapsvärde

OutputFieldMappingEntry[]

Ärvd frånWebApiSkill.outputs

timeout

Önskad tidsgräns för begäran. Standardvärdet är 30 sekunder.

timeout?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.timeout

uri

URL:en för webb-API:et.

uri: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.uri