ChatCompletionSkill interface

Pakket:

@azure/search-documents

Een vaardigheid die een taalmodel aanroept via het eindpunt Chat Completion van Azure AI Foundry.

Uitbreiding

WebApiSkill

Eigenschappen

apiKey	API-sleutel voor verificatie bij het model. Zowel apiKey als authIdentity kunnen niet tegelijkertijd worden opgegeven.
commonModelParameters	Gemeenschappelijke taalmodelparameters die klanten kunnen aanpassen. Indien weggelaten, zullen redelijke standaardinstellingen worden toegepast.
extraParameters	Open-type woordenboek voor modelspecifieke parameters die moeten worden toegevoegd aan de aanroep voor het voltooien van de chat. Volgt het uitbreidbaarheidspatroon van Azure AI Foundry.
extraParametersBehavior	Hoe extra parameters worden verwerkt door Azure AI Foundry. De standaardinstelling is 'fout'.
odatatype	Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven
responseFormat	Hiermee bepaalt u hoe de LLM het antwoord moet opmaken. Standaardinstelling voor het antwoordtype 'tekst'.

Overgenomen eigenschappen

authIdentity	De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen. Als er een authResourceId is opgegeven en deze niet is opgegeven, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als de identiteit bij updates van de indexeerfunctie niet is opgegeven, blijft de waarde ongewijzigd. Als deze optie is ingesteld op 'geen', wordt de waarde van deze eigenschap gewist.
authResourceId	Is van toepassing op aangepaste vaardigheden die verbinding maken met externe code in een Azure-functie of een andere toepassing die de transformaties biedt. Deze waarde moet de toepassings-id zijn die is gemaakt voor de functie of app toen deze werd geregistreerd bij Azure Active Directory. Indien opgegeven, maakt de aangepaste skill verbinding met de functie of app met behulp van een beheerde id (door het systeem of door de gebruiker toegewezen) van de zoekservice en het toegangstoken van de functie of app, waarbij deze waarde wordt gebruikt als resource-id voor het maken van het bereik van het toegangstoken.
batchSize	De gewenste batchgrootte die het aantal documenten aangeeft.
context	Vertegenwoordigt het niveau waarop bewerkingen plaatsvinden, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardinstelling is /document.
degreeOfParallelism	Indien ingesteld, het aantal parallelle aanroepen dat naar de web-API kan worden gedaan.
description	De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
httpHeaders	De headers die nodig zijn om het http-verzoek in te dienen.
httpMethod	De methode voor het http-verzoek.
inputs	Invoer van de vaardigheden kan een kolom in de brongegevensset zijn, of de uitvoer van een stroomopwaartse vaardigheid.
name	De naam van de vaardigheid die deze op unieke wijze identificeert binnen de vaardighedenset. Een vaardigheid waarvoor geen naam is gedefinieerd, krijgt een standaardnaam van de op 1 gebaseerde index in de vaardigheidsarray, voorafgegaan door het teken '#'.
outputs	De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die als invoer door een andere vaardigheid kan worden verbruikt.
timeout	De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.
uri	De url voor de Web API.

Eigenschapdetails

apiKey

API-sleutel voor verificatie bij het model. Zowel apiKey als authIdentity kunnen niet tegelijkertijd worden opgegeven.

apiKey?: string

Waarde van eigenschap

string

commonModelParameters

Gemeenschappelijke taalmodelparameters die klanten kunnen aanpassen. Indien weggelaten, zullen redelijke standaardinstellingen worden toegepast.

commonModelParameters?: CommonModelParameters

Waarde van eigenschap

CommonModelParameters

extraParameters

Open-type woordenboek voor modelspecifieke parameters die moeten worden toegevoegd aan de aanroep voor het voltooien van de chat. Volgt het uitbreidbaarheidspatroon van Azure AI Foundry.

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

Waarde van eigenschap

{[propertyName: string]: unknown}

extraParametersBehavior

Hoe extra parameters worden verwerkt door Azure AI Foundry. De standaardinstelling is 'fout'.

extraParametersBehavior?: string

Waarde van eigenschap

string

odatatype

Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven

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

Waarde van eigenschap

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Hiermee bepaalt u hoe de LLM het antwoord moet opmaken. Standaardinstelling voor het antwoordtype 'tekst'.

responseFormat?: ChatCompletionResponseFormat

Waarde van eigenschap

ChatCompletionResponseFormat

Details van overgenomen eigenschap

authIdentity

De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen. Als er een authResourceId is opgegeven en deze niet is opgegeven, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als de identiteit bij updates van de indexeerfunctie niet is opgegeven, blijft de waarde ongewijzigd. Als deze optie is ingesteld op 'geen', wordt de waarde van deze eigenschap gewist.

authIdentity?: SearchIndexerDataIdentity

Waarde van eigenschap

SearchIndexerDataIdentity

Overgeërfd vanWebApiSkill.authIdentity

authResourceId

Is van toepassing op aangepaste vaardigheden die verbinding maken met externe code in een Azure-functie of een andere toepassing die de transformaties biedt. Deze waarde moet de toepassings-id zijn die is gemaakt voor de functie of app toen deze werd geregistreerd bij Azure Active Directory. Indien opgegeven, maakt de aangepaste skill verbinding met de functie of app met behulp van een beheerde id (door het systeem of door de gebruiker toegewezen) van de zoekservice en het toegangstoken van de functie of app, waarbij deze waarde wordt gebruikt als resource-id voor het maken van het bereik van het toegangstoken.

authResourceId?: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.authResourceId

batchSize

De gewenste batchgrootte die het aantal documenten aangeeft.

batchSize?: number

Waarde van eigenschap

number

Overgeërfd vanWebApiSkill.batchSize

context

Vertegenwoordigt het niveau waarop bewerkingen plaatsvinden, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardinstelling is /document.

context?: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.context

degreeOfParallelism

Indien ingesteld, het aantal parallelle aanroepen dat naar de web-API kan worden gedaan.

degreeOfParallelism?: number

Waarde van eigenschap

number

Geërfd vanWebApiSkill.degreeOfParallelism

description

De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.

description?: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.description

httpHeaders

De headers die nodig zijn om het http-verzoek in te dienen.

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

Waarde van eigenschap

{[propertyName: string]: string}

Overgenomen vanWebApiSkill.httpHeaders

httpMethod

De methode voor het http-verzoek.

httpMethod?: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.httpMethod

inputs

Invoer van de vaardigheden kan een kolom in de brongegevensset zijn, of de uitvoer van een stroomopwaartse vaardigheid.

inputs: InputFieldMappingEntry[]

Waarde van eigenschap

InputFieldMappingEntry[]

Overgeërfd vanWebApiSkill.inputs

name

De naam van de vaardigheid die deze op unieke wijze identificeert binnen de vaardighedenset. Een vaardigheid waarvoor geen naam is gedefinieerd, krijgt een standaardnaam van de op 1 gebaseerde index in de vaardigheidsarray, voorafgegaan door het teken '#'.

name?: string

Waarde van eigenschap

string

Geërfdvan WebApiSkill.name

outputs

De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die als invoer door een andere vaardigheid kan worden verbruikt.

outputs: OutputFieldMappingEntry[]

Waarde van eigenschap

OutputFieldMappingEntry[]

Overgeërfd vanWebApiSkill.outputs

timeout

De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.

timeout?: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.timeout

uri

De url voor de Web API.

uri: string

Waarde van eigenschap

string

Overgeërfd vanWebApiSkill.uri