analyzers

Creates, updates, deletes, gets or lists an analyzers resource.

Overview

Name	`analyzers`
Type	Resource
Id	`azure.ai_content_understanding.analyzers`

Fields

The following fields are returned by SELECT queries:

get_analyzer
list_analyzers

Name	Datatype	Description
`analyzerId`	`string`	The unique identifier of the analyzer. Required.
`baseAnalyzerId`	`string`	The analyzer to incrementally train from.
`config`	`object`	Analyzer configuration settings.
`createdAt`	`string (date-time)`	The date and time when the analyzer was created. Required.
`description`	`string`	A description of the analyzer.
`dynamicFieldSchema`	`boolean`	Indicates whether the result may contain additional fields outside of the defined schema.
`fieldSchema`	`object`	The schema of fields to extracted.
`knowledgeSources`	`array`	Additional knowledge sources used to enhance the analyzer.
`lastModifiedAt`	`string (date-time)`	The date and time when the analyzer was last modified. Required.
`models`	`object`	Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
`processingLocation`	`string`	The location where the data may be processed. Defaults to global. Known values are: "geography", "dataZone", and "global". (geography, dataZone, global)
`status`	`string`	The status of the analyzer. Required. Known values are: "creating", "ready", "deleting", and "failed". (creating, ready, deleting, failed)
`supportedModels`	`object`	Chat completion and embedding models supported by the analyzer.
`tags`	`object`	Tags associated with the analyzer.
`warnings`	`array`	Warnings encountered while creating the analyzer.

