Text Analysis Authoring - Get Model Evaluation Results

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2022-05-01

Obtiene los resultados detallados de la evaluación de un modelo entrenado. Esto incluye los resultados de inferencia sin procesar para los datos incluidos en el proceso de evaluación.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
trainedModelLabel	path	True	string	Etiqueta del modelo entrenado.
api-version	query	True	string	Versión de la API de cliente.
stringIndexType	query	True	StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer (int32)	Número máximo de recursos que se van a incluir en una única respuesta.
skip	query		integer (int32)	Desplazamiento en la colección del primer recurso que se va a devolver.
top	query		integer (int32)	Número máximo de recursos que se van a devolver de la colección.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Una clave de suscripción para un recurso de servicio de lenguaje.

Respuestas

Nombre	Tipo	Description
200 OK	TextAnalysisAuthoringEvaluationResults	Lista de los resultados de la evaluación.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful Get Model Evaluation

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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=2022-05-01&top=2147483645&skip=2&maxpagesize=2"
}

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Tipo de proyecto.
StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Representa el resultado de evaluación del documento para un proyecto de reconocimiento de entidades personalizado.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Representa el resultado de evaluación del documento para un proyecto de clasificación de varias etiquetas personalizado.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Representa el resultado de evaluación del documento para un proyecto de clasificación de una sola etiqueta personalizada.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Representa una etiqueta de entidad de resultado de evaluación.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa el resultado de evaluación del reconocimiento de entidades para un documento.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Representa la comparación de evaluación entre las entidades esperadas y predichas de una región de documento.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa la comparación entre las clases esperadas y predichas resultantes de la operación de evaluación.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa la comparación entre la clase esperada y predicha resultante de una operación de evaluación.
TextAnalysisAuthoringEvaluationResults	Representa una lista de resultados para una operación de evaluación.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

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

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

ProjectKind

Enumeración

Tipo de proyecto.

Valor	Description
CustomEntityRecognition	Para crear un modelo de extracción para identificar las categorías de dominio mediante sus propios datos.
CustomMultiLabelClassification	Para crear un modelo de clasificación para clasificar texto mediante sus propios datos. Cada archivo puede tener una o varias etiquetas. Por ejemplo, el archivo 1 se clasifica como A, B y C y el archivo 2 se clasifican como B y C.
CustomSingleLabelClassification	Para crear un modelo de clasificación para clasificar texto mediante sus propios datos. Cada archivo solo tendrá una etiqueta. Por ejemplo, el archivo 1 se clasifica como A y el archivo 2 se clasifica como B.

StringIndexType

Enumeración

Especifica el método utilizado para interpretar los desplazamientos de cadena. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.

Valor	Description
Utf16CodeUnit	Los valores de desplazamiento y longitud se corresponden con unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Object

Representa el resultado de evaluación del documento para un proyecto de reconocimiento de entidades personalizado.

Nombre	Tipo	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representa la predicción de evaluación para el reconocimiento de entidades.
language	string	Representa el idioma del documento. Esta es la representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.
location	string	Representa la ruta de acceso del documento.
projectKind	string: CustomEntityRecognition	Representa el tipo de proyecto.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Object

Representa el resultado de evaluación del documento para un proyecto de clasificación de varias etiquetas personalizado.

Nombre	Tipo	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representa la predicción de evaluación para la clasificación de varias etiquetas.
language	string	Representa el idioma del documento. Esta es la representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.
location	string	Representa la ruta de acceso del documento.
projectKind	string: CustomMultiLabelClassification	Representa el tipo de proyecto.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Object

Representa el resultado de evaluación del documento para un proyecto de clasificación de una sola etiqueta personalizada.

Nombre	Tipo	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representa la predicción de evaluación para la clasificación de etiquetas únicas.
language	string	Representa el idioma del documento. Esta es la representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.
location	string	Representa la ruta de acceso del documento.
projectKind	string: CustomSingleLabelClassification	Representa el tipo de proyecto.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Object

Representa una etiqueta de entidad de resultado de evaluación.

Nombre	Tipo	Description
category	string	Representa la categoría de entidad.
length	integer (int32)	Representa la longitud de la entidad.
offset	integer (int32)	Representa el índice de desplazamiento de entidad en relación con el texto original.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Object

Representa el resultado de evaluación del reconocimiento de entidades para un documento.

Nombre	Tipo	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Representa las entidades etiquetadas por el documento.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Object

Representa la comparación de evaluación entre las entidades esperadas y predichas de una región de documento.

Nombre	Tipo	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa las etiquetas de entidad esperadas de la región.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representa las etiquetas de entidad predichas de la región.
regionLength	integer (int32)	Representa la longitud de la región.
regionOffset	integer (int32)	Representa el desplazamiento de región.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Object

Representa la comparación entre las clases esperadas y predichas resultantes de la operación de evaluación.

Nombre	Tipo	Description
expectedClasses	string[]	Representa las clases esperadas del documento.
predictedClasses	string[]	Representa las clases predichas del documento.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Object

Representa la comparación entre la clase esperada y predicha resultante de una operación de evaluación.

Nombre	Tipo	Description
expectedClass	string	Representa la clase esperada del documento.
predictedClass	string	Representa la clase predicha del documento.

TextAnalysisAuthoringEvaluationResults

Object

Representa una lista de resultados para una operación de evaluación.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Lista de documentos de resultados de evaluación.

Compartir a través de

Text Analysis Authoring - Get Model Evaluation Results

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Successful Get Model Evaluation

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

TextAnalysisAuthoringEvaluationResults

Recursos adicionales