Skip to content

Commit 5e58466

Browse files
committed
fix: Add info on Enhanced Extract Agent (box/box-openapi#555)
1 parent cd11be8 commit 5e58466

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
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": "0.1.0" }
1+
{ "engineHash": "0271743", "specHash": "1ed059a", "version": "0.1.0" }

box_sdk_gen/managers/ai.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ def create_ai_extract_structured(
440440
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)
441441
442442
443-
or use the [metadata template API](g://metadata/templates/create).
443+
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).
444444
445445
:param items: The items to be processed by the LLM. Currently you can use files only.
446446
:type items: List[AiItemBase]

box_sdk_gen/schemas/ai_agent_reference.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ def __init__(
2222
**kwargs
2323
):
2424
"""
25-
:param type: The type of AI agent used to handle queries., defaults to AiAgentReferenceTypeField.AI_AGENT_ID
26-
:type type: AiAgentReferenceTypeField, optional
27-
:param id: The ID of an Agent., defaults to None
28-
:type id: Optional[str], optional
25+
:param type: The type of AI agent used to handle queries., defaults to AiAgentReferenceTypeField.AI_AGENT_ID
26+
:type type: AiAgentReferenceTypeField, optional
27+
:param id: The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`)
28+
or a unique identifier for pre-built agents (for example, `enhanced_extract_agent`
29+
for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent))., defaults to None
30+
:type id: Optional[str], optional
2931
"""
3032
super().__init__(**kwargs)
3133
self.type = type

docs/box_sdk_gen/ai.md

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

159159
This operation is performed by calling function `create_ai_extract_structured`.
160160

0 commit comments

Comments
 (0)