ChatCompletionSkill interface

Пакет:

@azure/search-documents

Навык, который вызывает языковую модель через конечную точку Chat Completions Azure AI Foundry.

Extends

WebApiSkill

Свойства

apiKey	Ключ API для аутентификации в модели. И apiKey, и authIdentity не могут быть указаны одновременно.
commonModelParameters	Общие параметры языковой модели, которые клиенты могут настраивать. Если этот параметр опущен, будут применяться разумные значения по умолчанию.
extraParameters	Словарь открытого типа для параметров, специфичных для модели, которые должны быть добавлены к вызову завершения чата. Следует шаблону расширяемости Azure AI Foundry.
extraParametersBehavior	Как Azure AI Foundry обрабатывает дополнительные параметры. Значение по умолчанию — 'error'.
odatatype	Полиморфная дискриминация, указывающая различные типы этого объекта, может быть
responseFormat	Определяет, как LLM должен форматировать свой ответ. По умолчанию используется тип ответа «текст».

Унаследованные свойства

authIdentity	Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан идентификатор authResourceId и он не указан, используется управляемое удостоверение, назначаемое системой. При обновлении индексатора, если удостоверение не указано, значение остается неизменным. Если установлено значение "none", значение этого свойства очищается.
authResourceId	Применяется к пользовательским навыкам, которые подключаются к внешнему коду в функции Azure или другом приложении, предоставляющем трансформации. Это значение должно быть идентификатором приложения, созданным для функции или приложения при регистрации в Azure Active Directory. При указании пользовательский навык подключается к функции или приложению с помощью управляемого идентификатора (назначаемого системой или пользователем) службы поиска и маркера доступа функции или приложения, используя это значение в качестве идентификатора ресурса для создания области маркера доступа.
batchSize	Требуемый размер пакета, указывающий количество документов.
context	Представляет уровень, на котором выполняются операции, такие как корневой каталог документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.
degreeOfParallelism	Если задано, количество параллельных вызовов, которые можно выполнить в веб-API.
description	Описание навыка, описывающего входные данные, выходные данные и использование навыка.
httpHeaders	Заголовки, необходимые для выполнения http-запроса.
httpMethod	Метод http-запроса.
inputs	Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящего навыка.
name	Имя навыка, который однозначно идентифицирует его в наборе навыков. Навык без определенного имени будет указан по умолчанию для его 1-го индекса в массиве навыков, префиксированного символом "#".
outputs	Выходные данные навыка — это поле в индексе поиска или значение, которое можно использовать в качестве входных данных другим навыком.
timeout	Требуемое время ожидания запроса. Значение по умолчанию — 30 секунд.
uri	URL-адрес веб-API.

Сведения о свойстве

apiKey

Ключ API для аутентификации в модели. И apiKey, и authIdentity не могут быть указаны одновременно.

apiKey?: string

Значение свойства

string

commonModelParameters

Общие параметры языковой модели, которые клиенты могут настраивать. Если этот параметр опущен, будут применяться разумные значения по умолчанию.

commonModelParameters?: CommonModelParameters

Значение свойства

CommonModelParameters

extraParameters

Словарь открытого типа для параметров, специфичных для модели, которые должны быть добавлены к вызову завершения чата. Следует шаблону расширяемости Azure AI Foundry.

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

Значение свойства

{[propertyName: string]: unknown}

extraParametersBehavior

Как Azure AI Foundry обрабатывает дополнительные параметры. Значение по умолчанию — 'error'.

extraParametersBehavior?: string

Значение свойства

string

odatatype

Полиморфная дискриминация, указывающая различные типы этого объекта, может быть

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

Значение свойства

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Определяет, как LLM должен форматировать свой ответ. По умолчанию используется тип ответа «текст».

responseFormat?: ChatCompletionResponseFormat

Значение свойства

ChatCompletionResponseFormat

Сведения об унаследованном свойстве

authIdentity

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан идентификатор authResourceId и он не указан, используется управляемое удостоверение, назначаемое системой. При обновлении индексатора, если удостоверение не указано, значение остается неизменным. Если установлено значение "none", значение этого свойства очищается.

authIdentity?: SearchIndexerDataIdentity

Значение свойства

SearchIndexerDataIdentity

Наследуется отWebApiSkill.authIdentity

authResourceId

Применяется к пользовательским навыкам, которые подключаются к внешнему коду в функции Azure или другом приложении, предоставляющем трансформации. Это значение должно быть идентификатором приложения, созданным для функции или приложения при регистрации в Azure Active Directory. При указании пользовательский навык подключается к функции или приложению с помощью управляемого идентификатора (назначаемого системой или пользователем) службы поиска и маркера доступа функции или приложения, используя это значение в качестве идентификатора ресурса для создания области маркера доступа.

authResourceId?: string

Значение свойства

string

Наследуется отWebApiSkill.authResourceId

batchSize

Требуемый размер пакета, указывающий количество документов.

batchSize?: number

Значение свойства

number

Наследуется отWebApiSkill.batchSize

context

Представляет уровень, на котором выполняются операции, такие как корневой каталог документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.

context?: string

Значение свойства

string

Наследуется отWebApiSkill.context

degreeOfParallelism

Если задано, количество параллельных вызовов, которые можно выполнить в веб-API.

degreeOfParallelism?: number

Значение свойства

number

Наследуется отWebApiSkill.degreeOfParallelism

description

Описание навыка, описывающего входные данные, выходные данные и использование навыка.

description?: string

Значение свойства

string

Наследуется отWebApiSkill.description

httpHeaders

Заголовки, необходимые для выполнения http-запроса.

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

Значение свойства

{[propertyName: string]: string}

Наследуется отWebApiSkill.httpHeaders

httpMethod

Метод http-запроса.

httpMethod?: string

Значение свойства

string

Наследуется отWebApiSkill.httpMethod

inputs

Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящего навыка.

inputs: InputFieldMappingEntry[]

Значение свойства

InputFieldMappingEntry[]

Наследуется отWebApiSkill.inputs

name

Имя навыка, который однозначно идентифицирует его в наборе навыков. Навык без определенного имени будет указан по умолчанию для его 1-го индекса в массиве навыков, префиксированного символом "#".

name?: string

Значение свойства

string

Унаследовано отWebApiSkill.name

outputs

Выходные данные навыка — это поле в индексе поиска или значение, которое можно использовать в качестве входных данных другим навыком.

outputs: OutputFieldMappingEntry[]

Значение свойства

OutputFieldMappingEntry[]

Наследуется отWebApiSkill.outputs

timeout

Требуемое время ожидания запроса. Значение по умолчанию — 30 секунд.

timeout?: string

Значение свойства

string

Наследуется отWebApiSkill.timeout

uri

URL-адрес веб-API.

uri: string

Значение свойства

string

Наследуется отWebApiSkill.uri