RunsCreateRunOptionalParams interface

Paquete:

@azure/ai-agents

Parámetros opcionales.

Extends

OperationOptions,PollingOptionsParams

Propiedades

additionalInstructions	Instrucciones adicionales para anexar al final de las instrucciones para la ejecución. Esto resulta útil para modificar el comportamiento por ejecución sin invalidar otras instrucciones.
additionalMessages	Agrega mensajes adicionales al subproceso antes de crear la ejecución.
include	Lista de campos adicionales que se van a incluir en la respuesta. Actualmente, el único valor admitido es step_details.tool_calls[*].file_search.results[*].content capturar el contenido del resultado de la búsqueda de archivos.
instructions	Las instrucciones del sistema invalidados que el agente debe usar para ejecutar el subproceso.
maxCompletionTokens	Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado incomplete. Consulta incomplete_details para obtener más información.
maxPromptTokens	Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado incomplete. Consulta incomplete_details para obtener más información.
metadata	Un conjunto de hasta 16 pares clave-valor que se pueden adjuntar a un objeto, que se usan para almacenar información adicional sobre ese objeto en un formato estructurado. Las claves pueden tener hasta 64 caracteres de longitud y los valores pueden tener hasta 512 caracteres de longitud.
model	Nombre del modelo invalidado que el agente debe usar para ejecutar el subproceso.
parallelToolCalls	Si true funciones se ejecutarán en paralelo durante el uso de la herramienta.
responseFormat	Especifica el formato que debe generar el modelo.
stream	Si true, devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un data: [DONE] mensaje.
temperature	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista.
toolChoice	Controla si el modelo llama a la herramienta o no.
toolResources	Los recursos de herramienta habilitados invalidados que el agente debe utilizar para ejecutar el subproceso.
tools	Lista invalidada de herramientas habilitadas que el agente debe usar para ejecutar el subproceso.
topP	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o la temperatura, pero no ambos.
truncationStrategy	Estrategia que se va a usar para quitar mensajes a medida que avanzan las ventanas de contexto.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
onResponse	Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
pollingOptions	Opciones para configurar el comportamiento de sondeo.
requestOptions	Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
tracingOptions	Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

additionalInstructions

Instrucciones adicionales para anexar al final de las instrucciones para la ejecución. Esto resulta útil para modificar el comportamiento por ejecución sin invalidar otras instrucciones.

additionalInstructions?: null | string

Valor de propiedad

null | string

additionalMessages

Agrega mensajes adicionales al subproceso antes de crear la ejecución.

additionalMessages?: null | ThreadMessageOptions[]

Valor de propiedad

null | ThreadMessageOptions[]

include

Lista de campos adicionales que se van a incluir en la respuesta. Actualmente, el único valor admitido es step_details.tool_calls[*].file_search.results[*].content capturar el contenido del resultado de la búsqueda de archivos.

include?: "step_details.tool_calls[*].file_search.results[*].content"[]

Valor de propiedad

"step_details.tool_calls[].file_search.results[].content"[]

instructions

Las instrucciones del sistema invalidados que el agente debe usar para ejecutar el subproceso.

instructions?: null | string

Valor de propiedad

null | string

maxCompletionTokens

Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado incomplete. Consulta incomplete_details para obtener más información.

maxCompletionTokens?: null | number

Valor de propiedad

null | number

maxPromptTokens

Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado incomplete. Consulta incomplete_details para obtener más información.

maxPromptTokens?: null | number

Valor de propiedad

null | number

metadata

Un conjunto de hasta 16 pares clave-valor que se pueden adjuntar a un objeto, que se usan para almacenar información adicional sobre ese objeto en un formato estructurado. Las claves pueden tener hasta 64 caracteres de longitud y los valores pueden tener hasta 512 caracteres de longitud.

metadata?: null | Record<string, string>

Valor de propiedad

null | Record<string, string>

model

Nombre del modelo invalidado que el agente debe usar para ejecutar el subproceso.

model?: null | string

Valor de propiedad

null | string

parallelToolCalls

Si true funciones se ejecutarán en paralelo durante el uso de la herramienta.

parallelToolCalls?: boolean

Valor de propiedad

boolean

responseFormat

Especifica el formato que debe generar el modelo.

responseFormat?: null | AgentsResponseFormatOption

Valor de propiedad

null | AgentsResponseFormatOption

stream

Si true, devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un data: [DONE] mensaje.

stream?: boolean

Valor de propiedad

boolean

temperature

Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista.

temperature?: null | number

Valor de propiedad

null | number

toolChoice

Controla si el modelo llama a la herramienta o no.

toolChoice?: null | AgentsToolChoiceOption

Valor de propiedad

null | AgentsToolChoiceOption

toolResources

Los recursos de herramienta habilitados invalidados que el agente debe utilizar para ejecutar el subproceso.

toolResources?: null | ToolResources

Valor de propiedad

null | ToolResources

tools

Lista invalidada de herramientas habilitadas que el agente debe usar para ejecutar el subproceso.

tools?: null | ToolDefinitionUnion[]

Valor de propiedad

null | ToolDefinitionUnion[]

topP

Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior.

Por lo general, recomendamos modificar esto o la temperatura, pero no ambos.

topP?: null | number

Valor de propiedad

null | number

truncationStrategy

Estrategia que se va a usar para quitar mensajes a medida que avanzan las ventanas de contexto.

truncationStrategy?: null | TruncationObject

Valor de propiedad

null | TruncationObject

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de Opciones de operación.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

Heredado de OperationOptions.onResponse

pollingOptions

Opciones para configurar el comportamiento de sondeo.

pollingOptions?: PollingOptions

Valor de propiedad

PollingOptions

Heredado dePollingOptionsParams.pollingOptions

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado de OperationOptions.tracingOptions