ChatCompletionSkill interface

Paket:

@azure/search-documents

Eine Fähigkeit, die ein Sprachmodell über Azure AI Foundry 's Chat Completions-Endpunkt aufruft.

Extends

WebApiSkill

Eigenschaften

apiKey	API-Schlüssel für die Authentifizierung beim Modell. Sowohl apiKey als auch authIdentity können nicht gleichzeitig angegeben werden.
commonModelParameters	Parameter des allgemeinen Sprachmodells, die Kunden anpassen können. Wenn nicht, werden angemessene Verzug angewendet.
extraParameters	Offenes Wörterbuch für modellspezifische Parameter, die an den Aufruf von Chatvervollständigungen angehängt werden sollen. Folgt dem Erweiterbarkeitsmuster von Azure AI Foundry .
extraParametersBehavior	Wie zusätzliche Parameter von Azure AI Foundry behandelt werden. Der Standardwert ist 'error'.
odatatype	Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann
responseFormat	Bestimmt, wie das LLM seine Antwort formatieren soll. Standardmäßig wird der Antworttyp "text" verwendet.

Geerbte Eigenschaften

authIdentity	Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId bereitgestellt und nicht angegeben wird, wird die vom System zugewiesene verwaltete Identität verwendet. Bei Aktualisierungen des Indexers bleibt der Wert unverändert, wenn die Identität nicht angegeben ist. Wenn der Wert auf "none" festgelegt ist, wird der Wert dieser Eigenschaft gelöscht.
authResourceId	Gilt für benutzerdefinierte Fähigkeiten, die mit externem Code in einer Azure-Funktion oder einer anderen Anwendung verbunden sind, die die Transformationen bereitstellt. Dieser Wert sollte die Anwendungs-ID sein, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt die benutzerdefinierte Fähigkeit eine Verbindung mit der Funktion oder App mithilfe einer verwalteten ID (entweder system oder vom Benutzer zugewiesen) des Suchdiensts und dem Zugriffstoken der Funktion oder App mithilfe dieses Werts als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens.
batchSize	Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt.
context	Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.
degreeOfParallelism	Bei Festlegung wird die Anzahl der parallelen Aufrufe, die an die Web-API vorgenommen werden können, ausgeführt.
description	Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt.
httpHeaders	Die Header, die zum Erstellen der HTTP-Anforderung erforderlich sind.
httpMethod	Die Methode für die HTTP-Anforderung.
inputs	Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein.
name	Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist.
outputs	Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann.
timeout	Das gewünschte Timeout für die Anforderung. Der Standardwert ist „30 Sekunden“.
uri	Die URL für die Web-API.

Details zur Eigenschaft

apiKey

API-Schlüssel für die Authentifizierung beim Modell. Sowohl apiKey als auch authIdentity können nicht gleichzeitig angegeben werden.

apiKey?: string

Eigenschaftswert

string

commonModelParameters

Parameter des allgemeinen Sprachmodells, die Kunden anpassen können. Wenn nicht, werden angemessene Verzug angewendet.

commonModelParameters?: CommonModelParameters

Eigenschaftswert

CommonModelParameters

extraParameters

Offenes Wörterbuch für modellspezifische Parameter, die an den Aufruf von Chatvervollständigungen angehängt werden sollen. Folgt dem Erweiterbarkeitsmuster von Azure AI Foundry .

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

Eigenschaftswert

{[propertyName: string]: unknown}

extraParametersBehavior

Wie zusätzliche Parameter von Azure AI Foundry behandelt werden. Der Standardwert ist 'error'.

extraParametersBehavior?: string

Eigenschaftswert

string

odatatype

Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann

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

Eigenschaftswert

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Bestimmt, wie das LLM seine Antwort formatieren soll. Standardmäßig wird der Antworttyp "text" verwendet.

responseFormat?: ChatCompletionResponseFormat

Eigenschaftswert

ChatCompletionResponseFormat

Geerbte Eigenschaftsdetails

authIdentity

Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId bereitgestellt und nicht angegeben wird, wird die vom System zugewiesene verwaltete Identität verwendet. Bei Aktualisierungen des Indexers bleibt der Wert unverändert, wenn die Identität nicht angegeben ist. Wenn der Wert auf "none" festgelegt ist, wird der Wert dieser Eigenschaft gelöscht.

authIdentity?: SearchIndexerDataIdentity

Eigenschaftswert

SearchIndexerDataIdentity

Geerbt vonWebApiSkill.authIdentity

authResourceId

Gilt für benutzerdefinierte Fähigkeiten, die mit externem Code in einer Azure-Funktion oder einer anderen Anwendung verbunden sind, die die Transformationen bereitstellt. Dieser Wert sollte die Anwendungs-ID sein, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt die benutzerdefinierte Fähigkeit eine Verbindung mit der Funktion oder App mithilfe einer verwalteten ID (entweder system oder vom Benutzer zugewiesen) des Suchdiensts und dem Zugriffstoken der Funktion oder App mithilfe dieses Werts als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens.

authResourceId?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.authResourceId

batchSize

Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt.

batchSize?: number

Eigenschaftswert

number

Geerbt vonWebApiSkill.batchSize

context

Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.

context?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.context

degreeOfParallelism

Bei Festlegung wird die Anzahl der parallelen Aufrufe, die an die Web-API vorgenommen werden können, ausgeführt.

degreeOfParallelism?: number

Eigenschaftswert

number

Geerbt vonWebApiSkill.degreeOfParallelism

description

Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt.

description?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.description

httpHeaders

Die Header, die zum Erstellen der HTTP-Anforderung erforderlich sind.

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

Eigenschaftswert

{[propertyName: string]: string}

Geerbt vonWebApiSkill.httpHeaders

httpMethod

Die Methode für die HTTP-Anforderung.

httpMethod?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.httpMethod

inputs

Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein.

inputs: InputFieldMappingEntry[]

Eigenschaftswert

InputFieldMappingEntry[]

Geerbt vonWebApiSkill.inputs

name

Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist.

name?: string

Eigenschaftswert

string

Von WebApiSkill.namegeerbt

outputs

Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann.

outputs: OutputFieldMappingEntry[]

Eigenschaftswert

OutputFieldMappingEntry[]

Geerbt vonWebApiSkill.outputs

timeout

Das gewünschte Timeout für die Anforderung. Der Standardwert ist „30 Sekunden“.

timeout?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.timeout

uri

Die URL für die Web-API.

uri: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.uri