az cu analyzer

Preview

Note

This reference is part of the content-understanding extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az cu analyzer command. Learn more about extensions.

Command group 'cu' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Content Understanding analyzers.

Commands

Name	Description	Type	Status
az cu analyzer copy	Copy an analyzer within or across Microsoft Foundry resources.	Extension	Preview
az cu analyzer create	Create an analyzer from a JSON schema file.	Extension	Preview
az cu analyzer delete	Delete an analyzer.	Extension	Preview
az cu analyzer list	List analyzers in the Microsoft Foundry resource.	Extension	Preview
az cu analyzer schema	Author Content Understanding analyzer schemas.	Extension	Preview
az cu analyzer schema create	Create a starter schema or derive one from a local document sample.	Extension	Preview
az cu analyzer show	Show a single analyzer definition (JSON).	Extension	Preview
az cu analyzer test	Run an analyzer over local samples.	Extension	Preview
az cu analyzer validate	Validate a local analyzer schema.	Extension	Preview

az cu analyzer copy

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Copy an analyzer within or across Microsoft Foundry resources.

az cu analyzer copy --destination
                    --source
                    [--acquire-policy-token]
                    [--api-key]
                    [--api-version]
                    [--auth-mode {key, login}]
                    [--change-reference]
                    [--destination-resource]
                    [--destination-resource-group]
                    [--destination-subscription]
                    [--endpoint]
                    [--profile]
                    [--source-resource]
                    [--source-resource-group]
                    [--source-subscription]

Examples

Copy within the resource selected by the active profile.

az cu analyzer copy --source ContosoInvoice --destination ContosoInvoice_v2

Copy between resources using ARM IDs or account names.

az cu analyzer copy --source ContosoInvoice --destination ContosoInvoice --source-resource source-account --destination-resource target-account

Required Parameters

--destination

New analyzer name to create.

--source

Analyzer to copy.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--destination-resource

Resolve the destination resource directly from Azure.

--destination-resource-group

Resource group used for destination discovery.

--destination-subscription

Subscription in which to resolve the destination resource; defaults to the active Azure CLI subscription.

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

--source-resource

Resolve the source resource directly from Azure.

--source-resource-group

Resource group used for source discovery.

--source-subscription

Subscription in which to resolve the source resource; defaults to the active Azure CLI subscription.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer create

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an analyzer from a JSON schema file.

az cu analyzer create --name
                      --schema
                      [--acquire-policy-token]
                      [--api-key]
                      [--api-version]
                      [--auth-mode {key, login}]
                      [--change-reference]
                      [--endpoint]
                      [--profile]

Examples

Create a custom analyzer.

az cu analyzer create --name ContosoInvoice --schema analyzer.json --endpoint https://contoso.services.ai.azure.com/

Required Parameters

--name -a -n

Custom analyzer ID: 1-64 ASCII letters, numbers, or underscores.

--schema -s

Path to a JSON analyzer schema.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer delete

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an analyzer.

az cu analyzer delete --name
                      [--acquire-policy-token]
                      [--api-key]
                      [--api-version]
                      [--auth-mode {key, login}]
                      [--change-reference]
                      [--endpoint]
                      [--profile]
                      [--yes]

Examples

Confirm and delete an analyzer.

az cu analyzer delete --name ContosoInvoice

Delete an analyzer without prompting.

az cu analyzer delete --name ContosoInvoice --yes

Required Parameters

--name -a -n

Analyzer name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

--yes -y

Skip confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer list

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List analyzers in the Microsoft Foundry resource.

az cu analyzer list [--api-key]
                    [--api-version]
                    [--auth-mode {key, login}]
                    [--endpoint]
                    [--kind {all, custom, prebuilt}]
                    [--profile]
                    [--sort-by {analyzerId, createdAt, lastModifiedAt}]

Examples

List all analyzers by using an explicit endpoint.

az cu analyzer list --endpoint https://contoso.services.ai.azure.com/

List prebuilt analyzers using the endpoint from the active CU profile.

az cu analyzer list --kind prebuilt --output table

Select an analyzer with a JMESPath query.

az cu analyzer list --query "[?analyzerId=='prebuilt-layout']"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--kind

Filter analyzers by kind.

Property	Value
Default value:	all
Accepted values:	all, custom, prebuilt

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

--sort-by

Sort analyzers by name, creation time, or modification time.

Property	Value
Default value:	analyzerId
Accepted values:	analyzerId, createdAt, lastModifiedAt

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer show

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a single analyzer definition (JSON).

az cu analyzer show --name
                    [--api-key]
                    [--api-version]
                    [--auth-mode {key, login}]
                    [--endpoint]
                    [--profile]

Examples

Show an analyzer.

az cu analyzer show --name prebuilt-layout --endpoint https://contoso.services.ai.azure.com/

Return only the analyzer description.

az cu analyzer show --name prebuilt-layout --query description --output tsv

Required Parameters

--name -a -n

Analyzer name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer test

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Run an analyzer over local samples.

az cu analyzer test --name
                    [--acquire-policy-token]
                    [--api-key]
                    [--api-version]
                    [--auth-mode {key, login}]
                    [--change-reference]
                    [--concurrency]
                    [--dry-run]
                    [--endpoint]
                    [--file]
                    [--force]
                    [--output-file]
                    [--pattern]
                    [--profile]
                    [--recursive]
                    [--source]
                    [--yes]

Examples

Test all PDF files under a directory.

az cu analyzer test --name ContosoInvoice --source samples --pattern "\*.pdf" --output-file report.json --yes

Required Parameters

--name -a -n

Analyzer name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--concurrency -j

Concurrent analysis jobs.

Property	Value
Default value:	4

--dry-run

Display the local test plan without service calls.

Property	Value
Default value:	False

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--file

Literal local file. Repeat for multiple files.

--force

Overwrite an existing test report.

Property	Value
Default value:	False

--output-file

Write the structured test report to a file.

--pattern

Python fnmatch pattern applied to every --source.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

--recursive -r

Recurse into selected directories.

Property	Value
Default value:	False

--source

Local source directory. Repeat for multiple directories.

--yes -y

Skip discovery confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cu analyzer validate

Preview

Command group 'cu analyzer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Validate a local analyzer schema.

az cu analyzer validate --schema
                        [--acquire-policy-token]
                        [--api-version]
                        [--change-reference]
                        [--spec]
                        [--strict]

Examples

Validate curated rules and the bundled service contract.

az cu analyzer validate --schema analyzer.json --spec --strict

Required Parameters

--schema -s

Path to a JSON analyzer schema.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-version

Content Understanding service API version.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--spec

Also validate against the bundled service contract.

Property	Value
Default value:	False

--strict

Treat warnings as errors.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?