ChatCompletionSkill interface

Pakiet:

@azure/search-documents

Umiejętność, która wywołuje model językowy za pośrednictwem punktu końcowego Chat Completions Azure AI Foundry.

Rozszerzenie

WebApiSkill

Właściwości

apiKey	Klucz API do uwierzytelniania w modelu. Nie można określić jednocześnie apiKey i authIdentity.
commonModelParameters	Typowe parametry modelu językowego, które klienci mogą dostosowywać. W przypadku pominięcia zostaną zastosowane rozsądne wartości domyślne.
extraParameters	Słownik typu otwartego dla parametrów specyficznych dla modelu, które powinny być dołączane do wywołania uzupełniania czatu. Jest zgodny ze wzorcem rozszerzalności usługi Azure AI Foundry.
extraParametersBehavior	Jak dodatkowe parametry są obsługiwane przez Azure AI Foundry. Wartość domyślna to "error".
odatatype	Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być
responseFormat	Określa, w jaki sposób LLM powinien sformatować swoją odpowiedź. Domyślnie jest to typ odpowiedzi "tekst".

Właściwości dziedziczone

authIdentity	Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. Jeśli podano identyfikator authResourceId i nie zostanie określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksatora, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli jest ustawiona na "none", wartość tej właściwości jest czyszczona.
authResourceId	Dotyczy niestandardowych umiejętności łączących się z zewnętrznym kodem w funkcji Azure lub innej aplikacji, która zapewnia transformacje. Ta wartość powinna być identyfikatorem aplikacji utworzonym dla funkcji lub aplikacji podczas rejestracji w Azure Active Directory. Po określeniu niestandardowa umiejętność łączy się z funkcją lub aplikacją przy użyciu identyfikatora zarządzanego (systemu lub przypisanego przez użytkownika) usługi wyszukiwania oraz tokenu dostępu funkcji lub aplikacji przy użyciu tej wartości jako identyfikatora zasobu do utworzenia zakresu tokenu dostępu.
batchSize	Żądany rozmiar partii, który wskazuje liczbę dokumentów.
context	Reprezentuje poziom, na którym odbywają się operacje, takie jak zawartość katalogu głównego lub dokumentu dokumentu (na przykład /document lub /document/content). Wartość domyślna to /document.
degreeOfParallelism	W przypadku ustawienia liczba wywołań równoległych, które można wykonać w internetowym interfejsie API.
description	Opis umiejętności opisujący dane wejściowe, dane wyjściowe i użycie umiejętności.
httpHeaders	Nagłówki wymagane do wykonania żądania HTTP.
httpMethod	Metoda żądania HTTP.
inputs	Dane wejściowe umiejętności mogą być kolumną w zestawie danych źródłowych lub danymi wyjściowymi umiejętności nadrzędnych.
name	Nazwa umiejętności, która jednoznacznie identyfikuje ją w zestawie umiejętności. Umiejętność bez zdefiniowanej nazwy będzie mieć domyślną nazwę swojego 1-opartego na indeksie w tablicy umiejętności, poprzedzoną znakiem "#".
outputs	Dane wyjściowe umiejętności to pole w indeksie wyszukiwania lub wartość, która może być zużywana jako dane wejściowe przez inną umiejętność.
timeout	Żądany limit czasu żądania. Wartość domyślna to 30 sekund.
uri	Adres URL internetowego interfejsu API.

Szczegóły właściwości

apiKey

Klucz API do uwierzytelniania w modelu. Nie można określić jednocześnie apiKey i authIdentity.

apiKey?: string

Wartość właściwości

string

commonModelParameters

Typowe parametry modelu językowego, które klienci mogą dostosowywać. W przypadku pominięcia zostaną zastosowane rozsądne wartości domyślne.

commonModelParameters?: CommonModelParameters

Wartość właściwości

CommonModelParameters

extraParameters

Słownik typu otwartego dla parametrów specyficznych dla modelu, które powinny być dołączane do wywołania uzupełniania czatu. Jest zgodny ze wzorcem rozszerzalności usługi Azure AI Foundry.

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

