Freigeben über

ChatCompletionSkill interface

Paket:
@azure/search-documents

Ein Skill, der ein Sprachmodell über den Endpunkt Chat Completions von Azure AI Foundry 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 benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId angegeben und nicht angegeben wird, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn bei Aktualisierungen des Indexers die Identität nicht angegeben ist, bleibt der Wert unverändert. Wenn der Wert auf "none" festgelegt ist, wird der Wert dieser Eigenschaft gelöscht.
authResourceId

Gilt für benutzerdefinierte Skills, die eine Verbindung mit externem Code in einer Azure-Funktion oder einer anderen Anwendung herstellen, die die Transformationen bereitstellt. Bei diesem Wert sollte es sich um die Anwendungs-ID handeln, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt der benutzerdefinierte Skill eine Verbindung mit der Funktion oder App her, indem er eine verwaltete ID (entweder system- oder benutzerseitig zugewiesen) des Suchdiensts und das Zugriffstoken der Funktion oder App verwendet, wobei dieser Wert als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens verwendet wird.
batchSize

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

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

Wenn festgelegt, die Anzahl der parallelen Aufrufe, die an die Web-API gesendet werden können.
description

Die Beschreibung des Skills, die die Eingaben, Ausgaben und die Verwendung des Skills beschreibt.
httpHeaders

Die Header, die zum Ausführen der HTTP-Anforderung erforderlich sind.
httpMethod

Die Methode für die HTTP-Anforderung.
inputs

Bei der Eingabe der Fertigkeiten kann es sich um eine Spalte im Quelldatensatz oder um die Ausgabe einer vorgelagerten Fertigkeit handeln.
name

Der Name des Skills, der ihn innerhalb des Skillssets eindeutig identifiziert. Ein Skill, für den kein Name definiert ist, erhält einen Standardnamen seines 1-basierten Index im skills-Array mit dem Präfix "#".
outputs

Die Ausgabe eines Skills ist entweder ein Feld in einem Suchindex oder ein Wert, der von einem anderen Skill als Eingabe verwendet werden kann.
timeout

Die gewünschte Zeitüberschreitung 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 benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId angegeben und nicht angegeben wird, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn bei Aktualisierungen des Indexers die Identität nicht angegeben ist, bleibt der Wert unverändert. 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 Skills, die eine Verbindung mit externem Code in einer Azure-Funktion oder einer anderen Anwendung herstellen, die die Transformationen bereitstellt. Bei diesem Wert sollte es sich um die Anwendungs-ID handeln, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt der benutzerdefinierte Skill eine Verbindung mit der Funktion oder App her, indem er eine verwaltete ID (entweder system- oder benutzerseitig zugewiesen) des Suchdiensts und das Zugriffstoken der Funktion oder App verwendet, wobei dieser Wert als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens verwendet wird.

authResourceId?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.authResourceId

batchSize

Die gewünschte Stapelgröß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 der Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.

context?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.context

degreeOfParallelism

Wenn festgelegt, die Anzahl der parallelen Aufrufe, die an die Web-API gesendet werden können.

degreeOfParallelism?: number

Eigenschaftswert

number

Geerbt vonWebApiSkill.degreeOfParallelism

description

Die Beschreibung des Skills, die die Eingaben, Ausgaben und die Verwendung des Skills beschreibt.

description?: string

Eigenschaftswert

string

Geerbt vonWebApiSkill.description

httpHeaders

Die Header, die zum Ausführen 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

Bei der Eingabe der Fertigkeiten kann es sich um eine Spalte im Quelldatensatz oder um die Ausgabe einer vorgelagerten Fertigkeit handeln.

inputs: InputFieldMappingEntry[]

Eigenschaftswert

InputFieldMappingEntry[]

Geerbt vonWebApiSkill.inputs

name

Der Name des Skills, der ihn innerhalb des Skillssets eindeutig identifiziert. Ein Skill, für den kein Name definiert ist, erhält einen Standardnamen seines 1-basierten Index im skills-Array mit dem Präfix "#".

name?: string

Eigenschaftswert

string

Von WebApiSkill.namegeerbt

outputs

Die Ausgabe eines Skills ist entweder ein Feld in einem Suchindex oder ein Wert, der von einem anderen Skill als Eingabe verwendet werden kann.

outputs: OutputFieldMappingEntry[]

Eigenschaftswert

OutputFieldMappingEntry[]

Geerbt vonWebApiSkill.outputs

timeout

Die gewünschte Zeitüberschreitung 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