Estructura del objeto del endpoint Assistants
Esta página se aplica tanto a los endpoints assistants como a azureAssistants.
Nota: Para habilitar azureAssistants, consulte la Configuración de Azure OpenAI para obtener más información.
Ejemplo
endpoints:
# azureAssistants: # <-- Azure-specific configuration has the same structure as `assistants`
# pollIntervalMs: 500
# timeoutMs: 10000
assistants:
disableBuilder: false
# Use either `supportedIds` or `excludedIds` but not both
supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]
# excludedIds: ["asst_excludedAssistantId"]
# `privateAssistants` do not work with `supportedIds` or `excludedIds`
# privateAssistants: false
# (optional) Models that support retrieval, will default to latest known OpenAI models that support the feature
# retrievalModels: ["gpt-4-turbo-preview"]
# (optional) Assistant Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
# capabilities: ["code_interpreter", "retrieval", "actions", "tools", "image_vision"]Esta configuración habilita la interfaz del constructor para asistentes, establece un intervalo de sondeo de 500ms para verificar actualizaciones de ejecución y establece un tiempo de espera de 10 segundos para las operaciones de ejecución del asistente.
disableBuilder
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| disableBuilder | Boolean | Controla la visibilidad y el uso de la interfaz del constructor para asistentes. | When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction. |
Predeterminado: false
Ejemplo:
disableBuilder: falsepollIntervalMs
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| pollIntervalMs | Integer | Especifica el intervalo de sondeo en milisegundos para verificar actualizaciones de ejecución o cambios en los estados de ejecución del asistente. | Specifies the polling interval in milliseconds for checking assistant run updates. |
Predeterminado: 2000
Ejemplo:
pollIntervalMs: 2500Nota: Actualmente, esto solo es utilizado por Azure Assistants. Se recomiendan valores más altos para Azure Assistants para evitar errores de limitación de tasa (rate limiting).
timeoutMs
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| timeoutMs | Integer | Define el tiempo máximo en milisegundos que un asistente puede ejecutarse antes de que se cancele la solicitud. | Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time. |
Predeterminado: 180000
Ejemplo:
timeoutMs: 10000Nota: El valor predeterminado es de 3 minutos (180,000 ms). Los tiempos de ejecución de la operación pueden variar entre 50 segundos y 2 minutos, pero también pueden exceder este tiempo. Si se supera el valor de timeoutMs, la ejecución se cancelará.
supportedIds
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| supportedIds | Array/List of Strings | Lista de Ids de asistentes compatibles | Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so). |
Ejemplo:
supportedIds:
- "asst_supportedAssistantId1"
- "asst_supportedAssistantId2"excludedIds
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| excludedIds | Array/List of Strings | Lista de IDs de asistente excluidos | Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so). |
Ejemplo:
excludedIds:
- "asst_excludedAssistantId1"
- "asst_excludedAssistantId2"privateAssistants
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| privateAssistants | Boolean | Controla si los asistentes son privados para el usuario que los creó | Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored). |
Predeterminado: false
Ejemplo:
privateAssistants: falseretrievalModels
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| retrievalModels | Array/List of Strings | Especifica los modelos que admiten la recuperación para el endpoint de assistants. | Defines the models that support retrieval capabilities for the assistants endpoint. By default, it uses the latest known OpenAI models that support the official Retrieval feature. |
Predeterminado: [] (utiliza los últimos modelos de OpenAI conocidos que admiten recuperación)
Ejemplo:
retrievalModels:
- "gpt-4-turbo-preview"capabilities
Clave:
| Key | Type | Description | Example |
|---|---|---|---|
| capabilities | Array/List of Strings | Especifica las capacidades del asistente disponibles para todos los usuarios para el endpoint de assistants. | Defines the assistant capabilities that are available to all users for the assistants endpoint. You can omit the capabilities you wish to exclude from the list. |
Predeterminado: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]
Ejemplo:
capabilities:
- "code_interpreter"
- "retrieval"
- "actions"
- "tools"
- "image_vision"Nota: Este campo es opcional. Si se omite, el comportamiento predeterminado es incluir todas las capacidades enumeradas en el ejemplo.
¿Qué te parece esta guÃa?