Struktur des Assistants Endpoint-Objekts

Diese Seite gilt sowohl für die assistants als auch für die azureAssistants endpoint.

Hinweis: Um azureAssistants zu aktivieren, siehe die Azure OpenAI Konfiguration für weitere Informationen.

Beispiel

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

Diese Konfiguration aktiviert die Builder-Schnittstelle für Assistants, legt ein Abfrageintervall von 500ms für die Überprüfung auf Run-Updates fest und setzt ein Timeout von 10 Sekunden für Assistant-Run-Operationen.

disableBuilder

Schlüssel:

Key	Type	Description	Example
disableBuilder	Boolean	Steuert die Sichtbarkeit und Nutzung der Builder-Oberfläche für Assistants.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Standard: false

Beispiel:

disableBuilder: false

pollIntervalMs

Schlüssel:

Key	Type	Description	Example
pollIntervalMs	Integer	Gibt das Abfrageintervall in Millisekunden an, um nach Aktualisierungen von Ausführungen oder Änderungen in den Status von Assistant-Ausführungen zu suchen.	Specifies the polling interval in milliseconds for checking assistant run updates.

Standard: 2000

Beispiel:

pollIntervalMs: 2500

Hinweis: Derzeit wird dies nur von Azure Assistants verwendet. Höhere Werte werden für Azure Assistants empfohlen, um Fehler durch Ratenbegrenzungen (Rate Limiting) zu vermeiden.

timeoutMs

Schlüssel:

Key	Type	Description	Example
timeoutMs	Integer	Definiert die maximale Zeit in Millisekunden, die ein Assistant laufen kann, bevor die Anfrage abgebrochen wird.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Standard: 180000

Beispiel:

timeoutMs: 10000

Hinweis: Der Standardwert beträgt 3 Minuten (180.000 ms). Die Laufzeiten von Operationen können zwischen 50 Sekunden und 2 Minuten liegen, aber auch darüber hinausgehen. Wenn der Wert timeoutMs überschritten wird, wird der Vorgang abgebrochen.

supportedIds

Schlüssel:

Key	Type	Description	Example
supportedIds	Array/List of Strings	Liste der unterstützten Assistant Ids	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Beispiel:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Schlüssel:

Key	Type	Description	Example
excludedIds	Array/List of Strings	Liste der ausgeschlossenen Assistant-IDs	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Beispiel:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Schlüssel:

Key	Type	Description	Example
privateAssistants	Boolean	Steuert, ob Assistants für den Benutzer, der sie erstellt hat, privat sind	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Standard: false

Beispiel:

privateAssistants: false

retrievalModels

Schlüssel:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Gibt die Modelle an, die Retrieval für den assistants endpoint unterstützen.	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.

Standard: [] (verwendet die neuesten bekannten OpenAI-Modelle, die Retrieval unterstützen)

Beispiel:

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

capabilities

Schlüssel:

Key	Type	Description	Example
capabilities	Array/List of Strings	Legt die Assistant-Funktionen fest, die allen Benutzern für den assistants endpoint zur Verfügung stehen.	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.

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

Beispiel:

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

Hinweis: Dieses Feld ist optional. Wenn es weggelassen wird, besteht das Standardverhalten darin, alle im Beispiel aufgeführten Funktionen einzubeziehen.