Skip to content

Commit

Permalink
Merge branch 'main' into DDOC-1088-sign-sms-auth
Browse files Browse the repository at this point in the history
  • Loading branch information
superojla authored Dec 12, 2024
2 parents 803e8a5 + 2af6a5c commit fadd7ec
Showing 1 changed file with 33 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,36 @@ To learn more about creating templates, see [Creating metadata templates in the

Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.

<Message type="notice">
### Upcoming breaking change

We would like to announce a planned breaking change in the Box AI API - Extract Structured endpoint. This change will bring improvements to the response by introducing additional fields and nesting the metadata key-value pairs within the answer object. **This change is planned to be released mid-January**. Be sure to follow our [changelog][changelog] and announcements on our [Box Developer Blog][blog]. See code snippets:

<!-- more -->
Current response example:

```js
{
"name": "Marie",
"date": "10/2/23"
}
```

New response format example:

```js
{
"answer": {
"name": "Marie",
"date": "10/2/23"
},
"completion_reason": "done",
"created_at": "2012-12-12T10:53:43-08:00"
}
```

</Message>

## Send a request

To send a request, use the
Expand Down Expand Up @@ -185,4 +215,6 @@ The response lists the fields included in the metadata template and their values
[prompt-param]: r://ai_agent_text_gen#param_basic_gen_prompt_template
[templates-console]: https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates
[templates-api]: g://metadata/templates/create
[overrides]: g://box-ai/ai-agents/ai-agent-overrides
[overrides]: g://box-ai/ai-agents/ai-agent-overrides
[changelog]: https://developer.box.com/changelog/
[blog]: https://medium.com/box-developer-blog

0 comments on commit fadd7ec

Please sign in to comment.