From 2af6a5c97a2e790d1cdcc46a67f3d4196889b1ad Mon Sep 17 00:00:00 2001 From: Olga Stefaniuk Date: Thu, 12 Dec 2024 12:00:56 +0100 Subject: [PATCH] Extract breaking info (#653) * Resolve conflicts * Resolve conflicts * Add info about planning breaking change for extract ai * Wrap announcement in the message component * Fix linting error --- .../extract-metadata-structured.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md index eddb4c6dc..14d52b8c3 100644 --- a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md +++ b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md @@ -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. + +### 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: + + +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" +} +``` + + + ## Send a request To send a request, use the @@ -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 \ No newline at end of file +[overrides]: g://box-ai/ai-agents/ai-agent-overrides +[changelog]: https://developer.box.com/changelog/ +[blog]: https://medium.com/box-developer-blog \ No newline at end of file