Structuur van het Assistants endpoint-object

Deze pagina is van toepassing op zowel de assistants als de azureAssistants endpoint.

Let op: Om azureAssistants in te schakelen, zie de Azure OpenAI Configuration voor meer informatie.

Voorbeeld

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

Deze configuratie schakelt de builder-interface voor assistants in, stelt een polling-interval van 500ms in om te controleren op run-updates, en stelt een time-out van 10 seconden in voor assistant run-operaties.

disableBuilder

Sleutel:

Key	Type	Description	Example
disableBuilder	Boolean	Beheert de zichtbaarheid en het gebruik van de builder-interface voor assistants.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Standaard: false

Voorbeeld:

disableBuilder: false

pollIntervalMs

Sleutel:

Key	Type	Description	Example
pollIntervalMs	Integer	Specificeert het polling-interval in milliseconden voor het controleren van run-updates of wijzigingen in de status van assistant-runs.	Specifies the polling interval in milliseconds for checking assistant run updates.

Standaard: 2000

Voorbeeld:

pollIntervalMs: 2500

Let op: Momenteel wordt dit alleen gebruikt door Azure Assistants. Hogere waarden worden aanbevolen voor Azure Assistants om fouten door rate limiting te voorkomen.

timeoutMs

Sleutel:

Key	Type	Description	Example
timeoutMs	Integer	Definieert de maximale tijd in milliseconden die een assistant kan draaien voordat het verzoek wordt geannuleerd.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Standaard: 180000

Voorbeeld:

timeoutMs: 10000

Let op: De standaardwaarde is 3 minuten (180.000 ms). De uitvoeringstijden kunnen variëren tussen 50 seconden en 2 minuten, maar kunnen dit ook overschrijden. Als de timeoutMs waarde wordt overschreden, wordt de uitvoering geannuleerd.

supportedIds

Sleutel:

Key	Type	Description	Example
supportedIds	Array/List of Strings	Lijst met ondersteunde assistant Ids	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Voorbeeld:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Sleutel:

Key	Type	Description	Example
excludedIds	Array/List of Strings	Lijst met uitgesloten assistant Ids	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Voorbeeld:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Sleutel:

Key	Type	Description	Example
privateAssistants	Boolean	Bepaalt of assistants privé zijn voor de gebruiker die ze heeft aangemaakt	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Standaard: false

Voorbeeld:

privateAssistants: false

retrievalModels

Sleutel:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Specificeert de modellen die retrieval ondersteunen voor het assistants endpoint.	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.

Standaard: [] (gebruikt de laatst bekende OpenAI-modellen die retrieval ondersteunen)

Voorbeeld:

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

capabilities

Sleutel:

Key	Type	Description	Example
capabilities	Array/List of Strings	Specificeert de assistent-mogelijkheden die beschikbaar zijn voor alle gebruikers voor het assistants endpoint.	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.

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

Voorbeeld:

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

Let op: Dit veld is optioneel. Indien weggelaten, is het standaardgedrag om alle mogelijkheden op te nemen die in het voorbeeld worden vermeld.

Structuur van het Assistants endpoint-object

Op deze pagina