Struttura dell'oggetto endpoint Assistants

Questa pagina si applica sia agli endpoint assistants che azureAssistants.

Nota: Per abilitare azureAssistants, consulta la Configurazione di Azure OpenAI per ulteriori informazioni.

Esempio

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"]

Questa configurazione abilita l'interfaccia di creazione per gli assistenti, imposta un intervallo di polling di 500ms per verificare gli aggiornamenti dell'esecuzione e stabilisce un timeout di 10 secondi per le operazioni di esecuzione dell'assistente.

disableBuilder

Chiave:

Key	Type	Description	Example
disableBuilder	Boolean	Controlla la visibilità e l'utilizzo dell'interfaccia builder per gli assistenti.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Predefinito: false

Esempio:

disableBuilder: false

pollIntervalMs

Chiave:

Key	Type	Description	Example
pollIntervalMs	Integer	Specifica l'intervallo di polling in millisecondi per il controllo degli aggiornamenti dell'esecuzione o delle modifiche negli stati di esecuzione dell'assistente.	Specifies the polling interval in milliseconds for checking assistant run updates.

Predefinito: 2000

Esempio:

pollIntervalMs: 2500

Nota: Attualmente, questo viene utilizzato solo dagli Azure Assistants. Si consigliano valori più alti per gli Azure Assistants per evitare errori di limitazione della frequenza (rate limiting).

timeoutMs

Chiave:

Key	Type	Description	Example
timeoutMs	Integer	Definisce il tempo massimo in millisecondi durante il quale un assistente può essere eseguito prima che la richiesta venga annullata.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Predefinito: 180000

Esempio:

timeoutMs: 10000

Nota: Il valore predefinito è 3 minuti (180.000 ms). I tempi di esecuzione dell'operazione possono variare da 50 secondi a 2 minuti, ma possono anche superarli. Se il valore timeoutMs viene superato, l'esecuzione verrà annullata.

supportedIds

Chiave:

Key	Type	Description	Example
supportedIds	Array/List of Strings	Elenco degli ID assistente supportati	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Esempio:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Chiave:

Key	Type	Description	Example
excludedIds	Array/List of Strings	Elenco degli ID assistente esclusi	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Esempio:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Chiave:

Key	Type	Description	Example
privateAssistants	Boolean	Controlla se gli assistenti sono privati per l'utente che li ha creati	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Predefinito: false

Esempio:

privateAssistants: false

retrievalModels

Chiave:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Specifica i modelli che supportano il recupero per l'endpoint 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.

Predefinito: [] (utilizza gli ultimi modelli OpenAI noti che supportano il retrieval)

Esempio:

retrievalModels:
  - "gpt-4-turbo-preview"

capabilities

Chiave:

Key	Type	Description	Example
capabilities	Array/List of Strings	Specifica le funzionalità dell'assistente disponibili per tutti gli utenti per l'endpoint 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.

Predefinito: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

Esempio:

capabilities:
  - "code_interpreter"
  - "retrieval"
  - "actions"
  - "tools"
  - "image_vision"

Nota: Questo campo è facoltativo. Se omesso, il comportamento predefinito consiste nell'includere tutte le funzionalità elencate nell'esempio.

Struttura dell'oggetto endpoint Assistants

In questa pagina