analyze_documents
Creates, updates, deletes, gets or lists an analyze_documents resource.
Overview
| Name | analyze_documents |
| Type | Resource |
| Id | azure.ai_document_intelligence.analyze_documents |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
analyze_document | exec | model_id, endpoint | pages, locale, stringIndexType, features, queryFields, outputContentFormat, output | Analyzes document with document model. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
model_id | string | Unique document model name. Required. |
features | array | List of optional analysis features. Default value is None. |
locale | string | Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). Default value is None. |
output | array | Additional outputs to generate during analysis. Default value is None. |
outputContentFormat | string | Format of the analyze result top-level content. Known values are: "text" and "markdown". Default value is None. |
pages | string | 1-based page numbers to analyze. Ex. "1-3,5,7-9". Default value is None. |
queryFields | array | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". Default value is None. |
stringIndexType | string | Method used to compute string offset and length. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". Default value is None. |
Lifecycle Methods
- analyze_document
Analyzes document with document model.
EXEC azure.ai_document_intelligence.analyze_documents.analyze_document
@model_id='{{ model_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@pages='{{ pages }}',
@locale='{{ locale }}',
@stringIndexType='{{ stringIndexType }}',
@features='{{ features }}',
@queryFields='{{ queryFields }}',
@outputContentFormat='{{ outputContentFormat }}',
@output='{{ output }}'
@@json=
'{
"urlSource": "{{ urlSource }}",
"base64Source": "{{ base64Source }}"
}'
;