Box Developer Documentation
Log in

AI response (Full)

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

AI ask response.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

object

The information on the models and processors used in the request.

object array

The models used for the request.

string
azure__openai__text_embedding_ada_002

The name of the model used for the request.

string
azure

The provider that owns the model used for the request.

string
embedding

The supported purpose utilized by the model used for the request.

string
basic_text

The processor used for the request.

string
Public APIs are important because of key and important reasons.

The answer provided by the LLM.

object array

The citations of the LLM's answer reference.

string
123

The id of the item.

string
file

The type of the item.

Value is always file

string
Public APIs are key drivers of innovation and growth.

The specific content from where the answer was referenced.

string
The importance of public APIs.pdf

The name of the item.

string
done

The reason the response finishes.

string (date-time)
2012-12-12T10:53:43-08:00

The ISO date formatted timestamp of when the answer to the prompt was created.

Response Example

{
  "ai_agent_info": {
    "models": [
      {
        "name": "azure__openai__text_embedding_ada_002",
        "provider": "azure",
        "supported_purpose": "embedding"
      }
    ],
    "processor": "basic_text"
  },
  "answer": "Public APIs are important because of key and important reasons.",
  "citations": [
    {
      "content": "Public APIs are key drivers of innovation and growth.",
      "id": "123",
      "name": "The importance of public APIs.pdf",
      "type": "file"
    }
  ],
  "completion_reason": "done",
  "created_at": "2012-12-12T10:53:43-08:00"
}