Structure de l'objet de l'endpoint Assistants

Cette page s'applique aux deux endpoints assistants et azureAssistants.

Remarque : Pour activer azureAssistants, consultez la Configuration Azure OpenAI pour plus d'informations.

Exemple

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

Cette configuration active l'interface de création pour les assistants, définit un intervalle d'interrogation de 500 ms pour vérifier les mises à jour d'exécution et établit un délai d'attente de 10 secondes pour les opérations d'exécution des assistants.

disableBuilder

Clé :

Key	Type	Description	Example
disableBuilder	Boolean	Contrôle la visibilité et l'utilisation de l'interface de création pour les assistants.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Par défaut : false

Exemple :

disableBuilder: false

pollIntervalMs

Clé :

Key	Type	Description	Example
pollIntervalMs	Integer	Spécifie l'intervalle d'interrogation en millisecondes pour vérifier les mises à jour d'exécution ou les changements dans les états d'exécution de l'assistant.	Specifies the polling interval in milliseconds for checking assistant run updates.

Par défaut : 2000

Exemple :

pollIntervalMs: 2500

Note : Actuellement, ceci est uniquement utilisé par les Azure Assistants. Des valeurs plus élevées sont recommandées pour les Azure Assistants afin d'éviter les erreurs de limitation de débit (rate limiting).

timeoutMs

Clé :

Key	Type	Description	Example
timeoutMs	Integer	Définit le temps maximum en millisecondes pendant lequel un assistant peut s'exécuter avant que la requête ne soit annulée.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Par défaut : 180000

Exemple :

timeoutMs: 10000

Remarque : La valeur par défaut est de 3 minutes (180 000 ms). Les temps d'exécution des opérations peuvent varier entre 50 secondes et 2 minutes, mais peuvent également dépasser cette durée. Si la valeur timeoutMs est dépassée, l'exécution sera annulée.

supportedIds

Clé :

Key	Type	Description	Example
supportedIds	Array/List of Strings	Liste des IDs d'assistants pris en charge	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Exemple :

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Clé :

Key	Type	Description	Example
excludedIds	Array/List of Strings	Liste des IDs d'assistants exclus	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Exemple :

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Clé :

Key	Type	Description	Example
privateAssistants	Boolean	Contrôle si les assistants sont privés pour l'utilisateur qui les a créés	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Par défaut : false

Exemple :

privateAssistants: false

retrievalModels

Clé :

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Spécifie les modèles qui prennent en charge la récupération pour 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.

Par défaut : [] (utilise les derniers modèles OpenAI connus qui prennent en charge la récupération)

Exemple :

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

capabilities

Clé :

Key	Type	Description	Example
capabilities	Array/List of Strings	Spécifie les capacités de l'assistant disponibles pour tous les utilisateurs pour le 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.

Par défaut : ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

Exemple :

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

Note : Ce champ est facultatif. S'il est omis, le comportement par défaut consiste à inclure toutes les capacités listées dans l'exemple.