ChatCompletionSkill interface

Pacote:

@azure/search-documents

Uma habilidade que chama um modelo de linguagem por meio do ponto de extremidade Conclusão de Chat do Azure AI Foundry.

Extends

WebApiSkill

Propriedades

apiKey	Chave de API para autenticação no modelo. apiKey e authIdentity não podem ser especificados ao mesmo tempo.
commonModelParameters	Parâmetros comuns do modelo de linguagem que os clientes podem ajustar. Se omitido, serão aplicados padrões razoáveis.
extraParameters	Dicionário de tipo aberto para parâmetros específicos do modelo que devem ser anexados à chamada de conclusão de chat. Segue o padrão de extensibilidade do Azure AI Foundry.
extraParametersBehavior	Como os parâmetros extras são manipulados pelo Azure AI Foundry. O padrão é 'erro'.
odatatype	Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser
responseFormat	Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'texto'.

Propriedades Herdadas

authIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída ao sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.
authResourceId	Aplica-se a habilidades personalizadas que se conectam a código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a id do recurso para criar o escopo do token de acesso.
batchSize	O tamanho de lote desejado que indica o número de documentos.
context	Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
degreeOfParallelism	Se definido, o número de chamadas paralelas que podem ser feitas para a API da Web.
description	A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.
httpHeaders	Os cabeçalhos necessários para fazer a solicitação http.
httpMethod	O método para a solicitação http.
inputs	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.
name	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.
outputs	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
timeout	O tempo limite desejado para a solicitação. O padrão é 30 segundos.
uri	A url para a API da Web.

Detalhes de Propriedade

apiKey

Chave de API para autenticação no modelo. apiKey e authIdentity não podem ser especificados ao mesmo tempo.

apiKey?: string

Valor de Propriedade

string

commonModelParameters

Parâmetros comuns do modelo de linguagem que os clientes podem ajustar. Se omitido, serão aplicados padrões razoáveis.

commonModelParameters?: CommonModelParameters

Valor de Propriedade

CommonModelParameters

extraParameters

Dicionário de tipo aberto para parâmetros específicos do modelo que devem ser anexados à chamada de conclusão de chat. Segue o padrão de extensibilidade do Azure AI Foundry.

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

Valor de Propriedade

{[propertyName: string]: unknown}

extraParametersBehavior

Como os parâmetros extras são manipulados pelo Azure AI Foundry. O padrão é 'erro'.

extraParametersBehavior?: string

Valor de Propriedade

string

odatatype

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

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

Valor de Propriedade

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'texto'.

responseFormat?: ChatCompletionResponseFormat

Valor de Propriedade

ChatCompletionResponseFormat

Detalhes da Propriedade Herdada

authIdentity

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída ao sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

authIdentity?: SearchIndexerDataIdentity

Valor de Propriedade

SearchIndexerDataIdentity

Herdado deWebApiSkill.authIdentity

authResourceId

Aplica-se a habilidades personalizadas que se conectam a código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a id do recurso para criar o escopo do token de acesso.

authResourceId?: string

Valor de Propriedade

string

Herdado deWebApiSkill.authResourceId

batchSize

O tamanho de lote desejado que indica o número de documentos.

batchSize?: number

Valor de Propriedade

number

Herdado deWebApiSkill.batchSize

context

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

context?: string

Valor de Propriedade

string

Herdado deWebApiSkill.context

degreeOfParallelism

Se definido, o número de chamadas paralelas que podem ser feitas para a API da Web.

degreeOfParallelism?: number

Valor de Propriedade

number

Herdado deWebApiSkill.degreeOfParallelism

description

A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.

description?: string

Valor de Propriedade

string

Herdado deWebApiSkill.description

httpHeaders

Os cabeçalhos necessários para fazer a solicitação http.

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

Valor de Propriedade

{[propertyName: string]: string}

Herdado deWebApiSkill.httpHeaders

httpMethod

O método para a solicitação http.

httpMethod?: string

Valor de Propriedade

string

Herdado deWebApiSkill.httpMethod

inputs

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.

inputs: InputFieldMappingEntry[]

Valor de Propriedade

InputFieldMappingEntry[]

Herdado deWebApiSkill.inputs

name

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

name?: string

Valor de Propriedade

string

Herdado deWebApiSkill.name

outputs

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

outputs: OutputFieldMappingEntry[]

Valor de Propriedade

OutputFieldMappingEntry[]

Herdado deWebApiSkill.outputs

timeout

O tempo limite desejado para a solicitação. O padrão é 30 segundos.

timeout?: string

Valor de Propriedade

string

Herdado deWebApiSkill.timeout

uri

A url para a API da Web.

uri: string

Valor de Propriedade

string

Herdado deWebApiSkill.uri