Struktura obiektu endpointu Assistants

Ta strona dotyczy zarówno endpointów assistants, jak i azureAssistants.

Uwaga: Aby włączyć azureAssistants, zobacz Konfiguracja Azure OpenAI, aby uzyskać więcej informacji.

Przykład

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

Ta konfiguracja włącza interfejs kreatora dla asystentów, ustawia interwał odpytywania na 500ms w celu sprawdzania aktualizacji uruchomień oraz ustala limit czasu 10 sekund dla operacji uruchamiania asystenta.

disableBuilder

Klucz:

Key	Type	Description	Example
disableBuilder	Boolean	Kontroluje widoczność i użycie interfejsu kreatora dla asystentów.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Domyślnie: false

Przykład:

disableBuilder: false

pollIntervalMs

Klucz:

Key	Type	Description	Example
pollIntervalMs	Integer	Określa interwał odpytywania w milisekundach w celu sprawdzania aktualizacji uruchomień lub zmian w stanach uruchomienia asystenta.	Specifies the polling interval in milliseconds for checking assistant run updates.

Domyślnie: 2000

Przykład:

pollIntervalMs: 2500

Uwaga: Obecnie jest to używane tylko przez Azure Assistants. Zaleca się stosowanie wyższych wartości dla Azure Assistants, aby uniknąć błędów związanych z limitami szybkości (rate limiting).

timeoutMs

Klucz:

Key	Type	Description	Example
timeoutMs	Integer	Określa maksymalny czas w milisekundach, przez jaki asystent może działać, zanim żądanie zostanie anulowane.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Domyślnie: 180000

Przykład:

timeoutMs: 10000

Uwaga: Domyślnie ustawione na 3 minuty (180 000 ms). Czas wykonywania operacji może wynosić od 50 sekund do 2 minut, ale może również przekroczyć ten czas. Jeśli wartość timeoutMs zostanie przekroczona, uruchomienie zostanie anulowane.

supportedIds

Klucz:

Key	Type	Description	Example
supportedIds	Array/List of Strings	Lista obsługiwanych identyfikatorów asystentów	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Przykład:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Klucz:

Key	Type	Description	Example
excludedIds	Array/List of Strings	Lista wykluczonych identyfikatorów asystentów	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Przykład:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Klucz:

Key	Type	Description	Example
privateAssistants	Boolean	Określa, czy asystenci są prywatni dla użytkownika, który ich utworzył	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Domyślnie: false

Przykład:

privateAssistants: false

retrievalModels

Klucz:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Określa modele, które obsługują wyszukiwanie dla endpointu 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.

Domyślnie: [] (używa najnowszych znanych modeli OpenAI, które obsługują wyszukiwanie)

Przykład:

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

capabilities

Klucz:

Key	Type	Description	Example
capabilities	Array/List of Strings	Określa możliwości asystenta dostępne dla wszystkich użytkowników dla endpointu 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.

Domyślnie: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

Przykład:

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

Uwaga: To pole jest opcjonalne. Jeśli zostanie pominięte, domyślnym zachowaniem jest uwzględnienie wszystkich możliwości wymienionych w przykładzie.

Struktura obiektu endpointu Assistants

Na tej stronie