Skip to content

Commit 70bd848

Browse files
Add enhanced_extract_agent (#818)
* Added enhanced_extract_agent * Fixed links
1 parent beb3bc0 commit 70bd848

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

content/guides/box-ai/ai-tutorials/extract-metadata-structured.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -177,20 +177,23 @@ The response lists the fields included in the metadata template and their values
177177
178178
### Enhanced Extract Agent
179179
180-
To start using the agent, you need:
180+
To use the Enhanced Extract Agent, specify the `ai_agent` object as follows:
181181
182-
- A Box Platform App with enabled `Manage AI` scope.
183-
- The app installed and enabled in your Box instance.
184-
- A file to test with.
185-
186-
Calling an Enhanced Extract Agent works like calling the AI API - set the `type` to `AI Agent ID`, then string to the Enhanced Extract AI agent.
182+
```bash
183+
{
184+
"ai_agent": {
185+
"type": "ai_agent_id",
186+
"id": "enhanced_extract_agent"
187+
}
188+
}
189+
```
187190
188-
To extract data using the Enhanced Extract Agent you need:
191+
To extract data using the Enhanced Extract Agent you need one of the following:
189192
190-
- Inline field definitions created with `agentCreateAiExtractStructuredMetadataTemplate` if your fields change frequently,
191-
- or a metadata template that contains the data about the fields you wish to extract, if your extracted fields stay the same.
193+
- [Inline field definitions][inline-field] (best when fields change frequently)
194+
- [Metadata template][metadata-template] (best when fields stay consistent)
192195
193-
See the full sample Python script that demonstrates how to call the Enhanced Extract Agent on a file using the Box AI SDK:
196+
See the sample code snippet using Box Python SDK:
194197
195198
```Python
196199
from box_sdk_gen import (
@@ -246,4 +249,6 @@ print(f"box_ai_response: {box_ai_response.answer}")
246249
[templates-api]: g://metadata/templates/create
247250
[overrides]: g://box-ai/ai-agents/ai-agent-overrides
248251
[changelog]: page://changelog
249-
[blog]: https://medium.com/box-developer-blog
252+
[blog]: https://medium.com/box-developer-blog
253+
[inline-field]: #use-fields-parameter
254+
[metadata-template]: #use-metadata-template

0 commit comments

Comments
 (0)