AI response (Full) - Box Dev Docs

API version 2024.0 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.

ai_agent_info

object

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

Show child attributes

models

object[]

The models used for the request.

Show child attributes

name

string

example: azure__openai__text_embedding_ada_002The name of the model used for the request.

provider

string

example: azureThe provider that owns the model used for the request.

supported_purpose

string

example: embeddingThe supported purpose utilized by the model used for the request.

processor

string

example: basic_textThe processor used for the request.

answer

string

example: Public APIs are important because of key and important reasons.The answer provided by the LLM.

citations

object[]

The citations of the LLM’s answer reference.

Show child attributes

string

example: 123The id of the item.

type

string

example: fileThe type of the item.Value is always file

content

string

example: Public APIs are key drivers of innovation and growth.The specific content from where the answer was referenced.

name

string

example: The importance of public APIs.pdfThe name of the item.

completion_reason

string

example: doneThe reason the response finishes.

created_at

string(date-time)

example: 2012-12-12T10:53:43-08:00The ISO date formatted timestamp of when the answer to the prompt was created.

{
  "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"
}