Skip to content

Commit 3a4ae36

Browse files
committed
feat: update structured extraction endpoint description with OCR support info (box/box-openapi#564)
1 parent 06afe3f commit 3a4ae36

File tree

3 files changed

+28
-17
lines changed

3 files changed

+28
-17
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": "5.0.0" }
1+
{ "engineHash": "2ac72c4", "specHash": "e7ce024", "version": "5.0.0" }

docs/sdkgen/ai.md

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

136136
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
137-
For this request, you either need a metadata template or a list of fields you want to extract.
138-
Input is **either** a metadata template or a list of fields to ensure the structure.
139-
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)
140-
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).
137+
138+
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)
139+
or use the [metadata template API](g://metadata/templates/create).
140+
141+
This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
142+
143+
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.
141144

142145
This operation is performed by calling function `createAiExtractStructured`.
143146

src/main/java/com/box/sdkgen/managers/ai/AiManager.java

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -198,15 +198,19 @@ public AiResponse createAiExtract(AiExtract requestBody, CreateAiExtractHeaders
198198

199199
/**
200200
* Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as
201-
* a set of key-value pairs. For this request, you either need a metadata template or a list of
202-
* fields you want to extract. Input is **either** a metadata template or a list of fields to
203-
* ensure the structure. To learn more about creating templates, see [Creating metadata templates
204-
* in the Admin
201+
* a set of key-value pairs.
202+
*
203+
* <p>To define the extraction structure, provide either a metadata template or a list of fields.
204+
* To learn more about creating templates, see [Creating metadata templates in the Admin
205205
* Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
206-
* or use the [metadata template API](g://metadata/templates/create). This endpoint also supports
207-
* [Enhanced Extract
206+
* or use the [metadata template API](g://metadata/templates/create).
207+
*
208+
* <p>This endpoint also supports [Enhanced Extract
208209
* Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
209210
*
211+
* <p>For information about supported file formats and languages, see the [Extract metadata from
212+
* file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
213+
*
210214
* @param requestBody Request body of createAiExtractStructured method
211215
*/
212216
public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured requestBody) {
@@ -215,15 +219,19 @@ public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured
215219

216220
/**
217221
* Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as
218-
* a set of key-value pairs. For this request, you either need a metadata template or a list of
219-
* fields you want to extract. Input is **either** a metadata template or a list of fields to
220-
* ensure the structure. To learn more about creating templates, see [Creating metadata templates
221-
* in the Admin
222+
* a set of key-value pairs.
223+
*
224+
* <p>To define the extraction structure, provide either a metadata template or a list of fields.
225+
* To learn more about creating templates, see [Creating metadata templates in the Admin
222226
* Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
223-
* or use the [metadata template API](g://metadata/templates/create). This endpoint also supports
224-
* [Enhanced Extract
227+
* or use the [metadata template API](g://metadata/templates/create).
228+
*
229+
* <p>This endpoint also supports [Enhanced Extract
225230
* Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
226231
*
232+
* <p>For information about supported file formats and languages, see the [Extract metadata from
233+
* file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
234+
*
227235
* @param requestBody Request body of createAiExtractStructured method
228236
* @param headers Headers of createAiExtractStructured method
229237
*/

0 commit comments

Comments
 (0)