Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Solicite análise de texto em 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 de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	A versão da API a ser usada para esta operação.
showStats	query		boolean	(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
AnalyzeTextEntityLinkingInput	Contém a entrada de vinculação de entidade de texto de análise.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidade analisa a solicitação 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 documento de detecção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa analisar texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa Analisar texto SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Contém a entrada de vinculação de entidade de texto de análise.

Nome	Obrigatório	Tipo	Description
kind	True	string: EntityLinking	O tipo de tarefa a ser executada.
analysisInput		MultiLanguageAnalysisInput	Contém a entrada de análise a ser manipulada pelo serviço.
parameters		EntityLinkingTaskParameters	Parâmetros de tarefa.

AnalyzeTextEntityRecognitionInput

O reconhecimento de entidade analisa a solicitação de tarefa de entrada de texto.

Nome	Obrigatório	Tipo	Description
kind	True	string: EntityRecognition	O tipo de tarefa a ser executada.
analysisInput		MultiLanguageAnalysisInput	A entrada a ser analisada.
parameters		EntitiesTaskParameters	Parâmetros de tarefa.

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.

Nome	Obrigatório	Tipo	Description
kind	True	string: KeyPhraseExtraction	O tipo de tarefa a ser executada.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		KeyPhraseTaskParameters	Parâmetros da tarefa de extração de frases-chave.

AnalyzeTextLanguageDetectionInput

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

Nome	Obrigatório	Tipo	Description
kind	True	string: LanguageDetection	O tipo de tarefa a ser executada.
analysisInput		LanguageDetectionAnalysisInput	Documentos a serem analisados.
parameters		LanguageDetectionTaskParameters	parâmetros de tarefa.

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa analisar texto PIIEntityRecognition.

Nome	Obrigatório	Tipo	Description
kind	True	string: PiiEntityRecognition	O tipo de tarefa a ser executada.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		PiiTaskParameters	Parâmetros da tarefa Pii.

AnalyzeTextSentimentAnalysisInput

Contém a entrada da tarefa Analisar texto SentimentAnalysis.

Nome	Obrigatório	Tipo	Description
kind	True	string: SentimentAnalysis	O tipo de tarefa a ser executada.
analysisInput		MultiLanguageAnalysisInput	Contém os documentos de entrada.
parameters		SentimentAnalysisTaskParameters	Parâmetros da tarefa Análise de Sentimento.

Respostas

Nome	Tipo	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	A solicitação foi bem-sucedida.
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

Nome	Description
AnalyzeTextEntityLinkingInput	Contém a entrada de vinculação de entidade de texto de análise.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidade analisa a solicitação 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 documento de detecção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa analisar texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa Analisar texto SentimentAnalysis.
AnalyzeTextTaskKind	O tipo de tarefas analyze-text com suporte.
AnalyzeTextTaskResultsKind	O tipo do objeto de resposta retornado pela tarefa analyze-text.
DetectedLanguage	Contém os detalhes do idioma detectado para o texto.
DocumentError	Contém detalhes dos erros encontrados durante a execução de um trabalho.
DocumentSentimentValue	Sentimento previsto para documento (Negativo, Neutro, Positivo ou Misto).
DocumentStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo do documento.
DocumentWarning	Contém o objeto warnings com avisos encontrados para o documento processado.
EntitiesDocumentResult	Contém o resultado da tarefa de reconhecimento de entidade para o documento.
EntitiesResult	Contém o resultado da tarefa de reconhecimento de entidade.
EntitiesTaskParameters	Parâmetros com suporte para uma tarefa de Reconhecimento de Entidade.
EntitiesTaskResult	Contém a tarefa de entidade
Entity	Define o objeto de entidade detectado que contém a categoria de entidade e o texto da entidade detectados, etc.
EntityLinkingResult	Resultado da vinculação de entidade.
EntityLinkingTaskParameters	Parâmetros com suporte para uma tarefa vinculação de entidade.
EntityLinkingTaskResult	Contém o resultado da tarefa analisar texto vinculação de entidade.
Error	O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.
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 API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Contém o KeyPhraseResult.
KeyPhrasesDocumentResult	Contém os resultados da extração de frases-chave de um documento.
KeyPhraseTaskParameters	Parâmetros com suporte para uma tarefa de Extração de Frases-chave.
KeyPhraseTaskResult	Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contém a entrada de análise de documento de detecção de idioma.
LanguageDetectionDocumentResult	Contém a detecção de idioma de um documento.
LanguageDetectionResult	Contém o resultado da detecção de idioma para a solicitação.
LanguageDetectionTaskParameters	Parâmetros com suporte para uma tarefa de Detecção de Idioma.
LanguageDetectionTaskResult	Contém o resultado da tarefa de detecção de idioma para a solicitação.
LanguageInput	Contém a entrada de detecção de idioma.
LinkedEntitiesDocumentResult	Resultado do documento de vinculação de entidade.
LinkedEntity	O objeto LinkedEntity que contém a entidade detectada com as fontes/links associados.
Match	O objeto Match que contém o texto da entidade detectado com o deslocamento e o comprimento.
MultiLanguageAnalysisInput	Coleção de documentos de entrada a serem analisados pelo serviço.
MultiLanguageInput	Contém um documento de entrada a ser analisado pelo serviço.
PiiCategory	(Opcional) descreve as categorias de PII a serem retornadas
PiiDomain	Domínio para tarefa PII
PiiEntitiesDocumentResult	Contém os resultados de PII.
PiiResult	Contém o PiiResult.
PiiTaskParameters	Parâmetros com suporte para uma tarefa de Reconhecimento de Entidades de PII.
PiiTaskResult	Contém a tarefa analisar texto PIIEntityRecognition LRO.
RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.
SentenceAssessment	Representa uma avaliação de frase e as avaliações ou objetos de destino relacionados a ela.
SentenceSentiment	O sentimento da 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 a ela.
SentimentAnalysisTaskParameters	Parâmetros com suporte para uma tarefa de Análise de Sentimento.
SentimentConfidenceScores	Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.
SentimentDocumentResult	Um objeto que representa os resultados predefinidos da Análise de Sentimento de cada documento.
SentimentResponse	Resultados da análise de sentimento para os documentos de entrada.
SentimentTaskResult	Contém o resultado da tarefa Analisar texto SentimentAnalysis LRO.
StringIndexType	Tipo de índice de cadeia de caracteres
TargetConfidenceScoreLabel	Representa as pontuaçõ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 ao destino.
TokenSentimentValue	O Sentimento previsto para a frase.
WarningCodeValue	Define a lista dos códigos de aviso.

AnalyzeTextEntityLinkingInput

Contém a entrada de vinculação de entidade de texto de análise.

Nome	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém a entrada de análise a ser tratada pelo serviço.
kind	string: EntityLinking	O tipo de tarefa a ser executada.
parameters	EntityLinkingTaskParameters	Parâmetros de tarefa.

AnalyzeTextEntityRecognitionInput

O reconhecimento de entidade analisa a solicitação de tarefa de entrada de texto.

Nome	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	A entrada a ser analisada.
kind	string: EntityRecognition	O tipo de tarefa a ser executada.
parameters	EntitiesTaskParameters	Parâmetros de tarefa.

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.

Nome	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: KeyPhraseExtraction	O tipo de tarefa a ser executada.
parameters	KeyPhraseTaskParameters	Parâmetros da tarefa de extração de frases-chave.

AnalyzeTextLanguageDetectionInput

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

Nome	Tipo	Description
analysisInput	LanguageDetectionAnalysisInput	Documentos a serem analisados.
kind	string: LanguageDetection	O tipo de tarefa a ser executada.
parameters	LanguageDetectionTaskParameters	parâmetros de tarefa.

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa analisar texto PIIEntityRecognition.

Nome	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: PiiEntityRecognition	O tipo de tarefa a ser executada.
parameters	PiiTaskParameters	Parâmetros da tarefa Pii.

AnalyzeTextSentimentAnalysisInput

Contém a entrada da tarefa Analisar texto SentimentAnalysis.

Nome	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contém os documentos de entrada.
kind	string: SentimentAnalysis	O tipo de tarefa a ser executada.
parameters	SentimentAnalysisTaskParameters	Parâmetros da tarefa Análise de Sentimento.

AnalyzeTextTaskKind

O tipo de tarefas analyze-text com suporte.

Nome	Tipo	Description
EntityLinking	string	Tarefa de vinculação de entidade
EntityRecognition	string	Tarefa de reconhecimento de entidade
KeyPhraseExtraction	string	Tarefa de extração de frases-chave
LanguageDetection	string	Tarefa de detecção de idioma
PiiEntityRecognition	string	Tarefa de reconhecimento de entidade PII
SentimentAnalysis	string	Tarefa de análise de sentimento

AnalyzeTextTaskResultsKind

O tipo do objeto de resposta retornado pela tarefa analyze-text.

Nome	Tipo	Description
EntityLinkingResults	string	Resultados de vinculação de entidade
EntityRecognitionResults	string	Resultados do reconhecimento de entidade
KeyPhraseExtractionResults	string	Resultados da extração de frases-chave
LanguageDetectionResults	string	Resultados da detecção de idioma
PiiEntityRecognitionResults	string	Resultados do reconhecimento de entidade PII
SentimentAnalysisResults	string	Resultados da análise de sentimento

DetectedLanguage

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

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

DocumentError

Contém detalhes dos erros encontrados durante a execução de um trabalho.

Nome	Tipo	Description
error	Error	Erro encontrado.
id	string	A ID do documento de entrada.

DocumentSentimentValue

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

Nome	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 na solicitação, esse campo conterá informações sobre o conteúdo do documento.

Nome	Tipo	Description
charactersCount	integer	Número de elementos de texto reconhecidos no documento.
transactionsCount	integer	Número de transações para o documento.

DocumentWarning

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

Nome	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 entidade para o documento.

Nome	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 na solicitação, esse campo conterá informações sobre o conteúdo do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

EntitiesResult

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

Nome	Tipo	Description
documents	EntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

EntitiesTaskParameters

Parâmetros com suporte para uma tarefa de Reconhecimento de Entidade.

Nome	Tipo	Valor padrão	Description
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo
stringIndexType	StringIndexType	TextElements_v8	(Opcional) parâmetro para fornecer o tipo de índice de cadeia de caracteres usado para interpretar deslocamentos de cadeia de caracteres. O padrão é TextElements (Graphemes).

EntitiesTaskResult

Contém a tarefa de entidade

Nome	Tipo	Description
kind	string: EntityRecognitionResults	O tipo de resultado da tarefa.
results	EntitiesResult	Resultados para o reconhecimento de entidade.

Entity

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

Nome	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Pontuação de confiança entre 0 e 1 da entidade extraída.
length	integer	Comprimento do texto da entidade. O uso de valores 'stringIndexType' diferentes pode afetar o comprimento retornado.
offset	integer	Posição inicial para o texto da entidade. O uso de valores 'stringIndexType' diferentes pode afetar o deslocamento retornado.
subcategory	string	(Opcional) Subtipo de entidade.
text	string	Texto da entidade como aparece na solicitação.

EntityLinkingResult

Resultado da vinculação de entidade.

Nome	Tipo	Description
documents	LinkedEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

EntityLinkingTaskParameters

Parâmetros com suporte para uma tarefa vinculação de entidade.

Nome	Tipo	Valor padrão	Description
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo
stringIndexType	StringIndexType	TextElements_v8	Parâmetro opcional para fornecer o tipo de índice de cadeia de caracteres usado para interpretar deslocamentos de cadeia de caracteres. O padrão é TextElements (Graphemes).

EntityLinkingTaskResult

Contém o resultado da tarefa analisar texto vinculação de entidade.

Nome	Tipo	Description
kind	string: EntityLinkingResults	O tipo de resultado da tarefa.
results	EntityLinkingResult	Resultado da vinculação de entidade.

Error

O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string	erro atingido Azure Cognitive Search limite de índice
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 interno do servidor
InvalidArgument	string	Erro de argumento inválido
InvalidRequest	string	Erro de solicitação 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 cota excedida
ServiceUnavailable	string	Erro de serviço indisponível
Timeout	string	Erro de tempo limite
TooManyRequests	string	Erro de muitas solicitações
Unauthorized	string	Erro de acesso não autorizado
Warning	string	Erro de aviso

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchNotFound	string	Azure Cognitive Search erro não encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search erro de limitação
EmptyRequest	string	Erro de solicitação vazio
ExtractionFailure	string	Erro de falha de extração
InvalidCountryHint	string	Erro de dica 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 solicitação inválido
InvalidRequestBodyFormat	string	Erro de formato de corpo da solicitação inválido
KnowledgeBaseNotFound	string	Erro não encontrado na base de dados de conhecimento
MissingInputDocuments	string	Erro de documentos de entrada ausentes
ModelVersionIncorrect	string	Erro incorreto da versão do modelo
UnsupportedLanguageCode	string	Erro de código de idioma sem suporte

InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Destino do erro.

KeyPhraseResult

Contém o KeyPhraseResult.

Nome	Tipo	Description
documents	KeyPhrasesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

KeyPhrasesDocumentResult

Contém os resultados da extração de frases-chave de um documento.

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

KeyPhraseTaskParameters

Parâmetros com suporte para uma tarefa de Extração de Frases-chave.

Nome	Tipo	Valor padrão	Description
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo

KeyPhraseTaskResult

Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

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

Nome	Tipo	Description
documents	LanguageInput[]	Lista de documentos a serem analisados.

LanguageDetectionDocumentResult

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

Nome	Tipo	Description
detectedLanguage	DetectedLanguage	Idioma Detectado.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LanguageDetectionResult

Contém o resultado da detecção de idioma para a solicitação.

Nome	Tipo	Description
documents	LanguageDetectionDocumentResult[]	Enumeração de resultados de detecção de idioma para cada documento de entrada.
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

LanguageDetectionTaskParameters

Parâmetros com suporte para uma tarefa de Detecção de Idioma.

Nome	Tipo	Valor padrão	Description
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo

LanguageDetectionTaskResult

Contém o resultado da tarefa de detecção de idioma para a solicitação.

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

LanguageInput

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

Nome	Tipo	Description
countryHint	string	A dica de país para ajudar na detecção de idioma do texto.
id	string	Um identificador de documento exclusivo e não vazio.
text	string	O texto de entrada a ser processado.

LinkedEntitiesDocumentResult

Resultado do documento de vinculação de entidade.

Nome	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 na solicitação, esse campo conterá informações sobre o conteúdo do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LinkedEntity

O objeto LinkedEntity que contém a entidade detectada com as fontes/links associados.

Nome	Tipo	Description
bingId	string	Identificador exclusivo da API de Pesquisa de Entidade do Bing da entidade reconhecida.
dataSource	string	Fonte de dados usada para extrair vinculação de entidade, como Wiki/Bing etc.
id	string	Identificador exclusivo da entidade reconhecida da fonte de dados.
language	string	Linguagem usada na fonte de dados.
matches	Match[]	Lista de instâncias que essa entidade aparece no texto.
name	string	Entidade Vinculando nome formal.
url	string	URL para a página da entidade da fonte de dados.

Match

O objeto Match que contém o texto da entidade detectado com o deslocamento e o comprimento.

Nome	Tipo	Description
confidenceScore	number	Se um item conhecido for reconhecido, um número decimal indicando o nível de confiança entre 0 e 1 será retornado.
length	integer	Comprimento para o texto de correspondência de entidade.
offset	integer	Posição inicial para o texto de correspondência de entidade.
text	string	Texto da entidade como aparece na solicitação.

MultiLanguageAnalysisInput

Coleção de documentos de entrada a serem analisados pelo serviço.

Nome	Tipo	Description
documents	MultiLanguageInput[]	Os documentos de entrada a serem analisados.

MultiLanguageInput

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

Nome	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, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. (A seguir aplica-se apenas a 2023-04-15-preview e superior) Para Detecção automática de idioma, use "auto". Se não estiver definido, use "en" para inglês como padrão.
text	string	O texto de entrada a ser processado.

PiiCategory

(Opcional) descreve as categorias de PII a serem retornadas

Nome	Tipo	Description
ABARoutingNumber	string	Número de roteamento do ABA
ARNationalIdentityNumber	string	Número de identidade nacional do AR
ATIdentityCard	string	AT Identity Card
ATTaxIdentificationNumber	string	AT Tax Identification Number
ATValueAddedTaxNumber	string	Número do imposto sobre o valor adicionado at
AUBankAccountNumber	string	AT Identity Card
AUBusinessNumber	string	Número de Negócios da AU
AUCompanyNumber	string	Número da Empresa de UA
AUDriversLicenseNumber	string	Número da Carteira de Habilitação da AU
AUMedicalAccountNumber	string	Número da conta médica da UA
AUPassportNumber	string	Número do Passaporte da AU
AUTaxFileNumber	string	Número do arquivo de imposto da AU
Address	string	Endereço
Age	string	Idade
All	string	Todas as categorias de PII.
AzureDocumentDBAuthKey	string	Chave de Autenticação do Banco de Dados do Azure Document
AzureIAASDatabaseConnectionAndSQLString	string	Conexão do Banco de Dados IAAS do Azure e cadeia de caracteres SQL
AzureIoTConnectionString	string	Cadeia de conexão do IoT do Azure
AzurePublishSettingPassword	string	Senha das configurações de publicação do Azure
AzureRedisCacheString	string	Cadeia de caracteres do Cache Redis do Azure
AzureSAS	string	Azure SAS
AzureServiceBusString	string	cadeia de caracteres Barramento de Serviço do Azure
AzureStorageAccountGeneric	string	Conta de Armazenamento do Azure Genérica
AzureStorageAccountKey	string	Chave de conta de armazenamento do Azure
BENationalNumber	string	NÚMERO NACIONAL BE
BENationalNumberV2	string	NÚMERO NACIONAL BE V2
BEValueAddedTaxNumber	string	Número do Imposto sobre Valor Agregado BE
BGUniformCivilNumber	string	Número Civil Uniforme bg
BRCPFNumber	string	Número do CPF da BR
BRLegalEntityNumber	string	Número da Entidade Legal do BR
BRNationalIDRG	string	RG da ID Nacional do BR
CABankAccountNumber	string	Número da conta bancária da AC
CADriversLicenseNumber	string	Número da Carteira de Habilitação de Autoridade de Certificação
CAHealthServiceNumber	string	Número do Serviço de Integridade da AC
CAPassportNumber	string	Número do Passaporte da AC
CAPersonalHealthIdentification	string	Identificação de Integridade Pessoal da AC
CASocialInsuranceNumber	string	Número do Seguro Social da AC
CHSocialSecurityNumber	string	Número da Previdência Social do CH
CLIdentityCardNumber	string	Número do cartão de identidade CL
CNResidentIdentityCardNumber	string	Número do cartão de identidade do 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	CZ Personal Identity V2
CreditCardNumber	string	Número do Cartão de Crédito
DEDriversLicenseNumber	string	Número da Carteira de Habilitação de DE
DEIdentityCardNumber	string	Número do cartão de identidade de DE
DEPassportNumber	string	Número do Passaporte DE
DETaxIdentificationNumber	string	Número de identificação de imposto 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 do DK V2
Date	string	Data
Default	string	Categorias de PII padrão para o idioma.
DrugEnforcementAgencyNumber	string	Número da Agência antidrogas
EEPersonalIdentificationCode	string	Código de identificação pessoal do EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Número do Seguro Social do ES
ESTaxIdentificationNumber	string	Número de identificação do imposto do ES
EUDebitCardNumber	string	Número do cartão de débito da UE
EUDriversLicenseNumber	string	Número da Carteira de Habilitação da UE
EUGPSCoordinates	string	Coordenadas de GPS da UE
EUNationalIdentificationNumber	string	Número de Identificação Nacional da UE
EUPassportNumber	string	Número do Passaporte da UE
EUSocialSecurityNumber	string	Número da Previdência Social da UE
EUTaxIdentificationNumber	string	Número de identificação fiscal da UE
Email	string	Email
FIEuropeanHealthNumber	string	Número de integridade europeu da FI
FINationalID	string	ID Nacional fi
FINationalIDV2	string	ID nacional da FI V2
FIPassportNumber	string	Número do Passaporte FI
FRDriversLicenseNumber	string	Número da Carteira de Habilitação do FR
FRHealthInsuranceNumber	string	Número do Seguro de Saúde FR
FRNationalID	string	ID Nacional da FR
FRPassportNumber	string	Número do Passaporte FR
FRSocialSecurityNumber	string	Número do Seguro Social FR
FRTaxIdentificationNumber	string	Número de identificação de imposto FR
FRValueAddedTaxNumber	string	Número do imposto sobre o valor adicionado do FR
GRNationalIDCard	string	Cartão de Identificação Nacional gr
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	Número de identificação de imposto 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 da ID Nacional de RH
HRPersonalIdentificationNumber	string	Número de identificação pessoal de RH
HRPersonalIdentificationOIBNumberV2	string	Número do 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 da ID
IEPersonalPublicServiceNumber	string	Número do Serviço Público Pessoal do IE
IEPersonalPublicServiceNumberV2	string	Número do Serviço Público Pessoal do IE V2
ILBankAccountNumber	string	Número da conta bancária il
ILNationalID	string	ID Nacional il
INPermanentAccount	string	IN Conta Permanente
INUniqueIdentificationNumber	string	IN Unique Identification Number
IPAddress	string	Endereço IP
ITDriversLicenseNumber	string	Número da carteira de habilitação de TI
ITFiscalCode	string	Código Fiscal de TI
ITValueAddedTaxNumber	string	Número do imposto sobre o valor adicionado de TI
InternationalBankingAccountNumber	string	Número de conta bancária internacional
JPBankAccountNumber	string	Número da conta bancária JP
JPDriversLicenseNumber	string	Número da carteira de motorista do JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Número do Passaporte JP
JPResidenceCardNumber	string	Número do cartão de residência JP
JPResidentRegistrationNumber	string	Número de registro de residente jp
JPSocialInsuranceNumber	string	Número do Seguro Social JP
KRResidentRegistrationNumber	string	Número de registro de residente kr
LTPersonalCode	string	Código Pessoal LT
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	Número de Identificação Nacional lu não natural
LVPersonalCode	string	Código Pessoal LV
MTIdentityCardNumber	string	Número do cartão de identidade mt
MTTaxIDNumber	string	Número da ID do Imposto mt
MYIdentityCardNumber	string	Número do cartão de identidade MY
NLCitizensServiceNumber	string	Número do Serviço de Cidadãos da NL
NLCitizensServiceNumberV2	string	Número do Serviço de Cidadãos da NL V2
NLTaxIdentificationNumber	string	Número de identificação fiscal do NL
NLValueAddedTaxNumber	string	Número do imposto sobre o valor adicionado do NL
NOIdentityNumber	string	NO Identity Number
NZBankAccountNumber	string	Número da conta bancária nz
NZDriversLicenseNumber	string	Número da carteira de motorista da NZ
NZInlandRevenueNumber	string	Número de receita do interior da NZ
NZMinistryOfHealthNumber	string	Número do Ministério da Saúde da NZ
NZSocialWelfareNumber	string	Número da Previdência Social nz
Organization	string	Organização
PHUnifiedMultiPurposeIDNumber	string	Número de ID de várias finalidades unificadas do PH
PLIdentityCard	string	Cartão de Identidade PL
PLNationalID	string	ID Nacional do PL
PLNationalIDV2	string	PL ID Nacional V2
PLPassportNumber	string	Número do Passaporte PL
PLREGONNumber	string	PL REGON Number
PLTaxIdentificationNumber	string	Número de Identificação Fiscal do PL
PTCitizenCardNumber	string	Número do Cartão cidadão do PT
PTCitizenCardNumberV2	string	Número do Cartão cidadão do PT V2
PTTaxIdentificationNumber	string	Número de identificação de imposto do PT
Person	string	Pessoa
PhoneNumber	string	Número do telefone
ROPersonalNumericalCode	string	Código Numérico Pessoal ro
RUPassportNumberDomestic	string	Número do Passaporte ru doméstico
RUPassportNumberInternational	string	RU Passport Number International
SANationalID	string	ID Nacional da SA
SENationalID	string	ID Nacional do SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Número do Passaporte SE
SETaxIdentificationNumber	string	Número de identificação do imposto SE
SGNationalRegistrationIdentityCardNumber	string	Número do Cartão de Identidade de Registro Nacional do SG
SITaxIdentificationNumber	string	Número de Identificação Fiscal do SI
SIUniqueMasterCitizenNumber	string	SI Unique Master Citizen Number
SKPersonalNumber	string	Número Pessoal do SK
SQLServerConnectionString	string	Cadeia de conexão do SQL Server
SWIFTCode	string	Código SWIFT
THPopulationIdentificationCode	string	Código de identificação de população de TH
TRNationalIdentificationNumber	string	Número de Identificação Nacional tr
TWNationalID	string	ID Nacional do TW
TWPassportNumber	string	Número do Passaporte TW
TWResidentCertificate	string	Certificado residente TW
UAPassportNumberDomestic	string	Número do Passaporte do UA Doméstico
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Número da carteira de motorista do Reino Unido
UKElectoralRollNumber	string	Número da Lista Eleitoral 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 da conta bancária dos EUA
USDriversLicenseNumber	string	Número da carteira de motorista dos EUA
USIndividualTaxpayerIdentification	string	Identificação de contribuinte individual dos EUA
USSocialSecurityNumber	string	Número da Previdência Social dos EUA
USUKPassportNumber	string	Número do Passaporte do Reino Unido dos EUA
ZAIdentificationNumber	string	Número de identificação do ZA

PiiDomain

Domínio para tarefa PII

Nome	Tipo	Description
none	string	Indica que nenhum domínio é especificado.
phi	string	Indica que as entidades no domínio Informações de Integridade Pessoal devem ser redigidas.

PiiEntitiesDocumentResult

Contém os resultados de PII.

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

PiiResult

Contém o PiiResult.

Nome	Tipo	Description
documents	PiiEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

PiiTaskParameters

Parâmetros com suporte para uma tarefa de Reconhecimento de Entidades de PII.

Nome	Tipo	Valor padrão	Description
domain	PiiDomain	none	Domínio para tarefa PII
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo
piiCategories	PiiCategory[]		Enumeração de categorias de PII a serem retornadas na resposta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType a ser usado para análise.

PiiTaskResult

Contém a tarefa analisar texto PIIEntityRecognition LRO.

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

RequestStatistics

se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

Nome	Tipo	Description
documentsCount	integer	Número de documentos enviados na solicitação.
erroneousDocumentsCount	integer	Número de documentos inválidos. Isso inclui documentos vazios, de limite excessivo ou de idiomas sem suporte.
transactionsCount	integer	Número de transações para a solicitação.
validDocumentsCount	integer	Número de documentos válidos. Isso exclui documentos vazios, de limite excessivo ou de idiomas sem suporte.

SentenceAssessment

Representa uma avaliação de frase e as avaliações ou objetos de destino relacionados a ela.

Nome	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa as pontuaçõ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 deslocamento de destino desde o início da frase.
sentiment	TokenSentimentValue	O sentimento da frase.
text	string	O texto de destino detectado.

SentenceSentiment

O sentimento da frase de um documento.

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

SentenceSentimentValue

O Sentimento previsto para a frase.

Nome	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 a ela.

Nome	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa as pontuações de confiança em todas as classes de sentimento: positivas e negativas.
length	integer	O comprimento do destino.
offset	integer	O deslocamento de destino desde o início da frase.
relations	TargetRelation[]	A matriz de objetos de avaliação ou de destino que está relacionada ao destino.
sentiment	TokenSentimentValue	O sentimento da frase.
text	string	O texto de destino detectado.

SentimentAnalysisTaskParameters

Parâmetros com suporte para uma tarefa de Análise de Sentimento.

Nome	Tipo	Valor padrão	Description
loggingOptOut	boolean	False	recusa de registro em log
modelVersion	string	latest	versão do modelo
opinionMining	boolean	False	Se deve ou não usar a mineração de opiniões na solicitação.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres.

SentimentConfidenceScores

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

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

SentimentDocumentResult

Um objeto que representa os resultados predefinidos da Análise de Sentimento de cada documento.

Nome	Tipo	Description
confidenceScores	SentimentConfidenceScores	A pontuação de confiança de 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 documento (Negativo, Neutro, Positivo ou Misto).
statistics	DocumentStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

SentimentResponse

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

Nome	Tipo	Description
documents	SentimentDocumentResult[]	Os resultados da análise de sentimento para cada documento na entrada.
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Esse campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

SentimentTaskResult

Contém o resultado da tarefa Analisar texto SentimentAnalysis LRO.

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

StringIndexType

Tipo de índice de cadeia de caracteres

Nome	Tipo	Description
TextElements_v8	string	Os valores de deslocamento e comprimento retornados corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando para o padrão Unicode 8.0.0. Use essa opção se o aplicativo estiver escrito no .Net Framework ou .Net Core e você usará StringInfo.
UnicodeCodePoint	string	Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use essa opção se o aplicativo for escrito em um idioma que dê suporte a Unicode, por exemplo, Python.
Utf16CodeUnit	string	Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte a Unicode, por exemplo Java, JavaScript.

TargetConfidenceScoreLabel

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

Nome	Tipo	Description
negative	number	Pontuação de confiança para sentimento negativo
positive	number	Pontuação de confiança para sentimento positivo

TargetRelation

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

Nome	Tipo	Description
ref	string	O ponteiro JSON que indica o objeto vinculado.
relationType	TargetRelationType	O tipo relacionado ao destino.

TargetRelationType

O tipo relacionado ao destino.

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

TokenSentimentValue

O Sentimento previsto para a frase.

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

WarningCodeValue

Define a lista dos códigos de aviso.

Nome	Tipo	Description
DocumentTruncated	string	Aviso truncado do documento
LongWordsInDocument	string	Palavras longas no aviso do documento