Text Analysis Authoring - Import

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Aciona uma tarefa 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	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	True	string	A versão do ficheiro exportado.
stringIndexType	True	StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os recursos do projeto.

Respostas

Name	Tipo	Description
202 Accepted		Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Headers operation-location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Type: apiKey
In: header

Exemplos

Successful Import Project

Sample Request

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

Sample Response

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

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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	O tipo de projeto.
StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	Representa as opções utilizadas 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 entidades personalizado.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Representa os recursos exportados para um projeto de reconhecimento de entidades.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Representa um documento exportado de um projeto de classificação de várias etiquetas personalizado.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Representa os recursos exportados para um projeto de classificação de várias etiquetas personalizado.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Representa um documento exportado para um projeto de classificação de etiqueta única personalizado.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os recursos exportados para um projeto de classificação de etiqueta única.
TextAnalysisAuthoringExportedDocumentClass	Representa uma etiqueta de classificação para um documento.
TextAnalysisAuthoringExportedDocumentEntityLabel	Representa uma etiqueta de entidade para um documento.
TextAnalysisAuthoringExportedDocumentRegion	Representa uma região num documento para etiquetagem de entidades.
TextAnalysisAuthoringExportedEntity	Representa uma entidade num projeto exportado.
TextAnalysisAuthoringExportedProject	Representa um projeto exportado.
TextAnalysisAuthoringProjectSettings	Representa as definições utilizadas para definir o comportamento do projeto.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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 destino 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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos 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	Destino do erro.

ProjectKind

O tipo de projeto.

Name	Tipo	Description
CustomEntityRecognition	string	Para criar um modelo de extração para identificar as categorias de domínio com os seus próprios dados.
CustomMultiLabelClassification	string	Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro pode ter uma ou muitas etiquetas. Por exemplo, o ficheiro 1 é classificado como A, B e C e o ficheiro 2 é classificado como B e C.
CustomSingleLabelClassification	string	Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro terá apenas uma etiqueta. Por exemplo, o ficheiro 1 é classificado como A e o ficheiro 2 é classificado como B.

StringIndexType

Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Name	Tipo	Description
Utf16CodeUnit	string	Os valores de desvio e comprimento corresponderão às unidades de código UTF-16. Utilize esta opção se a sua aplicação estiver escrita num idioma que suporte Unicode, por exemplo Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

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

Name	Tipo	Description
description	string	A descrição do projeto.
language	string	O idioma do projeto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
multilingual	boolean	Se o projeto seria ou não utilizado para vários idiomas.
projectKind	ProjectKind	O tipo de projeto.
projectName	string	O novo nome do projeto.
settings	TextAnalysisAuthoringProjectSettings	As definições do projeto.
storageInputContainerName	string	O nome do contentor de armazenamento.

TextAnalysisAuthoringExportedClass

Representa uma classe de um projeto exportado.

Name	Tipo	Description
category	string	A categoria de classe.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

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

Name	Tipo	Description
dataset	string	O conjunto de dados deste documento. Os valores permitidos são "Train" e "Test".
entities	TextAnalysisAuthoringExportedDocumentRegion[]	A lista de etiquetas de entidades pertencentes ao documento.
language	string	Representa o idioma do documento. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "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 recursos exportados para um projeto de reconhecimento de entidades.

Name	Tipo	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	A lista de documentos pertencentes ao projeto.
entities	TextAnalysisAuthoringExportedEntity[]	A lista de entidades pertencentes ao projeto.
projectKind	string: CustomEntityRecognition	O tipo de projeto a que os recursos pertencem.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Representa um documento exportado de um projeto de classificação de várias etiquetas personalizado.

Name	Tipo	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	As classes de documentos.
dataset	string	O conjunto de dados deste documento. Os valores permitidos são "Train" e "Test".
language	string	Representa o idioma do documento. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "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 recursos exportados para um projeto de classificação de várias etiquetas personalizado.

Name	Tipo	Description
classes	TextAnalysisAuthoringExportedClass[]	A lista de classes no projeto.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	A lista de documentos no projeto.
projectKind	string: CustomMultiLabelClassification	O tipo de projeto a que os recursos pertencem.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Representa um documento exportado para um projeto de classificação de etiqueta única personalizado.

Name	Tipo	Description
class	TextAnalysisAuthoringExportedDocumentClass	A classe dos documentos.
dataset	string	O conjunto de dados deste documento. Os valores permitidos são "Train" e "Test".
language	string	Representa o idioma do documento. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "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 recursos exportados para um projeto de classificação de etiqueta única.

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	O tipo de projeto a que os recursos pertencem.

TextAnalysisAuthoringExportedDocumentClass

Representa uma etiqueta de classificação para um documento.

Name	Tipo	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Representa uma etiqueta 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 de início para o texto da entidade.

TextAnalysisAuthoringExportedDocumentRegion

Representa uma região num documento para etiquetagem de entidades.

Name	Tipo	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	A lista de etiquetas de entidades pertencentes a esta região.
regionLength	integer	Comprimento do texto da região.
regionOffset	integer	Posição de início para a região.

TextAnalysisAuthoringExportedEntity

Representa uma entidade num projeto exportado.

Name	Tipo	Description
category	string	A categoria de entidade.

TextAnalysisAuthoringExportedProject

Representa um projeto exportado.

Name	Tipo	Description
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representa os recursos do projeto.
metadata	TextAnalysisAuthoringCreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	string	A versão do ficheiro exportado.
stringIndexType	StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

TextAnalysisAuthoringProjectSettings

Representa as definições utilizadas para definir o comportamento do projeto.

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

Partilhar via

Text Analysis Authoring - Import

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

Ocp-Apim-Subscription-Key

Exemplos

Successful Import Project

Sample Request

Sample Response

Definições

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject

TextAnalysisAuthoringProjectSettings

Recursos adicionais