Text Analysis Authoring - Get Model Evaluation Results

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Obtém os resultados detalhados da avaliação de um modelo preparado. Isto inclui os resultados de inferência não processados 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

With optional parameters:

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 do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
trainedModelLabel	path	True	string	A etiqueta do modelo preparado.
api-version	query	True	string	Versão da API de Cliente.
stringIndexType	query	True	StringIndexType	Especifica o método utilizado para interpretar desvios de cadeia. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	O número máximo de recursos a incluir numa única resposta.
skip	query		integer int32	Um desvio para a coleção do primeiro recurso a ser devolvido.
top	query		integer int32	O número máximo de recursos a devolver da coleção.

Respostas

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

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta o Trabalho, a Escola e os Convidados, mas não suporta contas Pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Type: apiKey
In: header

Exemplos

Successful Get Model Evaluation

Sample Request

HTTP

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

Sample Response

Status code:: 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

Name	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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	O tipo de projeto.
StringIndexType	Especifica o método utilizado para interpretar desvios de cadeia. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de reconhecimento de entidades personalizado.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de classificação de várias etiquetas personalizado.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Representa o resultado da avaliação do documento para um projeto de classificação de etiqueta única personalizado.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Representa uma etiqueta de entidade de resultado de avaliação.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa o resultado da avaliação do reconhecimento de entidades de um documento.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Representa a comparação de avaliação entre as entidades esperadas e previstas de uma região do 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 a classe 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.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 por humanos do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

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

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Name	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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
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.

Name	Tipo	Description
CustomEntityRecognition	string	Para criar um modelo de extração para identificar as categorias de domínio com os seus próprios dados.
CustomMultiLabelClassification	string	Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro pode ter uma ou muitas etiquetas. Por exemplo, o ficheiro 1 é classificado como A, B e C e o ficheiro 2 é classificado como B e C.
CustomSingleLabelClassification	string	Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro terá apenas uma etiqueta. Por exemplo, o ficheiro 1 é classificado como A e o ficheiro 2 é classificado como B.

StringIndexType

Especifica o método utilizado para interpretar desvios de cadeia. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Name	Tipo	Description
Utf16CodeUnit	string	Os valores de desvio e comprimento corresponderão a unidades de código UTF-16. Utilize esta opção se a sua aplicação estiver escrita numa linguagem que suporte Unicode, por exemplo Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

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

Name	Tipo	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa a predição de avaliação para o reconhecimento de entidades.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, utilize "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árias etiquetas personalizado.

Name	Tipo	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa a predição de avaliação para a classificação de várias etiquetas.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, utilize "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 etiqueta única personalizado.

Name	Tipo	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa a predição de avaliação para a classificação de etiqueta única.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de um idioma. Por exemplo, utilize "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 uma etiqueta de entidade de resultado de avaliação.

Name	Tipo	Description
category	string	Representa a categoria de entidade.
length	integer	Representa o comprimento da entidade.
offset	integer	Representa o índice de desvio da entidade relativamente ao texto original.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Representa o resultado da avaliação do reconhecimento de entidades de um documento.

Name	Tipo	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Representa as entidades identificadas pelo documento.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

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

Name	Tipo	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa as etiquetas de entidade esperadas da região.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa as etiquetas de entidade previstas da região.
regionLength	integer	Representa o comprimento da região.
regionOffset	integer	Representa o desvio da região.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

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

Name	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 a classe prevista resultante de uma operação de avaliação.

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

Name	Tipo	Description
nextLink	string	A ligação da página seguinte.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Lista de resultados de avaliação de documentos.

Partilhar via