Assistantsエンドポイントのオブジェクト構造

このページは、assistants および azureAssistants の両方の endpoint に適用されます。

注: azureAssistants を有効にするには、詳細について Azure OpenAI Configuration を参照してください。

例

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

この設定により、アシスタントのビルダーインターフェースが有効になり、実行の更新を確認するためのポーリング間隔が500msに設定され、アシスタントの実行操作に対するタイムアウトが10秒に設定されます。

disableBuilder

キー:

Key	Type	Description	Example
disableBuilder	Boolean	アシスタントのビルダーインターフェースの表示と使用を制御します。	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

デフォルト: false

例:

disableBuilder: false

pollIntervalMs

キー:

Key	Type	Description	Example
pollIntervalMs	Integer	アシスタントの実行状態の更新や変更を確認するためのポーリング間隔をミリ秒単位で指定します。	Specifies the polling interval in milliseconds for checking assistant run updates.

デフォルト: 2000

例:

pollIntervalMs: 2500

注: 現在、これは Azure Assistants によってのみ使用されています。レート制限エラーを回避するため、Azure Assistants にはより高い値を設定することを推奨します。

timeoutMs

キー:

Key	Type	Description	Example
timeoutMs	Integer	アシスタントが実行を継続できる最大時間をミリ秒単位で定義します。これを超えるとリクエストはキャンセルされます。	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

デフォルト: 180000

例:

timeoutMs: 10000

注: デフォルトは3分（180,000ミリ秒）です。実行操作時間は50秒から2分の間になることが多いですが、これを超える場合もあります。timeoutMsの値を超えると、実行はキャンセルされます。

supportedIds

キー:

Key	Type	Description	Example
supportedIds	Array/List of Strings	サポートされているアシスタントIDのリスト	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

例:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

キー:

Key	Type	Description	Example
excludedIds	Array/List of Strings	除外するアシスタントIDのリスト	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

例:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

キー:

Key	Type	Description	Example
privateAssistants	Boolean	アシスタントを作成したユーザーのみに非公開にするかどうかを制御します	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

デフォルト: false

例:

privateAssistants: false

retrievalModels

キー:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	assistants endpointの検索（retrieval）をサポートするモデルを指定します。	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.

デフォルト: [] (検索をサポートする最新の既知のOpenAIモデルを使用します)

例:

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

capabilities

キー:

Key	Type	Description	Example
capabilities	Array/List of Strings	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.

デフォルト: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

例:

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

注: このフィールドは任意です。省略した場合、デフォルトの動作として例に記載されているすべての機能が含まれます。

Assistantsエンドポイントのオブジェクト構造

このページの内容