Updates an AI agent.
1234
The ID of the agent to update.
"ai_agent"
The type of agent used to handle queries.
Value is always ai_agent
"enabled"
The state of the AI Agent. Possible values are: enabled
, disabled
, and enabled_for_selected_users
.
List of allowed users or groups.
The AI agent to be used to handle queries.
The AI agent to be used for metadata extraction.
"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"
The icon reference of the AI Agent. It should have format of the URL https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>
where possible values of file_name
are: logo_boxAi.png
,logo_stamp.png
,logo_legal.png
,logo_finance.png
,logo_config.png
,logo_handshake.png
,logo_analytics.png
,logo_classification.png
.
"My AI Agent"
The name of the AI Agent.
The AI agent to be used to generate text.
Definition of created AI agent.
An unexpected client error.
An unexpected server error.
curl -i -X PUT "https://api.box.com/2.0/ai_agents/1234567890" \
-H "authorization: Bearer <ACCESS_TOKEN>"
await client.aiStudio.updateAiAgentById(createdAgent.id, {
name: agentName,
accessState: 'enabled',
ask: new AiStudioAgentAsk({ accessState: 'disabled', description: 'desc2' }),
} satisfies CreateAiAgentInput);
client.ai_studio.update_ai_agent_by_id(
created_agent.id,
agent_name,
"enabled",
ask=AiStudioAgentAsk(access_state="disabled", description="desc2"),
)
await client.AiStudio.UpdateAiAgentByIdAsync(agentId: createdAgent.Id, requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "disabled", description: "desc2") });
try await client.aiStudio.updateAiAgentById(agentId: createdAgent.id, requestBody: CreateAiAgent(name: agentName, accessState: "enabled", ask: AiStudioAgentAsk(accessState: "disabled", description: "desc2")))
client.getAiStudio().updateAiAgentById(createdAgent.getId(), new CreateAiAgent.Builder(agentName, "enabled").ask(new AiStudioAgentAsk("disabled", "desc2")).build())
{
"id": "1234567890",
"type": "ai_agent",
"access_state": "enabled",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"basic_image": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"custom_instructions": "This is a custom instruction",
"description": "This is ASK Agent",
"long_text": {
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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?"
]
},
"created_at": "2022-01-01T00:00:00Z",
"created_by": {
"id": "11446498",
"type": "user"
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"basic_image": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
},
"custom_instructions": "This is a custom instruction",
"description": "This is ASK Agent",
"long_text": {
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"warnings": [
"MODEL_INACTIVE"
]
}
},
"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",
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"basic_gen": {
"content_template": "---{content}---",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"llm_endpoint_params": {
"type": "openai_params",
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>",
"temperature": 0,
"top_p": 1
},
"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",
"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?"
]
}
}