Box Developer Documentation
Log in

AI agent capability text generation 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 generate text.

string
ai_agent_text_gen

The type of AI agent used for generating text.

Value is always ai_agent_text_gen

string
enabled

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

object

AI agent basic tool used to generate text.

string
---{content}---

How the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

object
string
azure__openai__text_embedding_ada_002

The model used for the AI agent for calculating embeddings.

object
string
basic

The strategy used for the AI agent for calculating embeddings.

integer
64
1
512

The number of tokens per chunk.

boolean
false

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

AI LLM endpoint params AWS / AI LLM endpoint params Google / AI LLM endpoint params IBM / AI LLM endpoint params OpenAI object

The parameters for the LLM endpoint specific to a model.

string
azure__openai__gpt_4o_mini

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

integer
8400
1

The number of tokens for completion.

string
\{user_question\}
It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`
10000

The prompt template contains contextual information of the request and the user prompt.

When using the prompt_template parameter, you must include input for {user_question}. Inputs for {current_date} and {content} are optional, depending on the use.

string
You are a helpful travel assistant specialized in budget travel

System messages aim at helping the LLM understand its role and what it is supposed to do. The input for {current_date} is optional, depending on the use.

string
This is a custom instruction

Custom instructions for the AI agent.

string
This is ASK Agent

The description of the AI agent.

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_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"
  },
  "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?"
  ]
}