Text Analysis Authoring - Import

Referência

Serviço:: Azure AI Services

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

Aciona 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 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 nome do projeto a ser usado.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	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

Name	Tipo	Description
202 Accepted		O pedido foi aceite 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.

Name

Tipo

Description

202 Accepted

O pedido foi aceite 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
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

SuccessfulImportProject

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
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
TextAnalysisAuthoringCreateProjectOptions	Representa as opções usadas para criar ou atualizar um projeto.
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 multirótulo personalizado.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Representa os ativos exportados para um projeto de classificação multirótulo 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.

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.

ExportedProject

Representa um projeto exportado.

Name	Tipo	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os ativos do projeto.
metadata	TextAnalysisAuthoringCreateProjectOptions	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.

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.

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.

ProjectSettings

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

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

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.

TextAnalysisAuthoringCreateProjectOptions

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

Name	Tipo	Description
description	string	A descrição do projeto.
language	string	A linguagem do projeto. 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.
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.

TextAnalysisAuthoringExportedClass

Representa uma classe de um projeto exportado.

Name	Tipo	Description
category	string	A categoria da classe.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

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

Name	Tipo	Description
dataset	string	O conjunto de dados para este documento. Os valores permitidos são «Comboio» e «Teste».
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	A lista de rótulos de entidade pertencentes ao documento.
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	A localização do documento no armazenamento.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

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

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

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Representa um documento exportado de um projeto de classificação multirótulo personalizado.

Name	Tipo	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	As classes de documento.
dataset	string	O conjunto de dados para este documento. Os valores permitidos são «Comboio» e «Teste».
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	A localização do documento no armazenamento.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Representa os ativos exportados para um projeto de classificação multirótulo personalizado.

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

Name	Tipo	Description
class	TextAnalysisAuthoringExportedDocumentClass	A classe dos documentos.
dataset	string	O conjunto de dados para este documento. Os valores permitidos são «Comboio» e «Teste».
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	A localização do documento no armazenamento.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

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

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

TextAnalysisAuthoringExportedDocumentClass

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

Name	Tipo	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Representa um rótulo de entidade para um documento.

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

TextAnalysisAuthoringExportedDocumentEntityRegion

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

Name	Tipo	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	A lista de rótulos de entidades pertencentes a esta 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.

Name	Tipo	Description
category	string	A categoria de entidade.

Partilhar via

Text Analysis Authoring - Import

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

SuccessfulImportProject

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Recursos adicionais