Text Analysis Authoring - Import

Referência

Serviço:: Azure AI Services

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

Dispara um trabalho para importar um projeto. Se já existir um projeto com o mesmo nome, os dados desse projeto serão substituídos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string url	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.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
metadata	True	CreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	True	string	A versão do arquivo exportado.
stringIndexType	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.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os ativos do projeto.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Description

202 Accepted

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

SuccessfulImportProject

Solicitação de exemplo

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
              }
            ]
          }
        ]
      }
    ]
  }
}

Resposta de exemplo

Código de status:: 202

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

Definições

Nome	Description
CreateProjectOptions	Representa as opções usadas para criar ou atualizar um projeto.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
ExportedProject	Representa um projeto exportado.
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
ProjectSettings	Representa as configurações usadas para definir o comportamento do projeto.
StringIndexType
TextAnalysisAuthoringExportedClass	Representa uma classe de um projeto exportado.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Representa um documento exportado para um projeto de reconhecimento de entidade personalizado.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Representa os ativos exportados para um projeto de reconhecimento de entidade.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Representa um documento exportado de um projeto de classificação de vários rótulos personalizado.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Representa os ativos exportados para um projeto de classificação de vários rótulos personalizado.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Representa um documento exportado para um projeto de classificação de rótulo único personalizado.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os ativos exportados para um projeto de classificação de rótulo único.
TextAnalysisAuthoringExportedDocumentClass	Representa um rótulo de classificação para um documento.
TextAnalysisAuthoringExportedDocumentEntityLabel	Representa um rótulo de entidade para um documento.
TextAnalysisAuthoringExportedDocumentEntityRegion	Representa uma região em um documento para rotulagem de entidade.
TextAnalysisAuthoringExportedEntity	Representa uma entidade em um projeto exportado.

CreateProjectOptions

Representa as opções usadas para criar ou atualizar um projeto.

Nome	Tipo	Description
description	string	A descrição do projeto.
language	string	A linguagem do projeto. 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.
multilingual	boolean	Se o projeto seria usado para vários idiomas ou não.
projectKind	ProjectKind	O tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ProjectSettings	As configurações do projeto.
storageInputContainerName	string	O nome do contêiner de armazenamento.

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 ser humano 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.

ExportedProject

Representa um projeto exportado.

Nome	Tipo	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os ativos do projeto.
metadata	CreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	string	A versão do arquivo exportado.
stringIndexType	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.

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 de erro.

ProjectKind

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 são classificados 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.

ProjectSettings

Representa as configurações usadas para definir o comportamento do projeto.

Nome	Tipo	Description
confidenceThreshold	number	O limite da classe com a maior confiança, no qual a previsão será automaticamente alterada para "Nenhum". O valor do limite deve estar entre 0 e 1, inclusive.

StringIndexType

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 ao Unicode, por exemplo Java, JavaScript.

TextAnalysisAuthoringExportedClass

Representa uma classe de um projeto exportado.

Nome	Tipo	Description
category	string	A categoria de classe.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Representa um documento exportado para um projeto de reconhecimento de entidade personalizado.

Nome	Tipo	Description
dataset	string	O conjunto de dados deste documento. Os valores permitidos são 'Treinar' e 'Testar'.
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	A lista de rótulos de entidade que pertencem ao documento.
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	O local do documento no armazenamento.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Representa os ativos exportados para um projeto de reconhecimento de entidade.

Nome	Tipo	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	A lista de documentos que pertencem ao projeto.
entities	TextAnalysisAuthoringExportedEntity[]	A lista de entidades que pertencem ao projeto.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Representa um documento exportado de um projeto de classificação de vários rótulos personalizado.

Nome	Tipo	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	As classes de documento.
dataset	string	O conjunto de dados deste documento. Os valores permitidos são 'Treinar' e 'Testar'.
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	O local do documento no armazenamento.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Representa os ativos exportados para um projeto de classificação de vários rótulos personalizado.

Nome	Tipo	Description
classes	TextAnalysisAuthoringExportedClass[]	A lista de classes no projeto.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	A lista de documentos no projeto.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Representa um documento exportado para um projeto de classificação de rótulo único personalizado.

Nome	Tipo	Description
class	TextAnalysisAuthoringExportedDocumentClass	A classe dos documentos.
dataset	string	O conjunto de dados deste documento. Os valores permitidos são 'Treinar' e 'Testar'.
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	O local do documento no armazenamento.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Representa os ativos exportados para um projeto de classificação de rótulo único.

Nome	Tipo	Description
classes	TextAnalysisAuthoringExportedClass[]	A lista de classes que pertencem a este projeto.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	A lista de documentos que pertencem a este projeto.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Representa um rótulo de classificação para um documento.

Nome	Tipo	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Representa um rótulo de entidade para um documento.

Nome	Tipo	Description
category	string	A categoria de entidade.
length	integer	Comprimento do texto da entidade.
offset	integer	Posição inicial do texto da entidade.

TextAnalysisAuthoringExportedDocumentEntityRegion

Representa uma região em um documento para rotulagem de entidade.

Nome	Tipo	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	A lista de rótulos de entidade que pertencem a essa região.
regionLength	integer	Comprimento do texto da região.
regionOffset	integer	Posição inicial para a região.

TextAnalysisAuthoringExportedEntity

Representa uma entidade em um projeto exportado.

Nome	Tipo	Description
category	string	A categoria de entidade.

Compartilhar via

Text Analysis Authoring - Import

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

SuccessfulImportProject

Solicitação de exemplo

Resposta de exemplo

Definições

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Recursos adicionais