Struktur Objek endpoint Assistants

Halaman ini berlaku untuk endpoint assistants maupun azureAssistants.

Catatan: Untuk mengaktifkan azureAssistants, lihat Konfigurasi Azure OpenAI untuk informasi lebih lanjut.

Contoh

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

Konfigurasi ini mengaktifkan antarmuka pembuat (builder interface) untuk asisten, menetapkan interval polling sebesar 500ms untuk memeriksa pembaruan proses (run updates), dan menetapkan batas waktu (timeout) selama 10 detik untuk operasi proses asisten.

disableBuilder

Kunci:

Key	Type	Description	Example
disableBuilder	Boolean	Mengontrol visibilitas dan penggunaan antarmuka pembuat untuk asisten.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Default: false

Contoh:

disableBuilder: false

pollIntervalMs

Kunci:

Key	Type	Description	Example
pollIntervalMs	Integer	Menentukan interval polling dalam milidetik untuk memeriksa pembaruan run atau perubahan pada status run assistant.	Specifies the polling interval in milliseconds for checking assistant run updates.

Default: 2000

Contoh:

pollIntervalMs: 2500

Catatan: Saat ini, ini hanya digunakan oleh Azure Assistants. Nilai yang lebih tinggi direkomendasikan untuk Azure Assistants guna menghindari kesalahan pembatasan kecepatan (rate limiting).

timeoutMs

Kunci:

Key	Type	Description	Example
timeoutMs	Integer	Menentukan waktu maksimum dalam milidetik yang dapat dijalankan oleh asisten sebelum permintaan dibatalkan.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Default: 180000

Contoh:

timeoutMs: 10000

Catatan: Standarnya adalah 3 menit (180.000 ms). Waktu operasi berjalan dapat berkisar antara 50 detik hingga 2 menit tetapi juga bisa melebihi durasi tersebut. Jika nilai timeoutMs terlampaui, proses berjalan akan dibatalkan.

supportedIds

Kunci:

Key	Type	Description	Example
supportedIds	Array/List of Strings	Daftar ID asisten yang didukung	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Contoh:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Kunci:

Key	Type	Description	Example
excludedIds	Array/List of Strings	Daftar ID asisten yang dikecualikan	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Contoh:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Kunci:

Key	Type	Description	Example
privateAssistants	Boolean	Mengontrol apakah asisten bersifat pribadi bagi pengguna yang membuatnya	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Default: false

Contoh:

privateAssistants: false

retrievalModels

Kunci:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	Menentukan model yang mendukung pengambilan (retrieval) untuk 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.

Default: [] (menggunakan model OpenAI terbaru yang diketahui yang mendukung retrieval)

Contoh:

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

capabilities

Kunci:

Key	Type	Description	Example
capabilities	Array/List of Strings	Menentukan kapabilitas asisten yang tersedia bagi semua pengguna untuk 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.

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

Contoh:

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

Catatan: Bidang ini bersifat opsional. Jika diabaikan, perilaku default-nya adalah menyertakan semua kapabilitas yang tercantum dalam contoh.

Struktur Objek endpoint Assistants

Di halaman ini