Text Analysis Runtime - Analyze Text

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Pedir análise de texto sobre uma coleção de documentos.

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

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

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).
api-version	query	True	string	A versão da API a utilizar para esta operação.
showStats	query		boolean	(Opcional) se definido como verdadeiro, a resposta conterá estatísticas de pedidos e ao nível do documento.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name	Description
AnalyzeTextEntityLinkingInput	Contém o texto Analisar Entrada de ligação de entidade.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidades analisa o pedido de tarefa de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contém a entrada da tarefa Analisar Texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contém a entrada da tarefa de análise de documentos de deteção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa ANALISAR TEXTO PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém o texto de análise SentimentAnalysis task input.

AnalyzeTextEntityLinkingInput

Contém o texto Analisar Entrada de ligação de entidade.

Name	Necessário	Tipo	Description
kind	True	string: EntityLinking	O tipo de tarefa a executar.
analysisInput		MultiLanguageAnalysisInput	Contém a entrada de análise a processar pelo serviço.
parameters		EntityLinkingTaskParameters	Parâmetros da tarefa.

AnalyzeTextEntityRecognitionInput

O reconhecimento de entidades analisa o pedido de tarefa de entrada de texto.

Name	Necessário	Tipo	Description
kind	True	string: EntityRecognition	O tipo de tarefa a executar.
analysisInput		MultiLanguageAnalysisInput	A entrada a ser analisada.
parameters		EntitiesTaskParameters	Parâmetros da tarefa.

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar Texto KeyPhraseExtraction.

Name	Necessário	Tipo	Description
kind	True	string: KeyPhraseExtraction	O tipo de tarefa a executar.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		KeyPhraseTaskParameters	Parâmetros da tarefa de extração de expressões-chave.

AnalyzeTextLanguageDetectionInput

Contém a entrada da tarefa de análise de documentos de deteção de idioma.

Name	Necessário	Tipo	Description
kind	True	string: LanguageDetection	O tipo de tarefa a executar.
analysisInput		LanguageDetectionAnalysisInput	Documentos a analisar.
parameters		LanguageDetectionTaskParameters	parâmetros de tarefas.

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa ANALISAR TEXTO PIIEntityRecognition.

Name	Necessário	Tipo	Description
kind	True	string: PiiEntityRecognition	O tipo de tarefa a executar.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		PiiTaskParameters	Parâmetros de tarefa pii.

AnalyzeTextSentimentAnalysisInput

Contém o texto de análise SentimentAnalysis task input.

Name	Necessário	Tipo	Description
kind	True	string: SentimentAnalysis	O tipo de tarefa a executar.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		SentimentAnalysisTaskParameters	Parâmetros de tarefas de Análise de Sentimentos.

Respostas

Name	Tipo	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Headers x-ms-error-code: string

Name

Tipo

Description

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

O pedido foi bem-sucedido.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Headers

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

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


