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 para um modelo treinado. Isto inclui os resultados brutos da inferência para os dados incluídos no processo de avaliação.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string url	Ponto de extremidade de Serviços Cognitivos suportado, por exemplo, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	O novo nome do projeto.
trainedModelLabel	path	True	string	O rótulo do modelo treinado.
api-version	query	True	string	A versão da API a ser usada para esta operação.
stringIndexType	query	True	StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	O número máximo de itens de resultado por página.
skip	query		integer int32	O número de itens de resultado a serem ignorados.
top	query		integer int32	O número de itens de resultado a serem devolvidos.

Respostas

Name	Tipo	Description
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

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

SuccessfulGetModelEvaluation

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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": "https://api.example.com/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-15-preview&top=2147483645&skip=100&maxpagesize=100"
}

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 API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	Coleção paginada de itens TextAnalysisAuthoringDocumentEvaluationResult
ProjectKind
StringIndexType
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 multirótulo 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 da 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 que resultam da operação de avaliação.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa a comparação entre a classe esperada e prevista que resulta de uma operação de avaliação.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo 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 API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido 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	Alvo de erro.

PagedTextAnalysisAuthoringDocumentEvaluationResult

Coleção paginada de itens TextAnalysisAuthoringDocumentEvaluationResult

Name	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Os itens TextAnalysisAuthoringDocumentEvaluationResult nesta página

ProjectKind

Name	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 texto usando seus próprios dados. Cada ficheiro pode ter uma ou várias etiquetas. 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 texto usando seus próprios dados. Cada ficheiro terá apenas uma etiqueta. Por exemplo, o arquivo 1 é classificado como A e o arquivo 2 é classificado como B.

StringIndexType

Name	Tipo	Description
Utf16CodeUnit	string	Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

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

Name	Tipo	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa a previsão de avaliação para reconhecimento da entidade.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de uma língua. 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 multirótulo personalizado.

Name	Tipo	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa a previsão de avaliação para classificação multirótulo.
language	string	Representa o idioma do documento. Esta é a representação BCP-47 de uma língua. 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.

Name	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 uma língua. 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.

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

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

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

Name	Tipo	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Representa as entidades rotuladas do documento.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

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

Name	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 que resultam 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 prevista que resulta 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.

Partilhar via