Name	Datatype	Description
`analyzerId`	`string`	The unique identifier of the analyzer. Required.
`baseAnalyzerId`	`string`	The analyzer to incrementally train from.
`config`	`object`	Analyzer configuration settings.
`createdAt`	`string (date-time)`	The date and time when the analyzer was created. Required.
`description`	`string`	A description of the analyzer.
`dynamicFieldSchema`	`boolean`	Indicates whether the result may contain additional fields outside of the defined schema.
`fieldSchema`	`object`	The schema of fields to extracted.
`knowledgeSources`	`array`	Additional knowledge sources used to enhance the analyzer.
`lastModifiedAt`	`string (date-time)`	The date and time when the analyzer was last modified. Required.
`models`	`object`	Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
`processingLocation`	`string`	The location where the data may be processed. Defaults to global. Known values are: "geography", "dataZone", and "global". (geography, dataZone, global)
`status`	`string`	The status of the analyzer. Required. Known values are: "creating", "ready", "deleting", and "failed". (creating, ready, deleting, failed)
`supportedModels`	`object`	Chat completion and embedding models supported by the analyzer.
`tags`	`object`	Tags associated with the analyzer.
`warnings`	`array`	Warnings encountered while creating the analyzer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_analyzer`	`select`	`analyzer_id`, `endpoint`		Get analyzer properties.
`list_analyzers`	`select`	`endpoint`		List analyzers.
`create_analyzer`	`insert`	`analyzer_id`, `endpoint`	`allowReplace`	Create a new analyzer asynchronously.
`update_analyzer`	`update`	`analyzer_id`, `endpoint`		Update analyzer properties.
`delete_analyzer`	`delete`	`analyzer_id`, `endpoint`		Delete analyzer.

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
`analyzer_id`	`string`	The unique identifier of the analyzer. Required.
`endpoint`	`string`	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client `endpoint` parameter. (default: )
`allowReplace`	`boolean`	Allow the operation to replace an existing resource. Default value is None.

`SELECT` examples

get_analyzer
list_analyzers

Get analyzer properties.

SELECT
analyzerId,
baseAnalyzerId,
config,
createdAt,
description,
dynamicFieldSchema,
fieldSchema,
knowledgeSources,
lastModifiedAt,
models,
processingLocation,
status,
supportedModels,
tags,
warnings
FROM azure.ai_content_understanding.analyzers
WHERE analyzer_id = '{{ analyzer_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

List analyzers.

SELECT
analyzerId,
baseAnalyzerId,
config,
createdAt,
description,
dynamicFieldSchema,
fieldSchema,
knowledgeSources,
lastModifiedAt,
models,
processingLocation,
status,
supportedModels,
tags,
warnings
FROM azure.ai_content_understanding.analyzers
WHERE endpoint = '{{ endpoint }}' -- required
;

`INSERT` examples

create_analyzer
Manifest

Create a new analyzer asynchronously.

INSERT INTO azure.ai_content_understanding.analyzers (
description,
tags,
baseAnalyzerId,
config,
fieldSchema,
dynamicFieldSchema,
processingLocation,
knowledgeSources,
models,
analyzer_id,
endpoint,
allowReplace
)
SELECT 
'{{ description }}',
'{{ tags }}',
'{{ baseAnalyzerId }}',
'{{ config }}',
'{{ fieldSchema }}',
{{ dynamicFieldSchema }},
'{{ processingLocation }}',
'{{ knowledgeSources }}',
'{{ models }}',
'{{ analyzer_id }}',
'{{ endpoint }}',
'{{ allowReplace }}'
RETURNING
analyzerId,
baseAnalyzerId,
config,
createdAt,
description,
dynamicFieldSchema,
fieldSchema,
knowledgeSources,
lastModifiedAt,
models,
processingLocation,
status,
supportedModels,
tags,
warnings
;

# Description fields are for documentation purposes
- name: analyzers
props:
  - name: analyzer_id
    value: "{{ analyzer_id }}"
    description: Required parameter for the analyzers resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the analyzers resource.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the analyzer.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tags associated with the analyzer.
  - name: baseAnalyzerId
    value: "{{ baseAnalyzerId }}"
    description: |
      The analyzer to incrementally train from.
  - name: config
    description: |
      Analyzer configuration settings.
    value:
      returnDetails: {{ returnDetails }}
      locales:
        - "{{ locales }}"
      enableOcr: {{ enableOcr }}
      enableLayout: {{ enableLayout }}
      enableFigureDescription: {{ enableFigureDescription }}
      enableFigureAnalysis: {{ enableFigureAnalysis }}
      enableFormula: {{ enableFormula }}
      tableFormat: "{{ tableFormat }}"
      chartFormat: "{{ chartFormat }}"
      annotationFormat: "{{ annotationFormat }}"
      disableFaceBlurring: {{ disableFaceBlurring }}
      estimateFieldSourceAndConfidence: {{ estimateFieldSourceAndConfidence }}
      contentCategories: "{{ contentCategories }}"
      enableSegment: {{ enableSegment }}
      segmentPerPage: {{ segmentPerPage }}
      omitContent: {{ omitContent }}
  - name: fieldSchema
    description: |
      The schema of fields to extracted.
    value:
      name: "{{ name }}"
      description: "{{ description }}"
      fields: "{{ fields }}"
      definitions: "{{ definitions }}"
  - name: dynamicFieldSchema
    value: {{ dynamicFieldSchema }}
    description: |
      Indicates whether the result may contain additional fields outside of the defined schema.
  - name: processingLocation
    value: "{{ processingLocation }}"
    description: |
      The location where the data may be processed. Defaults to global. Known values are: "geography", "dataZone", and "global".
    valid_values: ['geography', 'dataZone', 'global']
  - name: knowledgeSources
    description: |
      Additional knowledge sources used to enhance the analyzer.
    value:
      - kind: "{{ kind }}"
  - name: models
    value: "{{ models }}"
    description: |
      Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
  - name: allowReplace
    value: {{ allowReplace }}
    description: Allow the operation to replace an existing resource. Default value is None.
    description: Allow the operation to replace an existing resource. Default value is None.

`UPDATE` examples

update_analyzer

Update analyzer properties.

UPDATE azure.ai_content_understanding.analyzers
SET 
description = '{{ description }}',
tags = '{{ tags }}',
baseAnalyzerId = '{{ baseAnalyzerId }}',
config = '{{ config }}',
fieldSchema = '{{ fieldSchema }}',
dynamicFieldSchema = {{ dynamicFieldSchema }},
processingLocation = '{{ processingLocation }}',
knowledgeSources = '{{ knowledgeSources }}',
models = '{{ models }}'
WHERE 
analyzer_id = '{{ analyzer_id }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
analyzerId,
baseAnalyzerId,
config,
createdAt,
description,
dynamicFieldSchema,
fieldSchema,
knowledgeSources,
lastModifiedAt,
models,
processingLocation,
status,
supportedModels,
tags,
warnings;

`DELETE` examples

delete_analyzer

Delete analyzer.

DELETE FROM azure.ai_content_understanding.analyzers
WHERE analyzer_id = '{{ analyzer_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​