Text Analysis Authoring - Import

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

Desencadena un trabajo para importar un proyecto. Si ya existe un proyecto con el mismo nombre, se reemplazan los datos de ese proyecto.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?api-version=2023-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string url	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
metadata	True	CreateProjectOptions	Representa los metadatos del proyecto.
projectFileVersion	True	string	Versión del archivo exportado.
stringIndexType	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.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa los recursos del proyecto.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

202 Accepted

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Operation-Location: string

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

SuccessfulImportProject

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:import?api-version=2023-04-01

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "projectName": "LoanAgreements",
    "multilingual": false,
    "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
    "language": "en"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

Respuesta de muestra

status code:: 202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definiciones

Nombre	Description
CreateProjectOptions	Representa las opciones usadas para crear o actualizar un proyecto.
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
ExportedProject	Representa un proyecto exportado.
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
ProjectSettings	Representa la configuración utilizada para definir el comportamiento del proyecto.
StringIndexType
TextAnalysisAuthoringExportedClass	Representa una clase de un proyecto exportado.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Representa un documento exportado para un proyecto de reconocimiento de entidades personalizado.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Representa los recursos exportados para un proyecto de reconocimiento de entidades.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Representa un documento exportado de un proyecto de clasificación de varias etiquetas personalizado.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Representa los recursos exportados para un proyecto de clasificación de varias etiquetas personalizado.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Representa un documento exportado para un proyecto de clasificación de una sola etiqueta personalizada.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa los recursos exportados para un proyecto de clasificación de una sola etiqueta.
TextAnalysisAuthoringExportedDocumentClass	Representa una etiqueta de clasificación para un documento.
TextAnalysisAuthoringExportedDocumentEntityLabel	Representa una etiqueta de entidad para un documento.
TextAnalysisAuthoringExportedDocumentEntityRegion	Representa una región de un documento para el etiquetado de entidades.
TextAnalysisAuthoringExportedEntity	Representa una entidad en un proyecto exportado.

CreateProjectOptions

Representa las opciones usadas para crear o actualizar un proyecto.

Nombre	Tipo	Description
description	string	Descripción del proyecto.
language	string	Lenguaje del proyecto. 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.
multilingual	boolean	Si el proyecto se usaría para varios lenguajes o no.
projectKind	ProjectKind	Tipo de proyecto.
projectName	string	Nombre del nuevo proyecto.
settings	ProjectSettings	Configuración del proyecto.
storageInputContainerName	string	Nombre del contenedor de almacenamiento.

Error

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

Código de error legible para personas.

Nombre	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

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

ExportedProject

Representa un proyecto exportado.

Nombre	Tipo	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa los recursos del proyecto.
metadata	CreateProjectOptions	Representa los metadatos del proyecto.
projectFileVersion	string	Versión del archivo exportado.
stringIndexType	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.

InnerErrorCode

Código de error legible para personas.

Nombre	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

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

Nombre	Tipo	Description
CustomEntityRecognition	string	Para crear un modelo de extracción para identificar las categorías de dominio mediante sus propios datos.
CustomMultiLabelClassification	string	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	string	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.

ProjectSettings

Representa la configuración utilizada para definir el comportamiento del proyecto.

Nombre	Tipo	Description
confidenceThreshold	number	Umbral de la clase con la mayor confianza, en la que la predicción se cambiará automáticamente a "None". El valor del umbral debe estar comprendido entre 0 y 1 inclusive.

StringIndexType

Nombre	Tipo	Description
Utf16CodeUnit	string	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.

TextAnalysisAuthoringExportedClass

Representa una clase de un proyecto exportado.

Nombre	Tipo	Description
category	string	Categoría de clase.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Representa un documento exportado para un proyecto de reconocimiento de entidades personalizado.

Nombre	Tipo	Description
dataset	string	Conjunto de datos de este documento. Los valores permitidos son "Train" y "Test".
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Lista de etiquetas de entidad que pertenecen al documento.
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	Ubicación del documento en el almacenamiento.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Representa los recursos exportados para un proyecto de reconocimiento de entidades.

Nombre	Tipo	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Lista de documentos que pertenecen al proyecto.
entities	TextAnalysisAuthoringExportedEntity[]	Lista de entidades que pertenecen al proyecto.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Representa un documento exportado de un proyecto de clasificación de varias etiquetas personalizado.

Nombre	Tipo	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	Clases de documento.
dataset	string	Conjunto de datos de este documento. Los valores permitidos son "Train" y "Test".
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	Ubicación del documento en el almacenamiento.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Representa los recursos exportados para un proyecto de clasificación de varias etiquetas personalizado.

Nombre	Tipo	Description
classes	TextAnalysisAuthoringExportedClass[]	Lista de clases del proyecto.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Lista de documentos del proyecto.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Representa un documento exportado para un proyecto de clasificación de una sola etiqueta personalizada.

Nombre	Tipo	Description
class	TextAnalysisAuthoringExportedDocumentClass	Clase de los documentos.
dataset	string	Conjunto de datos de este documento. Los valores permitidos son "Train" y "Test".
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	Ubicación del documento en el almacenamiento.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Representa los recursos exportados para un proyecto de clasificación de una sola etiqueta.

Nombre	Tipo	Description
classes	TextAnalysisAuthoringExportedClass[]	Lista de clases que pertenecen a este proyecto.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Lista de documentos que pertenecen a este proyecto.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Representa una etiqueta de clasificación para un documento.

Nombre	Tipo	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Representa una etiqueta de entidad para un documento.

Nombre	Tipo	Description
category	string	Categoría de entidad.
length	integer	Longitud del texto de la entidad.
offset	integer	Posición inicial del texto de la entidad.

TextAnalysisAuthoringExportedDocumentEntityRegion

Representa una región de un documento para el etiquetado de entidades.

Nombre	Tipo	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Lista de etiquetas de entidad que pertenecen a esta región.
regionLength	integer	Longitud del texto de la región.
regionOffset	integer	Posición inicial de la región.

TextAnalysisAuthoringExportedEntity

Representa una entidad en un proyecto exportado.

Nombre	Tipo	Description
category	string	Categoría de entidad.

Compartir a través de

Text Analysis Authoring - Import

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

SuccessfulImportProject

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Recursos adicionales