Skip to content

Commit f89b93c

Browse files
committed
fix: Add info on Enhanced Extract Agent (box/box-openapi#555)
1 parent 4fddab5 commit f89b93c

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "0271743", "specHash": "a05e5d7", "version": "10.0.0" }
1+
{ "engineHash": "0271743", "specHash": "1ed059a", "version": "10.0.0" }

docs/ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Sends an AI request to supported Large Language Models (LLMs) and returns extrac
170170
For this request, you either need a metadata template or a list of fields you want to extract.
171171
Input is **either** a metadata template or a list of fields to ensure the structure.
172172
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)
173-
or use the [metadata template API](g://metadata/templates/create).
173+
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).
174174

175175
This operation is performed by calling function `createAiExtractStructured`.
176176

src/managers/ai.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ export class AiManager {
506506
* For this request, you either need a metadata template or a list of fields you want to extract.
507507
* Input is **either** a metadata template or a list of fields to ensure the structure.
508508
* 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)
509-
* or use the [metadata template API](g://metadata/templates/create).
509+
* 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).
510510
* @param {AiExtractStructured} requestBody Request body of createAiExtractStructured method
511511
* @param {CreateAiExtractStructuredOptionalsInput} optionalsInput
512512
* @returns {Promise<AiExtractStructuredResponse>}

src/schemas/aiAgentReference.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ export class AiAgentReference {
1313
readonly type: AiAgentReferenceTypeField =
1414
'ai_agent_id' as AiAgentReferenceTypeField;
1515
/**
16-
* The ID of an Agent. */
16+
* The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`)
17+
* or a unique identifier for pre-built agents (for example, `enhanced_extract_agent`
18+
* for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)). */
1719
readonly id?: string;
1820
readonly rawData?: SerializedData;
1921
constructor(
@@ -36,7 +38,9 @@ export interface AiAgentReferenceInput {
3638
* The type of AI agent used to handle queries. */
3739
readonly type?: AiAgentReferenceTypeField;
3840
/**
39-
* The ID of an Agent. */
41+
* The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`)
42+
* or a unique identifier for pre-built agents (for example, `enhanced_extract_agent`
43+
* for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)). */
4044
readonly id?: string;
4145
readonly rawData?: SerializedData;
4246
}

0 commit comments

Comments
 (0)