{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

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


{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

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


{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

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


{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-05"
  }
}

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

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


{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

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


{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definições

Name	Description
AnalyzeTextEntityLinkingInput	Contém o texto de análise Entrada de ligação de entidade.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidades analisa o pedido de tarefa de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contém a entrada da tarefa de análise de documentos de deteção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa ANALISAR TEXTO PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém o texto de análise SentimentAnalysis task input.
AnalyzeTextTaskKind	O tipo de tarefas analyze-text suportadas.
AnalyzeTextTaskResultsKind	O tipo de objeto de resposta devolvido pela tarefa analyze-text.
DetectedLanguage	Contém os detalhes do idioma detetado para o texto.
DocumentError	Contém detalhes dos erros encontrados durante a execução de uma tarefa.
DocumentSentimentValue	Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).
DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo irá conter informações sobre o payload do documento.
DocumentWarning	Contém o objeto de avisos com avisos encontrados para o documento processado.
EntitiesDocumentResult	Contém o resultado da tarefa de reconhecimento de entidades do documento.
EntitiesResult	Contém o resultado da tarefa de reconhecimento de entidades.
EntitiesTaskParameters	Parâmetros suportados para uma tarefa de Reconhecimento de Entidades.
EntitiesTaskResult	Contém a tarefa de entidade
Entity	Define o objeto de entidade detetado que contém a categoria de entidade e o texto de entidade detetado, etc.
EntityLinkingResult	Resultado de associação de entidades.
EntityLinkingTaskParameters	Parâmetros suportados para uma tarefa de Associação de Entidades.
EntityLinkingTaskResult	Contém o resultado da tarefa analisar texto Entidade que liga a tarefa.
Error	O objeto de resposta de erro devolvido quando o serviço encontra alguns erros durante o processamento do pedido.
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.
KeyPhraseResult	Contém o KeyPhraseResult.
KeyPhrasesDocumentResult	Contém os resultados de extração de expressões-chave de um documento.
KeyPhraseTaskParameters	Parâmetros suportados para uma tarefa de Extração de Expressões-Chave.
KeyPhraseTaskResult	Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contém a entrada de análise do documento de deteção de idioma.
LanguageDetectionDocumentResult	Contém a deteção de idioma de um documento.
LanguageDetectionResult	Contém o resultado da deteção de idioma para o pedido.
LanguageDetectionTaskParameters	Parâmetros suportados para uma tarefa de Deteção de Idiomas.
LanguageDetectionTaskResult	Contém o resultado da tarefa de deteção de idioma para o pedido.
LanguageInput	Contém a entrada de deteção de idioma.
LinkedEntitiesDocumentResult	Entidade que liga o resultado do documento.
LinkedEntity	O objeto LinkedEntity que contém a entidade detetada com as origens/ligações associadas.
Match	O objeto Match que contém o texto de entidade detetado com o desvio e o comprimento.
MultiLanguageAnalysisInput	Coleção de documentos de entrada a analisar pelo serviço.
MultiLanguageInput	Contém um documento de entrada a analisar pelo serviço.
PiiCategory	(Opcional) descreve as categorias PII a devolver
PiiDomain	Domain for PII task (Domínio para tarefa PII)
PiiEntitiesDocumentResult	Contém os resultados do PII.
PiiResult	Contém o PiiResult.
PiiTaskParameters	Parâmetros suportados para uma tarefa de Reconhecimento de Entidades PII.
PiiTaskResult	Contém o texto de análise PIIEntityRecognition LRO task.
RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.
SentenceAssessment	Representa uma avaliação de frases e as avaliações ou objetos de destino relacionados com a mesma.
SentenceSentiment	O sentimento de frase de um documento.
SentenceSentimentValue	O Sentimento previsto para a frase.
SentenceTarget	Representa um destino de frase e as avaliações ou objetos de destino relacionados com a mesma.
SentimentAnalysisTaskParameters	Parâmetros suportados para uma tarefa de Análise de Sentimentos.
SentimentConfidenceScores	Representa as classificações de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.
SentimentDocumentResult	Um objeto que representa os resultados pré-criados da Análise de Sentimentos de cada documento.
SentimentResponse	Resultados da análise de sentimentos para os documentos de entrada.
SentimentTaskResult	Contém o texto de análise SentimentAnalysis LRO task result.
StringIndexType	Tipo de índice de cadeia
TargetConfidenceScoreLabel	Representa as classificações de confiança em todas as classes de sentimento: positivas e negativas.
TargetRelation	Representa a relação entre avaliações e/ou destinos.
TargetRelationType	O tipo relacionado com o destino.
TokenSentimentValue	O Sentimento previsto para a frase.
WarningCodeValue	Define a lista dos códigos de aviso.

AnalyzeTextEntityLinkingInput

Contém o texto de análise Entrada de ligação de entidade.

Name	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém a entrada de análise a processar pelo serviço.
kind	string: EntityLinking	O tipo de tarefa a executar.
parameters	EntityLinkingTaskParameters	Parâmetros de tarefas.

AnalyzeTextEntityRecognitionInput

O reconhecimento de entidades analisa o pedido de tarefa de entrada de texto.

Name	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	A entrada a analisar.
kind	string: EntityRecognition	O tipo de tarefa a executar.
parameters	EntitiesTaskParameters	Parâmetros de tarefas.

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.

Name	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: KeyPhraseExtraction	O tipo de tarefa a executar.
parameters	KeyPhraseTaskParameters	Parâmetros da tarefa de extração de expressões-chave.

AnalyzeTextLanguageDetectionInput

Contém a entrada da tarefa de análise de documentos de deteção de idioma.

Name	Tipo	Description
analysisInput	LanguageDetectionAnalysisInput	Documentos a analisar.
kind	string: LanguageDetection	O tipo de tarefa a executar.
parameters	LanguageDetectionTaskParameters	parâmetros de tarefas.

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa ANALISAR TEXTO PIIEntityRecognition.

Name	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: PiiEntityRecognition	O tipo de tarefa a executar.
parameters	PiiTaskParameters	Parâmetros de tarefa pii.

AnalyzeTextSentimentAnalysisInput

Contém o texto de análise SentimentAnalysis task input.

Name	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: SentimentAnalysis	O tipo de tarefa a executar.
parameters	SentimentAnalysisTaskParameters	Parâmetros de tarefas de Análise de Sentimentos.

AnalyzeTextTaskKind

O tipo de tarefas analyze-text suportadas.

Name	Tipo	Description
EntityLinking	string	Tarefa de associação de entidades
EntityRecognition	string	Tarefa de reconhecimento de entidades
KeyPhraseExtraction	string	Tarefa de extração de expressões-chave
LanguageDetection	string	Tarefa de deteção de idioma
PiiEntityRecognition	string	Tarefa de reconhecimento de entidades PII
SentimentAnalysis	string	Tarefa de análise de sentimentos

AnalyzeTextTaskResultsKind

O tipo de objeto de resposta devolvido pela tarefa analyze-text.

Name	Tipo	Description
EntityLinkingResults	string	Resultados de associação de entidades
EntityRecognitionResults	string	Resultados do reconhecimento de entidades
KeyPhraseExtractionResults	string	Resultados de extração de expressões-chave
LanguageDetectionResults	string	Resultados da deteção de idioma
PiiEntityRecognitionResults	string	Resultados do reconhecimento de entidades PII
SentimentAnalysisResults	string	Resultados da análise de sentimentos

DetectedLanguage

Contém os detalhes do idioma detetado para o texto.

Name	Tipo	Description
confidenceScore	number	Uma classificação de confiança entre 0 e 1. As classificações próximas de 1 indicam 100% de certeza de que o idioma identificado é verdadeiro.
iso6391Name	string	Uma representação de duas letras do idioma detetado de acordo com a norma ISO 639-1 (por exemplo, en, fr).
name	string	Nome longo de um idioma detetado (por exemplo, inglês, francês).

DocumentError

Contém detalhes dos erros encontrados durante a execução de uma tarefa.

Name	Tipo	Description
error	Error	Erro encontrado.
id	string	O ID do documento de entrada.

DocumentSentimentValue

Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).

Name	Tipo	Description
mixed	string	Instrução mista
negative	string	Instrução negativa
neutral	string	Instrução neutra
positive	string	Instrução positiva

DocumentStatistics

se showStats=true tiver sido especificado no pedido, este campo irá conter informações sobre o payload do documento.

Name	Tipo	Description
charactersCount	integer	Número de elementos de texto reconhecidos no documento.
transactionsCount	integer	Número de transações do documento.

DocumentWarning

Contém o objeto de avisos com avisos encontrados para o documento processado.

Name	Tipo	Description
code	WarningCodeValue	Código de aviso.
message	string	Mensagem de aviso.
targetRef	string	Uma referência de ponteiro JSON que indica o objeto de destino.

EntitiesDocumentResult

Contém o resultado da tarefa de reconhecimento de entidades do documento.

Name	Tipo	Description
entities	Entity[]	Entidades reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

EntitiesResult

Contém o resultado da tarefa de reconhecimento de entidades.

Name	Tipo	Description
documents	EntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo irá conter informações sobre o payload do pedido.

EntitiesTaskParameters

Parâmetros suportados para uma tarefa de Reconhecimento de Entidades.

Name	Tipo	Valor Predefinido	Description
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo
stringIndexType	StringIndexType	TextElements_v8	(Opcional) para fornecer o tipo de índice de cadeia utilizado para interpretar desvios de cadeias. Predefinições para TextElements (Graphemes).

EntitiesTaskResult

Contém a tarefa de entidade

Name	Tipo	Description
kind	string: EntityRecognitionResults	O tipo de resultado da tarefa.
results	EntitiesResult	Resultados do reconhecimento de entidades.

Entity

Define o objeto de entidade detetado que contém a categoria de entidade e o texto de entidade detetado, etc.

Name	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Classificação de confiança entre 0 e 1 da entidade extraída.
length	integer	Comprimento do texto da entidade. A utilização de diferentes valores "stringIndexType" pode afetar o comprimento devolvido.
offset	integer	Posição de início para o texto da entidade. A utilização de diferentes valores "stringIndexType" pode afetar o desvio devolvido.
subcategory	string	(Opcional) Tipo de sub-tipo de entidade.
text	string	Texto da entidade conforme apresentado no pedido.

EntityLinkingResult

Resultado de associação de entidades.

Name	Tipo	Description
documents	LinkedEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo irá conter informações sobre o payload do pedido.

EntityLinkingTaskParameters

Parâmetros suportados para uma tarefa de Associação de Entidades.

Name	Tipo	Valor Predefinido	Description
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo
stringIndexType	StringIndexType	TextElements_v8	Parâmetro opcional para fornecer o tipo de índice de cadeia utilizado para interpretar desvios de cadeia. Predefinições para TextElements (Graphemes).

EntityLinkingTaskResult

Contém o resultado da tarefa analisar texto Entidade que liga a tarefa.

Name	Tipo	Description
kind	string: EntityLinkingResults	O tipo de resultado da tarefa.
results	EntityLinkingResult	Resultado da ligação de entidades.

Error

O objeto de resposta de erro devolvido quando o serviço encontra alguns erros durante o processamento do pedido.

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	Azure Cognitive Search erro de limite de índice atingido
AzureCognitiveSearchIndexNotFound	string	Azure Cognitive Search erro de índice não encontrado
AzureCognitiveSearchNotFound	string	Azure Cognitive Search erro não encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search erro de limitação
Conflict	string	Erro de conflito
Forbidden	string	Erro de acesso proibido
InternalServerError	string	Erro de servidor interno
InvalidArgument	string	Erro de argumento inválido
InvalidRequest	string	Erro de pedido inválido
NotFound	string	Erro não encontrado
OperationNotFound	string	Erro de operação não encontrada
ProjectNotFound	string	Erro de projeto não encontrado
QuotaExceeded	string	Erro de quota excedida
ServiceUnavailable	string	Erro de serviço indisponível
Timeout	string	Erro de tempo limite
TooManyRequests	string	Erro de demasiados pedidos
Unauthorized	string	Erro de acesso não autorizado
Warning	string	Erro de aviso

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	Azure Cognitive Search erro não encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search erro de limitação
EmptyRequest	string	Erro de pedido vazio
ExtractionFailure	string	Erro de falha de extração
InvalidCountryHint	string	Erro de sugestão de país inválido
InvalidDocument	string	Erro de documento inválido
InvalidDocumentBatch	string	Erro de lote de documento inválido
InvalidParameterValue	string	Erro de valor de parâmetro inválido
InvalidRequest	string	Erro de pedido inválido
InvalidRequestBodyFormat	string	Erro de formato do corpo do pedido inválido
KnowledgeBaseNotFound	string	Erro de base de dados de conhecimento não encontrada
MissingInputDocuments	string	Erro de documentos de entrada em falta
ModelVersionIncorrect	string	Erro incorreto da versão do modelo
UnsupportedLanguageCode	string	Erro de código de idioma não suportado

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.

KeyPhraseResult

Contém o KeyPhraseResult.

Name	Tipo	Description
documents	KeyPhrasesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para a classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.

KeyPhrasesDocumentResult

Contém os resultados de extração de expressões-chave de um documento.

Name	Tipo	Description
id	string	Identificador de documento exclusivo e não vazio.
keyPhrases	string[]	Uma lista de palavras ou expressões representativas. O número de expressões-chave devolvidas é proporcional ao número de palavras no documento de entrada.
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

KeyPhraseTaskParameters

Parâmetros suportados para uma tarefa de Extração de Expressões-Chave.

Name	Tipo	Valor Predefinido	Description
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo

KeyPhraseTaskResult

Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.

Name	Tipo	Description
kind	string: KeyPhraseExtractionResults	O tipo de resultado da tarefa.
results	KeyPhraseResult	A lista de resultados de extração de expressões-chave

LanguageDetectionAnalysisInput

Contém a entrada de análise do documento de deteção de idioma.

Name	Tipo	Description
documents	LanguageInput[]	Lista de documentos a analisar.

LanguageDetectionDocumentResult

Contém a deteção de idioma de um documento.

Name	Tipo	Description
detectedLanguage	DetectedLanguage	Idioma Detetado.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LanguageDetectionResult

Contém o resultado da deteção de idioma para o pedido.

Name	Tipo	Description
documents	LanguageDetectionDocumentResult[]	Enumeração dos resultados da deteção de idiomas para cada documento de entrada.
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para a classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.

LanguageDetectionTaskParameters

Parâmetros suportados para uma tarefa de Deteção de Idiomas.

Name	Tipo	Valor Predefinido	Description
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo

LanguageDetectionTaskResult

Contém o resultado da tarefa de deteção de idioma para o pedido.

Name	Tipo	Description
kind	string: LanguageDetectionResults	O tipo de resultado da tarefa.
results	LanguageDetectionResult	Contém os resultados da deteção de idioma.

LanguageInput

Contém a entrada de deteção de idioma.

Name	Tipo	Description
countryHint	string	A sugestão do país para ajudar na deteção de idiomas do texto.
id	string	Um identificador de documento exclusivo e não vazio.
text	string	O texto de entrada a processar.

LinkedEntitiesDocumentResult

Entidade que liga o resultado do documento.

Name	Tipo	Description
entities	LinkedEntity[]	Entidades conhecidas reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LinkedEntity

O objeto LinkedEntity que contém a entidade detetada com as origens/ligações associadas.

Name	Tipo	Description
bingId	string	Identificador exclusivo da API de Pesquisa de Entidades do Bing da entidade reconhecida.
dataSource	string	Origem de dados utilizada para extrair a associação de entidades, como o Wiki/Bing, etc.
id	string	Identificador exclusivo da entidade reconhecida da origem de dados.
language	string	Idioma utilizado na origem de dados.
matches	Match[]	Lista de instâncias que esta entidade aparece no texto.
name	string	Nome formal da Associação de Entidades.
url	string	URL da página da entidade a partir da origem de dados.

Match

O objeto Match que contém o texto de entidade detetado com o desvio e o comprimento.

Name	Tipo	Description
confidenceScore	number	Se um item bem conhecido for reconhecido, será devolvido um número decimal que denota o nível de confiança entre 0 e 1.
length	integer	O comprimento da entidade corresponde ao texto.
offset	integer	Iniciar posição para a entidade corresponder ao texto.
text	string	Texto da entidade conforme apresentado no pedido.

MultiLanguageAnalysisInput

Coleção de documentos de entrada a analisar pelo serviço.

Name	Tipo	Description
documents	MultiLanguageInput[]	Os documentos de entrada a analisar.

MultiLanguageInput

Contém um documento de entrada a analisar pelo serviço.

Name	Tipo	Description
id	string	Um identificador de documento exclusivo e não vazio.
language	string	(Opcional) Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utilize "en" para inglês como predefinição. (A seguir aplica-se apenas a 2023-04-15-preview e superior) Para Deteção de Idioma Automático, utilize "auto". Se não estiver definido, utilize "en" para inglês como predefinição.
text	string	O texto de entrada a processar.

PiiCategory

(Opcional) descreve as categorias PII a devolver

Name	Tipo	Description
ABARoutingNumber	string	Número de Encaminhamento do ABA
ARNationalIdentityNumber	string	Número de Identidade Nacional da AR
ATIdentityCard	string	Cartão de Identidade AT
ATTaxIdentificationNumber	string	AT Tax Identification Number
ATValueAddedTaxNumber	string	Número do Imposto sobre o Valor Acrescentado at
AUBankAccountNumber	string	Cartão de Identidade AT
AUBusinessNumber	string	Número de Negócio da AU
AUCompanyNumber	string	Número da Empresa da AU
AUDriversLicenseNumber	string	Número de Carta de Condução da UA
AUMedicalAccountNumber	string	Número da Conta Médica da AU
AUPassportNumber	string	Número de Passaporte da AU
AUTaxFileNumber	string	Número de Ficheiro fiscal da AU
Address	string	Endereço
Age	string	Idade
All	string	Todas as categorias pii.
AzureDocumentDBAuthKey	string	Chave de Autenticação da BD do Documento do Azure
AzureIAASDatabaseConnectionAndSQLString	string	Ligação da Base de Dados IAAS do Azure e Cadeia de SQL
AzureIoTConnectionString	string	Cadeia de Ligação do Azure IoT
AzurePublishSettingPassword	string	Palavra-passe de Definição de Publicação do Azure
AzureRedisCacheString	string	Cadeia de Cache de Redis do Azure
AzureSAS	string	Azure SAS
AzureServiceBusString	string	Cadeia de Azure Service Bus
AzureStorageAccountGeneric	string	Conta de Armazenamento do Azure Genérica
AzureStorageAccountKey	string	Chave da Conta de Armazenamento do Azure
BENationalNumber	string	Número Nacional do BE
BENationalNumberV2	string	NÚMERO Nacional V2 do BE
BEValueAddedTaxNumber	string	Número de Imposto sobre o Valor Acrescentado do BE
BGUniformCivilNumber	string	Número Civil Uniforme bg
BRCPFNumber	string	Número CPF br
BRLegalEntityNumber	string	Número de Entidade Legal br
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Número da Conta Bancária da AC
CADriversLicenseNumber	string	Número de Carta de Condução da AC
CAHealthServiceNumber	string	Número do Serviço de Estado de Funcionamento da AC
CAPassportNumber	string	Número de Passaporte da AC
CAPersonalHealthIdentification	string	Identificação do Estado de Funcionamento Pessoal da AC
CASocialInsuranceNumber	string	Número da Segurança Social da AC
CHSocialSecurityNumber	string	Número de Segurança Social ch
CLIdentityCardNumber	string	Número do Cartão de Identidade cl
CNResidentIdentityCardNumber	string	N.º do Cartão de Identidade residente cn
CYIdentityCard	string	Cartão de Identidade CY
CYTaxIdentificationNumber	string	Número de Identificação do Imposto CY
CZPersonalIdentityNumber	string	Número de Identidade Pessoal CZ
CZPersonalIdentityV2	string	Identidade Pessoal V2 da CZ
CreditCardNumber	string	Número do Cartão de Crédito
DEDriversLicenseNumber	string	Número de Carta de Condução de DE
DEIdentityCardNumber	string	Número do Cartão de Identidade DE
DEPassportNumber	string	Número de Passaporte de DE
DETaxIdentificationNumber	string	Número de Identificação Fiscal de DE
DEValueAddedNumber	string	Número Adicionado do Valor DE
DKPersonalIdentificationNumber	string	Número de Identificação Pessoal do DK
DKPersonalIdentificationV2	string	Identificação Pessoal V2 do DK
Date	string	Date
Default	string	Categorias PII predefinidas para o idioma.
DrugEnforcementAgencyNumber	string	Número da Agência de Imposição de Drogas
EEPersonalIdentificationCode	string	Código de Identificação Pessoal do EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Número da Segurança Social do ES
ESTaxIdentificationNumber	string	Número de Identificação Fiscal do ES
EUDebitCardNumber	string	Número do Cartão de Débito da UE
EUDriversLicenseNumber	string	Número de Carta de Condução da UE
EUGPSCoordinates	string	Coordenadas de GPS da UE
EUNationalIdentificationNumber	string	Número de Identificação Nacional da UE
EUPassportNumber	string	Número de Passaporte da UE
EUSocialSecurityNumber	string	Número da Segurança Social da UE
EUTaxIdentificationNumber	string	Número de Identificação Fiscal da UE
Email	string	E-mail
FIEuropeanHealthNumber	string	Número de Estado de Funcionamento Europeu da FI
FINationalID	string	ID Nacional da FI
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	Número de Passaporte fi
FRDriversLicenseNumber	string	Número de Carta de Condução FR
FRHealthInsuranceNumber	string	Número do Seguro de Saúde FR
FRNationalID	string	ID Nacional fr
FRPassportNumber	string	Número de Passaporte FR
FRSocialSecurityNumber	string	Número da Segurança Social fr
FRTaxIdentificationNumber	string	Número de Identificação Fiscal do FR
FRValueAddedTaxNumber	string	Número de Imposto sobre o Valor Acrescentado de FR
GRNationalIDCard	string	Cartão de ID Nacional GR
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	Número de Identificação Fiscal gr
HKIdentityCardNumber	string	Número do Cartão de Identidade do HK
HRIdentityCardNumber	string	Número do Cartão de Identidade de RH
HRNationalIDNumber	string	Número de ID Nacional de RH
HRPersonalIdentificationNumber	string	Número de Identificação Pessoal de RH
HRPersonalIdentificationOIBNumberV2	string	Número OIB de Identificação Pessoal de RH V2
HUPersonalIdentificationNumber	string	Número de Identificação Pessoal do HU
HUTaxIdentificationNumber	string	Número de Identificação Fiscal do HU
HUValueAddedNumber	string	Número Adicionado do Valor HU
IDIdentityCardNumber	string	Número do Cartão de Identidade do ID
IEPersonalPublicServiceNumber	string	Número de Serviço Público Pessoal do IE
IEPersonalPublicServiceNumberV2	string	Número de Serviço Público Pessoal do IE V2
ILBankAccountNumber	string	Número da Conta Bancária IL
ILNationalID	string	IL National ID
INPermanentAccount	string	CONTA PERMANENTE IN
INUniqueIdentificationNumber	string	IN Número de Identificação Exclusivo
IPAddress	string	Endereço IP
ITDriversLicenseNumber	string	Número de Carta de Condução de TI
ITFiscalCode	string	Código Fiscal de TI
ITValueAddedTaxNumber	string	Número de Imposto sobre o Valor Acrescentado de TI
InternationalBankingAccountNumber	string	Número de Conta Bancária Internacional
JPBankAccountNumber	string	Número de Conta Bancária JP
JPDriversLicenseNumber	string	Número de Carta de Condução JP
JPMyNumberCorporate	string	JP O Meu Número Empresarial
JPMyNumberPersonal	string	JP O Meu Número Pessoal
JPPassportNumber	string	Número de Passaporte JP
JPResidenceCardNumber	string	Número do Cartão de Residência JP
JPResidentRegistrationNumber	string	Número de Registo de Residente jp
JPSocialInsuranceNumber	string	Número de Seguro Social JP
KRResidentRegistrationNumber	string	Número de Registo de Residente kr
LTPersonalCode	string	Código Pessoal LT
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	LU National Identification Number Non Natural
LVPersonalCode	string	Código Pessoal do LV
MTIdentityCardNumber	string	Número do Cartão de Identidade mt
MTTaxIDNumber	string	N.º do NIF
MYIdentityCardNumber	string	O Meu Número do Cartão de Identidade
NLCitizensServiceNumber	string	Número de Serviço do NL Citizens
NLCitizensServiceNumberV2	string	NNN Número de Serviço de Cidadãos V2
NLTaxIdentificationNumber	string	NN. Número de Identificação Fiscal
NLValueAddedTaxNumber	string	N.º do Imposto sobre o Valor Acrescentado
NOIdentityNumber	string	SEM Número de Identidade
NZBankAccountNumber	string	Número da Conta Bancária NZ
NZDriversLicenseNumber	string	Número de Carta de Condução nz
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Número do Ministério da Saúde da NZ
NZSocialWelfareNumber	string	Número do Bem-Estar Social nz
Organization	string	Organização
PHUnifiedMultiPurposeIDNumber	string	Número de ID Multiusos Unificado ph
PLIdentityCard	string	Cartão de Identidade do PL
PLNationalID	string	ID Nacional do PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Número de Passaporte do PL
PLREGONNumber	string	Número PL REGON
PLTaxIdentificationNumber	string	Número de Identificação Fiscal do PL
PTCitizenCardNumber	string	Número do Cartão de Cidadão pt
PTCitizenCardNumberV2	string	Número de Cartão de Cidadão DO PT V2
PTTaxIdentificationNumber	string	Número de Identificação Fiscal do PT
Person	string	Pessoa
PhoneNumber	string	Número de Telefone
ROPersonalNumericalCode	string	Código Numérico Pessoal RO
RUPassportNumberDomestic	string	Número de Passaporte de RU Nacional
RUPassportNumberInternational	string	N.º de Passaporte de RU Internacional
SANationalID	string	ID Nacional da SA
SENationalID	string	ID Nacional do SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Número de Passaporte do SE
SETaxIdentificationNumber	string	Número de Identificação Fiscal do SE
SGNationalRegistrationIdentityCardNumber	string	Número do Cartão de Identidade de Registo Nacional do SG
SITaxIdentificationNumber	string	Número de Identificação Fiscal do SI
SIUniqueMasterCitizenNumber	string	Número de Cidadão Principal Exclusivo do SI
SKPersonalNumber	string	Número Pessoal do SK
SQLServerConnectionString	string	Cadeia de Ligação SQL Server
SWIFTCode	string	Código SWIFT
THPopulationIdentificationCode	string	TH Population Identification Code
TRNationalIdentificationNumber	string	Número de Identificação Nacional do TR
TWNationalID	string	ID Nacional do TW
TWPassportNumber	string	Número de Passaporte do TW
TWResidentCertificate	string	Certificado de Residente do TW
UAPassportNumberDomestic	string	Número de Passaporte Nacional da UA
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Número de Carta de Condução do Reino Unido
UKElectoralRollNumber	string	Número dos Cadernos Eleitorais do Reino Unido
UKNationalHealthNumber	string	Número nacional de saúde do Reino Unido
UKNationalInsuranceNumber	string	Número do Seguro Nacional do Reino Unido
UKUniqueTaxpayerNumber	string	Número Exclusivo do Contribuinte do Reino Unido
URL	string	URL
USBankAccountNumber	string	Número de Conta Bancária dos E.U.A.
USDriversLicenseNumber	string	Número de Carta de Condução dos EUA
USIndividualTaxpayerIdentification	string	Identificação Individual dos Contribuintes dos EUA
USSocialSecurityNumber	string	Número da Segurança Social dos EUA
USUKPassportNumber	string	Número de Passaporte do Reino Unido dos EUA
ZAIdentificationNumber	string	Número de Identificação ZA

PiiDomain

Domain for PII task (Domínio para tarefa PII)

Name	Tipo	Description
none	string	Indica que não foi especificado nenhum domínio.
phi	string	Indica que as entidades no domínio Informações de Estado de Funcionamento Pessoal devem ser redigidas.

PiiEntitiesDocumentResult

Contém os resultados do PII.

Name	Tipo	Description
entities	Entity[]	Entidades reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
redactedText	string	Devolve texto redigido.
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

PiiResult

Contém o PiiResult.

Name	Tipo	Description
documents	PiiEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para a classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.

PiiTaskParameters

Parâmetros suportados para uma tarefa de Reconhecimento de Entidades PII.

Name	Tipo	Valor Predefinido	Description
domain	PiiDomain	none	Domain for PII task (Domínio para tarefa PII)
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo
piiCategories	PiiCategory[]		Enumeração de categorias PII a devolver na resposta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType a ser utilizado para análise.

PiiTaskResult

Contém o texto de análise PIIEntityRecognition LRO task.

Name	Tipo	Description
kind	string: PiiEntityRecognitionResults	O tipo de resultado da tarefa.
results	PiiResult	A lista de resultados pii

RequestStatistics

se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.

Name	Tipo	Description
documentsCount	integer	Número de documentos submetidos no pedido.
erroneousDocumentsCount	integer	Número de documentos inválidos. Isto inclui documentos de idiomas vazios, de tamanho superior ou não suportados.
transactionsCount	integer	Número de transações para o pedido.
validDocumentsCount	integer	Número de documentos válidos. Isto exclui documentos de idiomas vazios, de tamanho excessivo ou de idiomas não suportados.

SentenceAssessment

Representa uma avaliação de frases e as avaliações ou objetos de destino relacionados com a mesma.

Name	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa as classificações de confiança em todas as classes de sentimento: positivas e negativas.
isNegated	boolean	O indicador que representa se a avaliação é negada.
length	integer	O comprimento do destino.
offset	integer	O desvio do alvo desde o início da frase.
sentiment	TokenSentimentValue	O sentimento da frase.
text	string	O texto de destino detetado.

SentenceSentiment

O sentimento de frase de um documento.

Name	Tipo	Description
assessments	SentenceAssessment[]	A matriz de avaliações da frase.
confidenceScores	SentimentConfidenceScores	A classificação de confiança do sentimento entre 0 e 1 para a frase para todas as classes.
length	integer	O comprimento do destino.
offset	integer	O desvio do alvo desde o início da frase.
sentiment	SentenceSentimentValue	O Sentimento previsto para a frase.
targets	SentenceTarget[]	A matriz de destinos de frases para a frase.
text	string	O texto da frase.

SentenceSentimentValue

O Sentimento previsto para a frase.

Name	Tipo	Description
negative	string	Sentimento negativo
neutral	string	Sentimento neutro
positive	string	Sentimento positivo

SentenceTarget

Representa um destino de frase e as avaliações ou objetos de destino relacionados com a mesma.

Name	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa as classificações de confiança em todas as classes de sentimento: positivas e negativas.
length	integer	O comprimento do destino.
offset	integer	O desvio do alvo desde o início da frase.
relations	TargetRelation[]	A matriz de objetos de avaliação ou de destino que estão relacionados com o destino.
sentiment	TokenSentimentValue	O sentimento da frase.
text	string	O texto de destino detetado.

SentimentAnalysisTaskParameters

Parâmetros suportados para uma tarefa de Análise de Sentimentos.

Name	Tipo	Valor Predefinido	Description
loggingOptOut	boolean	False	não participar no início de sessão
modelVersion	string	latest	versão do modelo
opinionMining	boolean	False	Quer utilize ou não a extração de opiniões no pedido.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método utilizado para interpretar desvios de cadeias.

SentimentConfidenceScores

Representa as classificações de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

Name	Tipo	Description
negative	number	Classificação de confiança para sentimento negativo
neutral	number	Classificação de confiança para sentimento neutro
positive	number	Classificação de confiança para sentimento positivo

SentimentDocumentResult

Um objeto que representa os resultados pré-criados da Análise de Sentimentos de cada documento.

Name	Tipo	Description
confidenceScores	SentimentConfidenceScores	A pontuação de confiança do sentimento entre 0 e 1 para a frase para todas as classes.
id	string	Identificador de documento exclusivo e não vazio.
sentences	SentenceSentiment[]	O sentimento das frases do documento.
sentiment	DocumentSentimentValue	Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).
statistics	DocumentStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

SentimentResponse

Resultados da análise de sentimentos para os documentos de entrada.

Name	Tipo	Description
documents	SentimentDocumentResult[]	Os resultados da análise de sentimentos para cada documento na entrada.
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica que modelo é utilizado para a classificação.
statistics	RequestStatistics	se showStats=true tiver sido especificado no pedido, este campo conterá informações sobre o payload do pedido.

SentimentTaskResult

Contém o texto de análise SentimentAnalysis LRO task result.

Name	Tipo	Description
kind	string: SentimentAnalysisResults	O tipo de resultado da tarefa.
results	SentimentResponse	Os resultados da análise de sentimentos

StringIndexType

Tipo de índice de cadeia

Name	Tipo	Description
TextElements_v8	string	Os valores de deslocamento e comprimento devolvidos corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando para a norma Unicode 8.0.0. Utilize esta opção se a sua aplicação estiver escrita no .Net Framework ou .Net Core e estiver a utilizar StringInfo.
UnicodeCodePoint	string	Os valores de desvio e comprimento devolvidos corresponderão aos pontos de código Unicode. Utilize esta opção se a sua aplicação estiver escrita num idioma que suporte Unicode, por exemplo Python.
Utf16CodeUnit	string	Os valores de desvio e comprimento devolvidos 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.

TargetConfidenceScoreLabel

Representa as classificações de confiança em todas as classes de sentimento: positivas e negativas.

Name	Tipo	Description
negative	number	Classificação de confiança para sentimento negativo
positive	number	Classificação de confiança para sentimento positivo

TargetRelation

Representa a relação entre avaliações e/ou destinos.

Name	Tipo	Description
ref	string	O ponteiro JSON que indica o objeto ligado.
relationType	TargetRelationType	O tipo relacionado com o destino.

TargetRelationType

O tipo relacionado com o destino.

Name	Tipo	Description
assessment	string	Relação de avaliação.
target	string	Relação de destino.

TokenSentimentValue

O Sentimento previsto para a frase.

Name	Tipo	Description
mixed	string	Sentimento misto
negative	string	Sentimento negativo
positive	string	Sentimento positivo

WarningCodeValue

Define a lista dos códigos de aviso.

Name	Tipo	Description
DocumentTruncated	string	Aviso truncado do documento
LongWordsInDocument	string	Aviso de palavras longas no documento

Partilhar via

Text Analysis Runtime - Analyze Text

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

SuccessfulEntityLinkingRequest

Sample Request

Sample Response

SuccessfulEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulKeyPhraseExtractionRequest

Sample Request

Sample Response

SuccessfulLanguageDetectionRequest

Sample Request

Sample Response

SuccessfulPiiEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulSentimentAnalysisRequest

Sample Request

Sample Response

Definições

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

KeyPhraseResult

KeyPhrasesDocumentResult

KeyPhraseTaskParameters

KeyPhraseTaskResult

LanguageDetectionAnalysisInput

LanguageDetectionDocumentResult

LanguageDetectionResult

LanguageDetectionTaskParameters

LanguageDetectionTaskResult

LanguageInput

LinkedEntitiesDocumentResult

LinkedEntity

Match

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiEntitiesDocumentResult

PiiResult

PiiTaskParameters