Analyzers - Get

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-12-01-preview

Obtenha as propriedades do analisador.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2024-12-01-preview

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
analyzerId	path	True	string	O identificador exclusivo do analisador. Padrão Regex: `^[a-zA-Z0-9._-]{1,64}$`
endpoint	path	True	string uri	Ponto de extremidade do serviço de Compreensão de Conteúdo.
api-version	query	True	string	A versão da API a ser usada para esta operação.

analyzerId

path

True

string

O identificador exclusivo do analisador.

Padrão Regex: ^[a-zA-Z0-9._-]{1,64}$

endpoint

path

True

string

uri

Ponto de extremidade do serviço de Compreensão de Conteúdo.

api-version

query

True

string

A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name	Tipo	Description
200 OK	ContentAnalyzer	O pedido foi bem-sucedido. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

ContentAnalyzer

O pedido foi bem-sucedido.

Cabeçalhos

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Get Analyzer

Pedido de amostra

HTTP

GET {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2024-12-01-preview

Resposta da amostra

Código de estado:: 200

{
  "analyzerId": "myAnalyzer",
  "description": "My custom analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "succeeded",
  "createdAt": "2024-10-14T18:46:36.051Z",
  "lastModifiedAt": "2024-10-14T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BlobDataSource	Fonte de dados de armazenamento de Blob.
ContentAnalyzer	Analisador que extrai conteúdo e campos de documentos multimodais.
ContentAnalyzerConfig	Definições de configuração para um analisador.
DataSourceKind	Tipo de fonte de dados.
FieldDefinition	Definição do campo usando um esquema JSON como sintaxe.
FieldSchema	Esquema de campos a serem extraídos de documentos.
FieldType	Tipo de dados semânticos do valor do campo.
GenerationMethod	Método de geração.
ResourceStatus	Status de um recurso.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

BlobDataSource

Fonte de dados de armazenamento de Blob.

Name	Tipo	Description
containerUrl	string	A URL do contêiner de blob.
fileListPath	string	Um caminho opcional para um arquivo listando blobs específicos a serem incluídos.
kind	string: blob	O tipo de fonte de dados.
prefix	string	Um prefixo opcional para filtrar blobs dentro do contêiner.

ContentAnalyzer

Analisador que extrai conteúdo e campos de documentos multimodais.

Name	Tipo	Description
analyzerId	string	O identificador exclusivo do analisador.
baseAnalyzerId	string	O analisador para treinar incrementalmente.
config	ContentAnalyzerConfig	Definições de configuração do analisador.
createdAt	string	A data e a hora em que o analisador foi criado.
description	string	Uma descrição do analisador.
fieldSchema	FieldSchema	O esquema de campos a serem extraídos.
lastModifiedAt	string	A data e a hora em que o analisador foi modificado pela última vez.
scenario	string	O cenário para o qual o analisador é otimizado.
status	ResourceStatus	O status do analisador.
tags	object	Tags associadas ao analisador.
trainingData	DataSource: BlobDataSource	A fonte de dados que contém dados de treinamento para o analisador.
warnings	Azure.Core.Foundations.Error[]	Avisos encontrados durante a criação do analisador.

ContentAnalyzerConfig

Definições de configuração para um analisador.

Name	Tipo	Description
enableBarcode	boolean	Habilite a deteção de código de barras.
enableFace	boolean	Habilite a deteção de rosto.
enableFormula	boolean	Habilite a deteção de fórmulas matemáticas.
enableLayout	boolean	Habilite a análise de layout.
enableOcr	boolean	Habilite o reconhecimento ótico de caracteres (OCR).
locales	string[]	Lista de dicas de localidade para transcrição de fala.
returnDetails	boolean	Retornar todos os detalhes do conteúdo.

DataSourceKind

Tipo de fonte de dados.

Name	Tipo	Description
blob	string	Uma fonte de dados de armazenamento de blob.

FieldDefinition

Definição do campo usando um esquema JSON como sintaxe.

Name	Tipo	Default value	Description
$ref	string		Referência a outra definição de campo.
description	string		Descrição do campo.
enum	string[]		Enumeração de possíveis valores de campo.
enumDescriptions	object		Descrições para cada valor de enumeração.
examples	string[]		Exemplos de valores de campo.
items	FieldDefinition		Esquema de tipo de campo de cada elemento de matriz, se tipo for matriz.
method	GenerationMethod	generate	Método de geração.
properties	<string, FieldDefinition>		Subcampos nomeados, se type for objeto.
type	FieldType		Tipo de dados semânticos do valor do campo.

FieldSchema

Esquema de campos a serem extraídos de documentos.

Name	Tipo	Description
definitions	<string, FieldDefinition>	Definições adicionais referenciadas pelos campos no esquema.
description	string	Uma descrição do esquema de campo.
fields	<string, FieldDefinition>	Os campos definidos no esquema.
name	string	O nome do esquema de campo.

FieldType

Tipo de dados semânticos do valor do campo.

Name	Tipo	Description
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booleano.
date	string	Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).
integer	string	Inteiro como inteiro assinado de 64 bits.
number	string	Número como ponto flutuante de precisão dupla.
object	string	Lista nomeada de subcampos.
string	string	Texto simples.
time	string	Tempo, normalizado para o formato ISO 8601 (hh:mm:ss).

GenerationMethod

Método de geração.

Name	Tipo	Description
classify	string	Os valores são classificados em relação a um conjunto predefinido de categorias.
extract	string	Os valores são extraídos à medida que aparecem no conteúdo.
generate	string	Os valores são gerados livremente com base no conteúdo.

ResourceStatus

Status de um recurso.

Name	Tipo	Description
creating	string	O recurso está sendo criado.
deleting	string	O recurso está sendo excluído.
failed	string	O recurso falhou durante a criação.
ready	string	O recurso está pronto.

Partilhar via

Analyzers - Get

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Get Analyzer

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BlobDataSource

ContentAnalyzer

ContentAnalyzerConfig

DataSourceKind

FieldDefinition

FieldSchema

FieldType

GenerationMethod

ResourceStatus

Recursos adicionais