Wartość właściwości

{[propertyName: string]: unknown}

extraParametersBehavior

Jak dodatkowe parametry są obsługiwane przez Azure AI Foundry. Wartość domyślna to "error".

extraParametersBehavior?: string

Wartość właściwości

string

odatatype

Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być

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

Wartość właściwości

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Określa, w jaki sposób LLM powinien sformatować swoją odpowiedź. Domyślnie jest to typ odpowiedzi "tekst".

responseFormat?: ChatCompletionResponseFormat

Wartość właściwości

ChatCompletionResponseFormat

Szczegóły właściwości dziedziczonej

authIdentity

Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. Jeśli podano identyfikator authResourceId i nie zostanie określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksatora, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli jest ustawiona na "none", wartość tej właściwości jest czyszczona.

authIdentity?: SearchIndexerDataIdentity

Wartość właściwości

SearchIndexerDataIdentity

Odziedziczone poWebApiSkill.authIdentity

authResourceId

Dotyczy niestandardowych umiejętności łączących się z zewnętrznym kodem w funkcji Azure lub innej aplikacji, która zapewnia transformacje. Ta wartość powinna być identyfikatorem aplikacji utworzonym dla funkcji lub aplikacji podczas rejestracji w Azure Active Directory. Po określeniu niestandardowa umiejętność łączy się z funkcją lub aplikacją przy użyciu identyfikatora zarządzanego (systemu lub przypisanego przez użytkownika) usługi wyszukiwania oraz tokenu dostępu funkcji lub aplikacji przy użyciu tej wartości jako identyfikatora zasobu do utworzenia zakresu tokenu dostępu.

authResourceId?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.authResourceId

batchSize

Żądany rozmiar partii, który wskazuje liczbę dokumentów.

batchSize?: number

Wartość właściwości

number

Odziedziczone poWebApiSkill.batchSize

context

Reprezentuje poziom, na którym odbywają się operacje, takie jak zawartość katalogu głównego lub dokumentu dokumentu (na przykład /document lub /document/content). Wartość domyślna to /document.

context?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.context

degreeOfParallelism

W przypadku ustawienia liczba wywołań równoległych, które można wykonać w internetowym interfejsie API.

degreeOfParallelism?: number

Wartość właściwości

number

Odziedziczone poWebApiSkill.degreeOfParallelism

description

Opis umiejętności opisujący dane wejściowe, dane wyjściowe i użycie umiejętności.

description?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.description

httpHeaders

Nagłówki wymagane do wykonania żądania HTTP.

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

Wartość właściwości

{[propertyName: string]: string}

Odziedziczone poWebApiSkill.httpHeaders

httpMethod

Metoda żądania HTTP.

httpMethod?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.httpMethod

inputs

Dane wejściowe umiejętności mogą być kolumną w zestawie danych źródłowych lub danymi wyjściowymi umiejętności nadrzędnych.

inputs: InputFieldMappingEntry[]

Wartość właściwości

InputFieldMappingEntry[]

Odziedziczone poWebApiSkill.inputs

name

Nazwa umiejętności, która jednoznacznie identyfikuje ją w zestawie umiejętności. Umiejętność bez zdefiniowanej nazwy będzie mieć domyślną nazwę swojego 1-opartego na indeksie w tablicy umiejętności, poprzedzoną znakiem "#".

name?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.name

outputs

Dane wyjściowe umiejętności to pole w indeksie wyszukiwania lub wartość, która może być zużywana jako dane wejściowe przez inną umiejętność.

outputs: OutputFieldMappingEntry[]

Wartość właściwości

OutputFieldMappingEntry[]

Odziedziczone poWebApiSkill.outputs

timeout

Żądany limit czasu żądania. Wartość domyślna to 30 sekund.

timeout?: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.timeout

uri

Adres URL internetowego interfejsu API.

uri: string

Wartość właściwości

string

Odziedziczone poWebApiSkill.uri