ChatCompletionSkill interface

Pacote:

@azure/search-documents

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

Extends

WebApiSkill

Propriedades

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

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 pelo 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 ao código externo em uma função do Azure ou algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ele foi registrado no Azure Active Directory. Quando especificada, a habilidade personalizada se conecta à função ou ao aplicativo usando um ID gerenciado (atribuído pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou do aplicativo, usando esse valor como o ID do recurso para criar o escopo do token de acesso.
batchSize	O tamanho do lote desejado que indica o número de documentos.
context	Representa o nível em que 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 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 upstream.
name	O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado 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 da API Web.

Detalhes da propriedade

apiKey

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

apiKey?: string

Valor da propriedade

string

commonModelParameters

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

commonModelParameters?: CommonModelParameters

Valor da propriedade

CommonModelParameters

extraParameters

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

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

Valor da propriedade

{[propertyName: string]: unknown}

extraParametersBehavior

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

extraParametersBehavior?: string

Valor da propriedade

string

odatatype

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

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

Valor da propriedade

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

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

responseFormat?: ChatCompletionResponseFormat

Valor da propriedade

ChatCompletionResponseFormat

Detalhes das 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 pelo 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 da propriedade

SearchIndexerDataIdentity

Herdado deWebApiSkill.authIdentity

authResourceId

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

authResourceId?: string

Valor da propriedade

string

Herdado deWebApiSkill.authResourceId

batchSize

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

batchSize?: number

Valor da propriedade

number

Herdado deWebApiSkill.batchSize

context

Representa o nível em que 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 da propriedade

string

Herdado deWebApiSkill.context

degreeOfParallelism

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

degreeOfParallelism?: number

Valor da propriedade

number

Herdado deWebApiSkill.degreeOfParallelism

description

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

description?: string

Valor da propriedade

string

Herdado deWebApiSkill.description

httpHeaders

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

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

Valor da propriedade

{[propertyName: string]: string}

Herdado deWebApiSkill.httpHeaders

httpMethod

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

httpMethod?: string

Valor da 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 upstream.

inputs: InputFieldMappingEntry[]

Valor da propriedade

InputFieldMappingEntry[]

Herdado deWebApiSkill.inputs

name

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

name?: string

Valor da 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 da propriedade

OutputFieldMappingEntry[]

Herdado deWebApiSkill.outputs

timeout

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

timeout?: string

Valor da propriedade

string

Herdado deWebApiSkill.timeout

uri

A url da API Web.

uri: string

Valor da propriedade

string

Herdado deWebApiSkill.uri