最新バージョン
AIエージェントのリストを取得
APIバージョン 2024.0
指定されたパラメータに基づいてAIエージェントのリストを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string arrayクエリ内省略可能
enabled返されるエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。
string arrayクエリ内省略可能
ask,text_gen,extractレスポンスで返されるフィールド。
booleanクエリ内省略可能
truefalseレスポンスにBoxのデフォルトエージェントを含めるかどうか。
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。
string arrayクエリ内省略可能
ask,text_gen,extract返されるエージェント構成にフィルタをかけるためのモード。使用可能な値はask、text_gen、extractです。
レスポンス
application/jsonAIエージェントのリスト
エージェントのリストを含む成功したレスポンス。
application/jsonクライアントエラー
予期しないクライアントエラー。
application/jsonクライアントエラー
予期しないサーバーエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.aiStudio.getAiAgents();Python v10
client.ai_studio.get_ai_agents().NET v10
await client.AiStudio.GetAiAgentsAsync();Swift v10
try await client.aiStudio.getAiAgents()Java v10
client.getAiStudio().getAiAgents()レスポンスの例
{
"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_image": {
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"type": "ai_agent_ask"
},
"extract": {
"access_state": "enabled",
"basic_image": {
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"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,
"warnings": [
"MODEL_INACTIVE"
]
},
"custom_instructions": "This is a custom instruction",
"description": "This is ASK Agent",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"type": "ai_agent_text_gen"
}
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}