ChatCompletionSkill interface

Paquete:

@azure/search-documents

Una aptitud que llama a un modelo de lenguaje a través del punto de conexión de finalización de chat de Azure AI Foundry.

Extends

WebApiSkill

Propiedades

apiKey	Clave de API para autenticarse en el modelo. Tanto apiKey como authIdentity no se pueden especificar al mismo tiempo.
commonModelParameters	Parámetros comunes del modelo de lenguaje que los clientes pueden modificar. Si se omite, se aplicarán los valores predeterminados razonables.
extraParameters	Diccionario de tipo abierto para parámetros específicos del modelo que se deben anexar a la llamada de finalización de chat. Sigue el patrón de extensibilidad de Azure AI Foundry.
extraParametersBehavior	Cómo controla Azure AI Foundry los parámetros adicionales. El valor predeterminado es 'error'.
odatatype	Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto.
responseFormat	Determina cómo el LLM debe formatear su respuesta. El valor predeterminado es el tipo de respuesta 'texto'.

Propiedades heredadas

authIdentity	La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad.
authResourceId	Se aplica a las aptitudes personalizadas que se conectan a código externo en una función de Azure o alguna otra aplicación que proporcione las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o aplicación cuando se registró en Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea asignado por el sistema o por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, utilizando este valor como identificador de recurso para crear el ámbito del token de acceso.
batchSize	El tamaño de lote deseado que indica el número de documentos.
context	Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document.
degreeOfParallelism	Si se establece, el número de llamadas paralelas que se pueden realizar a la API web.
description	La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud.
httpHeaders	Los encabezados necesarios para realizar la solicitud http.
httpMethod	El método para la solicitud http.
inputs	Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente.
name	El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'.
outputs	La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.
timeout	El tiempo de espera deseado para la solicitud. El valor predeterminado es 30 segundos.
uri	La dirección URL de la API web.

Detalles de las propiedades

apiKey

Clave de API para autenticarse en el modelo. Tanto apiKey como authIdentity no se pueden especificar al mismo tiempo.

apiKey?: string

Valor de propiedad

string

commonModelParameters

Parámetros comunes del modelo de lenguaje que los clientes pueden modificar. Si se omite, se aplicarán los valores predeterminados razonables.

commonModelParameters?: CommonModelParameters

Valor de propiedad

CommonModelParameters

extraParameters

Diccionario de tipo abierto para parámetros específicos del modelo que se deben anexar a la llamada de finalización de chat. Sigue el patrón de extensibilidad de Azure AI Foundry.

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

Valor de propiedad

{[propertyName: string]: unknown}

extraParametersBehavior

Cómo controla Azure AI Foundry los parámetros adicionales. El valor predeterminado es 'error'.

extraParametersBehavior?: string

Valor de propiedad

string

odatatype

Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto.

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

Valor de propiedad

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Determina cómo el LLM debe formatear su respuesta. El valor predeterminado es el tipo de respuesta 'texto'.

responseFormat?: ChatCompletionResponseFormat

Valor de propiedad

ChatCompletionResponseFormat

Detalles de las propiedades heredadas

authIdentity

La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad.

authIdentity?: SearchIndexerDataIdentity

Valor de propiedad

SearchIndexerDataIdentity

Heredado deWebApiSkill.authIdentity

authResourceId

Se aplica a las aptitudes personalizadas que se conectan a código externo en una función de Azure o alguna otra aplicación que proporcione las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o aplicación cuando se registró en Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea asignado por el sistema o por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, utilizando este valor como identificador de recurso para crear el ámbito del token de acceso.

authResourceId?: string

Valor de propiedad

string

Heredado deWebApiSkill.authResourceId

batchSize

El tamaño de lote deseado que indica el número de documentos.

batchSize?: number

Valor de propiedad

number

Heredado deWebApiSkill.batchSize

context

Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document.

context?: string

Valor de propiedad

string

Heredado deWebApiSkill.context

degreeOfParallelism

Si se establece, el número de llamadas paralelas que se pueden realizar a la API web.

degreeOfParallelism?: number

Valor de propiedad

number

Heredado deWebApiSkill.degreeOfParallelism

description

La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud.

description?: string

Valor de propiedad

string

Heredado deWebApiSkill.description

httpHeaders

Los encabezados necesarios para realizar la solicitud http.

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

Valor de propiedad

{[propertyName: string]: string}

Heredado deWebApiSkill.httpHeaders

httpMethod

El método para la solicitud http.

httpMethod?: string

Valor de propiedad

string

Heredado deWebApiSkill.httpMethod

inputs

Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente.

inputs: InputFieldMappingEntry[]

Valor de propiedad

InputFieldMappingEntry[]

Heredado deWebApiSkill.inputs

name

El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'.

name?: string

Valor de propiedad

string

Heredado deWebApiSkill.name

outputs

La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.

outputs: OutputFieldMappingEntry[]

Valor de propiedad

OutputFieldMappingEntry[]

Heredado deWebApiSkill.outputs

timeout

El tiempo de espera deseado para la solicitud. El valor predeterminado es 30 segundos.

timeout?: string

Valor de propiedad

string

Heredado deWebApiSkill.timeout

uri

La dirección URL de la API web.

uri: string

Valor de propiedad

string

Heredado deWebApiSkill.uri