AIエージェント - Box Dev Docs

APIバージョン 2024.0 AIエージェントインスタンスのStandard版の表示。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string

例 1234567890AIエージェントの一意の識別子。

type

string

例 ai_agentクエリの処理に使用されるエージェントのタイプ。次の値に固定: ai_agent

access_state

string

例 enabledAIエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。

allowed_entities

タイプとIDが指定されたエンティティ[グループ (Base)/ユーザー (Base)]array

許可するユーザーまたはグループのリスト。

created_at

string(date-time)

例 2022-01-01T00:00:00ZこのAIエージェントが作成された時点のISO日時形式のタイムスタンプ。

created_by

ユーザー (Base)object

このエージェントを作成したユーザー。

icon_reference

string

例 https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svgAIエージェントのアイコン参照。

modified_at

string(date-time)

例 2022-01-01T00:00:00ZこのAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。

modified_by

ユーザー (Base)object

このエージェントを直近で変更したユーザー。

name

string

例 This is my AgentAIエージェントの名前。

origin

string

例 CUSTOMAIエージェントのプロバイダ。

{
  "id": "1234567890",
  "type": "ai_agent",
  "access_state": "enabled",
  "allowed_entities": [
    {
      "id": "11446498",
      "type": "user"
    }
  ],
  "created_at": "2022-01-01T00:00:00Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
  "modified_at": "2022-01-01T00:00:00Z",
  "modified_by": {
    "id": "11446498",
    "type": "user"
  },
  "name": "This is my Agent",
  "origin": "CUSTOM"
}