Skip to content

Commit a54eee1

Browse files
docs: Update AI extract structured description with OCR support info (box/box-openapi#564) (#1199)
1 parent 7e4e878 commit a54eee1

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "2ac72c4", "specHash": "8b51a89", "version": "10.0.1" }
1+
{ "engineHash": "2ac72c4", "specHash": "e7ce024", "version": "10.0.1" }

box_sdk_gen/managers/ai.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -431,16 +431,16 @@ def create_ai_extract_structured(
431431
"""
432432
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
433433
434-
For this request, you either need a metadata template or a list of fields you want to extract.
434+
To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
435435
436436
437-
Input is **either** a metadata template or a list of fields to ensure the structure.
437+
or use the [metadata template API](g://metadata/templates/create).
438438
439439
440-
To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
440+
This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
441441
442442
443-
or use the [metadata template API](g://metadata/templates/create). This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
443+
For information about supported file formats and languages, see the [Extract metadata from file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
444444
445445
:param items: The items to be processed by the LLM. Currently you can use files only.
446446
:type items: List[AiItemBase]

docs/ai.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,10 +188,13 @@ A response including the answer from the LLM.
188188
## Extract metadata (structured)
189189

190190
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
191-
For this request, you either need a metadata template or a list of fields you want to extract.
192-
Input is **either** a metadata template or a list of fields to ensure the structure.
193-
To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
194-
or use the [metadata template API](g://metadata/templates/create). This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
191+
192+
To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
193+
or use the [metadata template API](g://metadata/templates/create).
194+
195+
This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
196+
197+
For information about supported file formats and languages, see the [Extract metadata from file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
195198

196199
This operation is performed by calling function `create_ai_extract_structured`.
197200

0 commit comments

Comments
 (0)