Skip to content

Commit 5131c4e

Browse files
committed
fix: Add info on Enhanced Extract Agent (box/box-openapi#555)
1 parent 65901de commit 5131c4e

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

BoxSdkGen/Sources/Managers/Ai/AiManager.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public class AiManager {
7373
/// For this request, you either need a metadata template or a list of fields you want to extract.
7474
/// Input is **either** a metadata template or a list of fields to ensure the structure.
7575
/// 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)
76-
/// or use the [metadata template API](g://metadata/templates/create).
76+
/// 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).
7777
///
7878
/// - Parameters:
7979
/// - requestBody: Request body of createAiExtractStructured method

BoxSdkGen/Sources/Schemas/AiAgentReference/AiAgentReference.swift

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,18 @@ public class AiAgentReference: Codable, RawJSONReadable {
1919
/// The type of AI agent used to handle queries.
2020
public let type: AiAgentReferenceTypeField
2121

22-
/// The ID of an Agent.
22+
/// The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`)
23+
/// or a unique identifier for pre-built agents (for example, `enhanced_extract_agent`
24+
/// for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)).
2325
public let id: String?
2426

2527
/// Initializer for a AiAgentReference.
2628
///
2729
/// - Parameters:
2830
/// - type: The type of AI agent used to handle queries.
29-
/// - id: The ID of an Agent.
31+
/// - id: The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`)
32+
/// or a unique identifier for pre-built agents (for example, `enhanced_extract_agent`
33+
/// for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent)).
3034
public init(type: AiAgentReferenceTypeField = AiAgentReferenceTypeField.aiAgentId, id: String? = nil) {
3135
self.type = type
3236
self.id = id

docs/BoxSdkGen/Ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Sends an AI request to supported Large Language Models (LLMs) and returns extrac
137137
For this request, you either need a metadata template or a list of fields you want to extract.
138138
Input is **either** a metadata template or a list of fields to ensure the structure.
139139
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).
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).
141141

142142
This operation is performed by calling function `createAiExtractStructured`.
143143

0 commit comments

Comments
 (0)