Text Analysis Authoring - Get Model Evaluation Results

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

Obtém os resultados detalhados da avaliação de um modelo treinado. Isso inclui os resultados brutos de inferência para os dados incluídos no processo de avaliação.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&api-version=2023-04-01

Com parâmetros opcionais:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a ser usado.
trainedModelLabel	path	True	string	O rótulo de modelo treinado.
api-version	query	True	string	Versão de API do cliente.
stringIndexType	query	True	StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	O número máximo de recursos a serem incluídos em uma única resposta.
skip	query		integer int32	Um deslocamento para a coleção do primeiro recurso a ser retornado.
top	query		integer int32	O número máximo de recursos a serem retornados da coleção.

Respostas

Nome	Tipo	Description
200 OK	TextAnalysisAuthoringEvaluationResults	Lista dos resultados da avaliação.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful Get Model Evaluation

Solicitação de exemplo

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result?stringIndexType=Utf16CodeUnit&maxpagesize=10&api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "location": "11.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 181,
                "length": 34
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 15
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1780
          }
        ]
      }
    },
    {
      "location": "01.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1793
          }
        ]
      }
    }
  ],
  "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-01&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}"
}

Definições

Nome	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	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.
ProjectKind	O tipo de projeto.
StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de reconhecimento de entidade personalizado.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de classificação de vários rótulos personalizado.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de classificação de rótulo único personalizado.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Representa um rótulo de entidade de resultado de avaliação.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa o resultado da avaliação de reconhecimento de entidade para um documento.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Representa a comparação de avaliação entre as entidades esperadas e previstas de uma região de documento.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa a comparação entre as classes esperadas e previstas resultantes da operação de avaliação.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa a comparação entre a classe esperada e prevista resultante de uma operação de avaliação.
TextAnalysisAuthoringEvaluationResults	Representa uma lista de resultados para uma operação de avaliação.

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	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 pelo homem do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

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.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Destino do erro.

ProjectKind

O tipo de projeto.

Nome	Tipo	Description
CustomEntityRecognition	string	Para criar um modelo de extração para identificar suas categorias de domínio usando seus próprios dados.
CustomMultiLabelClassification	string	Para criar um modelo de classificação para classificar o texto usando seus próprios dados. Cada arquivo pode ter um ou muitos rótulos. Por exemplo, o arquivo 1 é classificado como A, B e C e o arquivo 2 é classificado como B e C.
CustomSingleLabelClassification	string	Para criar um modelo de classificação para classificar o texto usando seus próprios dados. Cada arquivo terá apenas um rótulo. Por exemplo, o arquivo 1 é classificado como A e o arquivo 2 é classificado como B.

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

Nome	Tipo	Description
Utf16CodeUnit	string	Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte a Unicode, por exemplo Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Representa o resultado da avaliação do documento para um projeto de reconhecimento de entidade personalizado.

Nome	Tipo	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa a previsão de avaliação para o reconhecimento de entidade.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
location	string	Representa o caminho do documento.
projectKind	string: CustomEntityRecognition	Representa o tipo de projeto.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Representa o resultado da avaliação do documento para um projeto de classificação de vários rótulos personalizado.

Nome	Tipo	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa a previsão de avaliação para classificação de vários rótulos.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
location	string	Representa o caminho do documento.
projectKind	string: CustomMultiLabelClassification	Representa o tipo de projeto.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Representa o resultado da avaliação do documento para um projeto de classificação de rótulo único personalizado.

Nome	Tipo	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa a previsão de avaliação para classificação de rótulo único.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
location	string	Representa o caminho do documento.
projectKind	string: CustomSingleLabelClassification	Representa o tipo de projeto.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Representa um rótulo de entidade de resultado de avaliação.

Nome	Tipo	Description
category	string	Representa a categoria de entidade.
length	integer	Representa o comprimento da entidade.
offset	integer	Representa o índice de deslocamento de entidade em relação ao texto original.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Representa o resultado da avaliação de reconhecimento de entidade para um documento.

Nome	Tipo	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Representa as entidades rotuladas pelo documento.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Representa a comparação de avaliação entre as entidades esperadas e previstas de uma região de documento.

Nome	Tipo	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa os rótulos de entidade esperados da região.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa os rótulos de entidade previstos da região.
regionLength	integer	Representa o comprimento da região.
regionOffset	integer	Representa o deslocamento de região.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Representa a comparação entre as classes esperadas e previstas resultantes da operação de avaliação.

Nome	Tipo	Description
expectedClasses	string[]	Representa as classes esperadas do documento.
predictedClasses	string[]	Representa as classes previstas do documento.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Representa a comparação entre a classe esperada e prevista resultante de uma operação de avaliação.

Nome	Tipo	Description
expectedClass	string	Representa a classe esperada do documento.
predictedClass	string	Representa a classe prevista do documento.

TextAnalysisAuthoringEvaluationResults

Representa uma lista de resultados para uma operação de avaliação.

Nome	Tipo	Description
nextLink	string	O link da próxima página.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Lista THe de resultados de avaliação de documentos.

Compartilhar via