Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

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.

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.

AI extract response

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

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