Skip to content

Commit 1c61638

Browse files
committed
fix: Add info on Enhanced Extract Agent
1 parent 503f80e commit 1c61638

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

openapi.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2024.0",
17-
"x-box-commit-hash": "3e46126eb3"
17+
"x-box-commit-hash": "a3b67ef217"
1818
},
1919
"servers": [
2020
{
@@ -24712,7 +24712,7 @@
2471224712
"post": {
2471324713
"operationId": "post_ai_extract_structured",
2471424714
"summary": "Extract metadata (structured)",
24715-
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor use the [metadata template API](g://metadata/templates/create).",
24715+
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor 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).",
2471624716
"requestBody": {
2471724717
"content": {
2471824718
"application/json": {
@@ -25551,7 +25551,7 @@
2555125551
"nullable": false
2555225552
},
2555325553
"id": {
25554-
"description": "The ID of an Agent.",
25554+
"description": "The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`) \nor a unique identifier for pre-built agents (for example, `enhanced_extract_agent` \nfor the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)).",
2555525555
"type": "string",
2555625556
"example": "14031",
2555725557
"nullable": false
@@ -25903,7 +25903,7 @@
2590325903
"$ref": "#/components/schemas/AiExtractStructuredAgent"
2590425904
},
2590525905
{
25906-
"description": "The AI agent to be used for the structured extraction."
25906+
"description": "The AI agent to be used for the structured extraction. Defaults to the Standard Agent if not specified. If you want to use Enhanced Extract Agent, see [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent) for details."
2590725907
}
2590825908
]
2590925909
}

openapi/openapi-v2025.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2025.0",
17-
"x-box-commit-hash": "3e46126eb3"
17+
"x-box-commit-hash": "a3b67ef217"
1818
},
1919
"servers": [
2020
{

openapi/openapi.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2024.0",
17-
"x-box-commit-hash": "3e46126eb3"
17+
"x-box-commit-hash": "a3b67ef217"
1818
},
1919
"servers": [
2020
{
@@ -24712,7 +24712,7 @@
2471224712
"post": {
2471324713
"operationId": "post_ai_extract_structured",
2471424714
"summary": "Extract metadata (structured)",
24715-
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor use the [metadata template API](g://metadata/templates/create).",
24715+
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor 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).",
2471624716
"requestBody": {
2471724717
"content": {
2471824718
"application/json": {
@@ -25551,7 +25551,7 @@
2555125551
"nullable": false
2555225552
},
2555325553
"id": {
25554-
"description": "The ID of an Agent.",
25554+
"description": "The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`) \nor a unique identifier for pre-built agents (for example, `enhanced_extract_agent` \nfor the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)).",
2555525555
"type": "string",
2555625556
"example": "14031",
2555725557
"nullable": false
@@ -25903,7 +25903,7 @@
2590325903
"$ref": "#/components/schemas/AiExtractStructuredAgent"
2590425904
},
2590525905
{
25906-
"description": "The AI agent to be used for the structured extraction."
25906+
"description": "The AI agent to be used for the structured extraction. Defaults to the Standard Agent if not specified. If you want to use Enhanced Extract Agent, see [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent) for details."
2590725907
}
2590825908
]
2590925909
}

0 commit comments

Comments
 (0)