ChatCompletionSkill interface

En färdighet som anropar en språkmodell via Azure AI Foundry's Chat Completions-endpoint.

Extends

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 har angetts och det inte har angetts används den systemtilldelade 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 anpassade färdigheter som kopplas till extern kod i en Azure-funktion eller någon annan applikation som tillhandahåller transformationerna. Detta värde bör vara applikations-ID:t som skapades för funktionen eller appen när den registrerades i Azure Active Directory. När den har angetts 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 det här värdet som resurs-ID för att skapa åtkomsttokens omfång.

batchSize

Önskad batchstorlek som anger antalet dokument.

context

Representerar den nivå där åtgärder utförs, till exempel dokumentroten eller dokumentinnehållet (till exempel /document eller /document/content). Standardvärdet är /document.

degreeOfParallelism

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

description

Beskrivningen av den färdighet 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å den färdighet som unikt identifierar den inom kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för sitt 1-baserade index i kunskapsmatrisen, prefixet med tecknet '#'.

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 timeout 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

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

Information om ärvda egenskaper

authIdentity

Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId har angetts och det inte har angetts används den systemtilldelade 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

Ärvd frånWebApiSkill.authIdentity

authResourceId

Gäller anpassade färdigheter som kopplas till extern kod i en Azure-funktion eller någon annan applikation som tillhandahåller transformationerna. Detta värde bör vara applikations-ID:t som skapades för funktionen eller appen när den registrerades i Azure Active Directory. När den har angetts 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 det här värdet som resurs-ID för att skapa åtkomsttokens omfång.

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å där åtgärder utförs, till exempel dokumentroten eller dokumentinnehållet (till exempel /document eller /document/content). Standardvärdet är /document.

context?: string

Egenskapsvärde

string

Ärvd frånWebApiSkill.context

degreeOfParallelism

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

degreeOfParallelism?: number

Egenskapsvärde

number

Ärvt frånWebApiSkill.degreeOfParallelism

description

Beskrivningen av den färdighet 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

Ärvd frånWebApiSkill.inputs

name

Namnet på den färdighet som unikt identifierar den inom kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för sitt 1-baserade index i kunskapsmatrisen, prefixet med tecknet '#'.

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

Ärvd frånWebApiSkill.outputs

timeout

Önskad timeout 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