Skip to content

docs: Update AI extract structured description with OCR support info (box/box-openapi#564) #1578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukaszsocha2 merged 1 commit into from
Nov 18, 2025
Merged

docs: Update AI extract structured description with OCR support info (box/box-openapi#564) #1578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "2ac72c4", "specHash": "8b51a89", "version": "10.1.0" }
{ "engineHash": "2ac72c4", "specHash": "e7ce024", "version": "10.1.0" }
11 changes: 7 additions & 4 deletions docs/ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,13 @@ A response including the answer from the LLM.
## Extract metadata (structured)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
For this request, you either need a metadata template or a list of fields you want to extract.
Input is **either** a metadata template or a list of fields to ensure the structure.
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)
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).

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)
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).

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.

This operation is performed by calling function `createAiExtractStructured`.

Expand Down
32 changes: 20 additions & 12 deletions src/main/java/com/box/sdkgen/managers/ai/AiManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,15 +198,19 @@ public AiResponse createAiExtract(AiExtract requestBody, CreateAiExtractHeaders

/**
* Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as
* a set of key-value pairs. For this request, you either need a metadata template or a list of
* fields you want to extract. Input is **either** a metadata template or a list of fields to
* ensure the structure. To learn more about creating templates, see [Creating metadata templates
* in the Admin
* a set of key-value pairs.
*
* <p>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)
* or use the [metadata template API](g://metadata/templates/create). This endpoint also supports
* [Enhanced Extract
* or use the [metadata template API](g://metadata/templates/create).
*
* <p>This endpoint also supports [Enhanced Extract
* Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
*
* <p>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.
*
* @param requestBody Request body of createAiExtractStructured method
*/
public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured requestBody) {
Expand All @@ -215,15 +219,19 @@ public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured

/**
* Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as
* a set of key-value pairs. For this request, you either need a metadata template or a list of
* fields you want to extract. Input is **either** a metadata template or a list of fields to
* ensure the structure. To learn more about creating templates, see [Creating metadata templates
* in the Admin
* a set of key-value pairs.
*
* <p>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)
* or use the [metadata template API](g://metadata/templates/create). This endpoint also supports
* [Enhanced Extract
* or use the [metadata template API](g://metadata/templates/create).
*
* <p>This endpoint also supports [Enhanced Extract
* Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
*
* <p>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.
*
* @param requestBody Request body of createAiExtractStructured method
* @param headers Headers of createAiExtractStructured method
*/
Expand Down