diff --git a/openapi.json b/openapi.json index 46ad454b..c6373396 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "3e46126eb3" + "x-box-commit-hash": "a3b67ef217" }, "servers": [ { @@ -24712,7 +24712,7 @@ "post": { "operationId": "post_ai_extract_structured", "summary": "Extract metadata (structured)", - "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).", + "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).", "requestBody": { "content": { "application/json": { @@ -25551,7 +25551,7 @@ "nullable": false }, "id": { - "description": "The ID of an Agent.", + "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)).", "type": "string", "example": "14031", "nullable": false @@ -25903,7 +25903,7 @@ "$ref": "#/components/schemas/AiExtractStructuredAgent" }, { - "description": "The AI agent to be used for the structured extraction." + "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." } ] } diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 212bc599..17157e1f 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "3e46126eb3" + "x-box-commit-hash": "a3b67ef217" }, "servers": [ { diff --git a/openapi/openapi.json b/openapi/openapi.json index 46ad454b..c6373396 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "3e46126eb3" + "x-box-commit-hash": "a3b67ef217" }, "servers": [ { @@ -24712,7 +24712,7 @@ "post": { "operationId": "post_ai_extract_structured", "summary": "Extract metadata (structured)", - "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).", + "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).", "requestBody": { "content": { "application/json": { @@ -25551,7 +25551,7 @@ "nullable": false }, "id": { - "description": "The ID of an Agent.", + "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)).", "type": "string", "example": "14031", "nullable": false @@ -25903,7 +25903,7 @@ "$ref": "#/components/schemas/AiExtractStructuredAgent" }, { - "description": "The AI agent to be used for the structured extraction." + "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." } ] }