Box Developer Documentation

AI agent capability ask request

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

The AI agent to be used to handle queries.

string
ai_agent_ask

The type of AI agent used to handle queries.

Value is always ai_agent_ask

enabled

The state of the AI Agent capability. Possible values are: enabled and disabled.

AI agent processor used to handle basic text.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

AI agent processor used to handle basic text.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

object

AI agent processor used to handle basic text.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

AI agent processor used to handle basic text.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

This is a custom instruction

Custom instructions for the AI agent.

This is ASK Agent

The description of the AI agent.

object

AI agent processor used to to handle longer text.

azure__openai__text_embedding_ada_002

The model used for the AI agent for calculating embeddings.

basic

The strategy used for the AI agent for calculating embeddings.

64
1
512

The number of tokens per chunk.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

AI agent processor used to to handle longer text.

azure__openai__text_embedding_ada_002

The model used for the AI agent for calculating embeddings.

basic

The strategy used for the AI agent for calculating embeddings.

64
1
512

The number of tokens per chunk.

false

True if system message contains custom instructions placeholder, false otherwise.

azure__openai__gpt_4o_mini

The model used for the AI agent for basic text. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

(\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.
10000

The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. {current_date} is optional, depending on the use.

You are a helpful travel assistant specialized in budget travel

System messages try to help the LLM "understand" its role and what it is supposed to do.

The AI agent tool used to handle spreadsheets and tabular data.

azure__openai__gpt_4o_mini

The model used for the AI agent for spreadsheets. For specific model values, see the available models list.

8400
1

The number of tokens for completion.

string array
["What is in this file?","What are the main highlights of this document?"]

Suggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed.

Response Example

{
  "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"
  },
  "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"
  },
  "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"
  },
  "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"
  },
  "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"
  },
  "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"
  },
  "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
  },
  "suggested_questions": [
    "What is in this file?",
    "What are the main highlights of this document?"
  ]
}