Box Developerドキュメント
最新バージョン

AIエージェントのリストを取得

get
https://api.box.com/2.0
/ai_agents

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

指定されたパラメータに基づいてAIエージェントのリストを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

string arrayクエリ内省略可能
enabled

返されるエージェントの状態。使用可能な値はenableddisabledenabled_for_selected_usersです。

string arrayクエリ内省略可能
ask,text_gen,extract

レスポンスで返されるフィールド。

booleanクエリ内省略可能
true
false

レスポンスにBoxのデフォルトのエージェントを含めるかどうか。

integer (int64)クエリ内省略可能
1000
1000

返す項目の1ページあたりの最大数。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。

string arrayクエリ内省略可能
ask,text_gen,extract

返されるエージェント構成にフィルタをかけるためのモード。使用可能な値はasktext_genextractです。

レスポンス

エージェントのリストを含む成功したレスポンス。

予期しないクライアントエラー。

予期しないサーバーエラー。

get
AIエージェントのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.aiStudio.getAiAgents();
Python Gen
client.ai_studio.get_ai_agents()
.NET Gen
await client.AiStudio.GetAiAgentsAsync();

レスポンスの例

{
  "entries": [
    {
      "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",
      "id": "1234567890",
      "modified_at": "2022-01-01T00:00:00Z",
      "modified_by": {
        "id": "11446498",
        "type": "user"
      },
      "name": "This is my Agent",
      "origin": "CUSTOM",
      "type": "ai_agent",
      "ask": {
        "access_state": "enabled",
        "basic_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false
        },
        "basic_text_multi": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "long_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false
        },
        "long_text_multi": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false
        },
        "type": "ai_agent_ask"
      },
      "extract": {
        "access_state": "enabled",
        "basic_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "long_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false
        },
        "type": "ai_agent_extract"
      },
      "text_gen": {
        "access_state": "enabled",
        "basic_gen": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "content_template": "---{content}---",
          "is_custom_instructions_included": false
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "type": "ai_agent_text_gen"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}