Box Developer Documentation
 

    Get default AI agent configuration

    Guides Box AI AI model overrides Get default AI agent configuration
    Edit this page

    Get default AI agent configuration

    The GET /2.0/ai_agent_default endpoint allows you to fetch the default configuration for AI services. Once you get the configuration details you can override them using the ai_agent parameter.

    Send a request

    To send a request, use the GET /2.0/ai_agent_default endpoint.

    Make sure you have generated the developer token to authorize your app. See getting started with Box AI for details.

    cURL
    curl -L GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
         -H 'Authorization: Bearer <ACCESS_TOKEN>'

    Parameters

    To make a call, you must pass the following parameters. Mandatory parameters are in bold.

    ParameterDescriptionExample
    languageThe language code the agent configuration is returned for. If the language is not supported, the default configuration is returned.ja-JP
    modeThe mode used to filter the agent configuration. The value can be ask, text_gen, extract, or extract_structured depending on the result you want to achieve.ask
    modelThe model you want to get the configuration for. To make sure your chosen model is supported, see the list of models.azure__openai__gpt_4o_mini

    Responses

    The responses to the call may vary depending on the mode parameter value you choose.

    Ask

    When you set the mode parameter to ask the response will be as follows:

    {
         "type": "ai_agent_ask",
         "basic_text": {
              "model": "azure__openai__gpt_4o_mini",
              "system_message": "",
              "prompt_template": "prompt_template": "{user_question}Write it in an informal way.{content}"
            },
              "num_tokens_for_completion": 6000,
              "llm_endpoint_params": {
                   "temperature": 0,
                   "top_p": 1,
                   "frequency_penalty": 0,
                   "presence_penalty": 1.5,
                   "stop": "<|im_end|>",
                   "type": "openai_params"
              }
         },
         "long_text": {
              "model": "azure__openai__gpt_4o_mini",
              "system_message": "",
              "prompt_template": "prompt_template": "{user_question}Write it in an informal way.{content}"
            },
              "num_tokens_for_completion": 6000,
              "llm_endpoint_params": {
                   "temperature": 0,
                   "top_p": 1,
                   "frequency_penalty": 0,
                   "presence_penalty": 1.5,
                   "stop": "<|im_end|>",
                   "type": "openai_params"
              },
              "embeddings": {
                   "model": "azure__openai__text_embedding_ada_002",
                   "strategy": {
                        "id": "basic",
                        "num_tokens_per_chunk": 64
                   }
              }
         },
         "basic_text_multi": {
              "model": "azure__openai__gpt_4o_mini",
              "system_message": "",
              "prompt_template": "Current date: {current_date}\n\nTEXT FROM DOCUMENTS STARTS\n{content}\nTEXT FROM DOCUMENTS ENDS\n\nHere is how I need help from you: {user_question}\n.",
              "num_tokens_for_completion": 6000,
              "llm_endpoint_params": {
                   "temperature": 0,
                   "top_p": 1,
                   "frequency_penalty": 0,
                   "presence_penalty": 1.5,
                   "stop": "<|im_end|>",
                   "type": "openai_params"
              }
         },
         "long_text_multi": {
              "model": "azure__openai__gpt_4o_mini",
              "system_message": "Role and Goal: You are an assistant designed to analyze and answer a question based on provided snippets from multiple documents, which can include business-oriented documents like docs, presentations, PDFs, etc. The assistant will respond concisely, using only the information from the provided documents.\n\nConstraints: The assistant should avoid engaging in chatty or extensive conversational interactions and focus on providing direct answers. It should also avoid making assumptions or inferences not supported by the provided document snippets.\n\nGuidelines: When answering, the assistant should consider the file's name and path to assess relevance to the question. In cases of conflicting information from multiple documents, it should list the different answers with citations. For summarization or comparison tasks, it should concisely answer with the key points. It should also consider the current date to be the date given.\n\nPersonalization: The assistant's tone should be formal and to-the-point, suitable for handling business-related documents and queries.\n",
              "prompt_template": "Current date: {current_date}\n\nTEXT FROM DOCUMENTS STARTS\n{content}\nTEXT FROM DOCUMENTS ENDS\n\nHere is how I need help from you: {user_question}\n.",
              "num_tokens_for_completion": 6000,
              "llm_endpoint_params": {
                   "temperature": 0,
                   "top_p": 1,
                   "frequency_penalty": 0,
                   "presence_penalty": 1.5,
                   "stop": "<|im_end|>",
                   "type": "openai_params"
              },
              "embeddings": {
                   "model": "azure__openai__text_embedding_ada_002",
                   "strategy": {
                        "id": "basic",
                        "num_tokens_per_chunk": 64
                   }
              }
         }
    }