AI extract structured response

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

AI extract structured response.

ai_agent_info object

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

ai_agent_info.models object array

The models used for the request.

[models].name string

exampleazure__openai__text_embedding_ada_002

The name of the model used for the request.

[models].provider string

exampleazure

The provider that owns the model used for the request.

[models].supported_purpose string

exampleembedding

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

ai_agent_info.processor string

examplebasic_text

The processor used for the request.

answerAI extract response

AI extract response. The content of this response may vary depending on the requested configuration.

completion_reason string

exampledone

The reason the response finishes.

created_at string (date-time)

example2012-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"
  },
  "completion_reason": "done",
  "created_at": "2012-12-12T10:53:43-08:00"
}