ChatCompletionSkill interface

Pacote:

@azure/search-documents

Uma habilidade que chama um modelo de linguagem via o endpoint Chat Completions do Fábrica de IA do Azure.

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 Fábrica de IA do Azure.
extraParametersBehavior	Como parâmetros extras são tratados pelo Fábrica de IA do Azure. 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. Em atualizações para o 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 forneça as transformações. Esse valor deve ser o ID da aplicação criada para a função ou aplicativo quando foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído 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 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 na API Web.
description	A descrição da habilidade que descreve as entradas, as saídas e o 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 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, 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 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 Fábrica de IA do Azure.

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

Valor da propriedade

{[propertyName: string]: unknown}

extraParametersBehavior

Como parâmetros extras são tratados pelo Fábrica de IA do Azure. 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. Em atualizações para o 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 a código externo em uma função do Azure ou em algum outro aplicativo que forneça as transformações. Esse valor deve ser o ID da aplicação criada para a função ou aplicativo quando foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído 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 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 na API Web.

degreeOfParallelism?: number

Valor da propriedade

number

Herdado deWebApiSkill.degreeOfParallelism

description

A descrição da habilidade que descreve as entradas, as saídas e o 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 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, 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 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