az cu analyzer schema

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 schema command. Learn more about extensions.

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

Author Content Understanding analyzer schemas.

Commands

Name	Description	Type	Status
az cu analyzer schema create	Create a starter schema or derive one from a local document sample.	Extension	Preview

az cu analyzer schema create

Preview

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

Create a starter schema or derive one from a local document sample.

az cu analyzer schema create [--acquire-policy-token]
                             [--api-key]
                             [--api-version]
                             [--auth-mode {key, login}]
                             [--base]
                             [--change-reference]
                             [--endpoint]
                             [--force]
                             [--from-sample]
                             [--from-template]
                             [--modality {audio, document, image, video}]
                             [--name]
                             [--output-file]
                             [--profile]
                             [--type {classification, extraction}]

Examples

Write an extraction starter schema.

az cu analyzer schema create --name ContosoInvoice --output-file analyzer.json

Derive a schema from one document sample.

az cu analyzer schema create --name ContosoInvoice --from-sample invoice.pdf --output-file analyzer.json

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

--base

Base analyzer name; defaults from --modality.

--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.

--force

Overwrite an existing schema output file.

Property	Value
Default value:	False

--from-sample

Create an extraction schema from one local document sample.

--from-template

Create an offline starter schema (the default).

Property	Value
Default value:	False

--modality

Modality used to choose a base analyzer.

Property	Value
Default value:	document
Accepted values:	audio, document, image, video

--name -a -n

Custom analyzer name.

Property	Value
Default value:	my_analyzer_v1

--output-file

Write the schema to a file.

--profile

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

--type

Schema template style.

Property	Value
Default value:	extraction
Accepted values:	classification, extraction

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