Analyze Text - Analyze Text

Serviço:: Azure AI Services

Versão da API:: 2025-11-01

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

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
showStats	query		boolean	(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name	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 documentos de deteção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa PIIEntityRecognition de texto de análise.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa SentimentAnalysis de texto de análise.

AnalyzeTextEntityLinkingInput

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

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

AnalyzeTextEntityRecognitionInput

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

Name	Necessário	Tipo	Description
kind	True	string: EntityRecognition	O tipo de tarefa a realizar.
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 realizar.
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 documentos de deteção de idioma.

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

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa PIIEntityRecognition de texto de análise.

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

AnalyzeTextSentimentAnalysisInput

Contém a entrada da tarefa SentimentAnalysis de texto de análise.

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

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. Cabeçalhos 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.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Resposta da amostra

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

SuccessfulEntityRecognitionExclusionRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Resposta da amostra

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

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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?"
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

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

SuccessfulPiiEntityRecognitionRequest

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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?"
      }
    ]
  }
}

Resposta da amostra

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

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 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
AgeMetadata	Representa o modelo de metadados da entidade Age.
AgeUnit	A unidade de medida etária
AllowOverlapEntityPolicyType	Representa a política de sobreposição de permissão. Não será aplicada nenhuma lógica de pós-processamento para as entidades. Tudo o que o modelo prevê é o que será devolvido ao usuário. Isso permite que o usuário obtenha uma visão completa dos valores possíveis de cada modelo e aplique sua própria lógica personalizada na seleção de entidades
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 documentos de deteção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa PIIEntityRecognition de texto de análise.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa SentimentAnalysis de texto de análise.
AnalyzeTextTaskKind	O tipo de tarefas de análise de texto suportadas.
AnalyzeTextTaskResultsKind	O tipo do objeto de resposta retornado pela tarefa de texto de análise.
AreaMetadata	Representa o modelo de metadados da entidade Area.
AreaUnit	A unidade de medida da área.
CurrencyMetadata	Representa o modelo de metadados da entidade Currency ).
DateMetadata	Um Metadados para instâncias de entidade de data.
DateTimeMetadata	Um Metadados para instâncias de entidade datetime.
DateValue	Representa o valor da data.
DetectedLanguage	Contém os detalhes do idioma detetado para o texto.
DocumentError	Contém detalhes de erros encontrados durante a execução de um trabalho.
DocumentSentimentValue	Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).
DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
DocumentWarning	Contém o objeto warnings com avisos encontrados para o documento processado.
EntitiesDocumentResultWithMetadata	Os documentos da entidade resultam com metadados.
EntitiesResult	Contém o resultado da tarefa de reconhecimento de entidade.
EntitiesTaskParameters	Parâmetros suportados para uma tarefa de Reconhecimento de Entidade.
EntitiesTaskResult	Contém a tarefa de entidade
Entity	Define o objeto de entidade detetado contendo a categoria de entidade e o texto da entidade detetados, etc.
EntityCategory	Contém todas as categorias de entidades detetadas pelo reconhecimento da entidade.
EntityInferenceOptions	A classe que abriga as opções de inferência permitiu o reconhecimento da entidade nomeada.
EntityLinkingResult	Resultado da vinculação de entidade.
EntityLinkingTaskParameters	Parâmetros suportados para uma tarefa de Vinculação de Entidade.
EntityLinkingTaskResult	Contém o resultado da tarefa de vinculação de entidade de texto de análise.
EntityTag	Objeto de tag de entidade que contém o nome das tags e qualquer pontuação de confiança associada. As Tags de Entidade são usadas para expressar algumas semelhanças/afinidade entre entidades.
EntityWithMetadata	Objeto de entidade com tags e metadados.
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.
InformationMetadata	Representa o modelo de metadados da entidade Information (data).
InformationUnit	A informação (dados) Unidade de medida.
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 da frase-chave para um documento.
KeyPhraseTaskParameters	Parâmetros suportados para uma tarefa de extração de frase-chave.
KeyPhraseTaskResult	Contém o resultado da tarefa analisar texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contém a entrada de análise de documento de deteção de idioma.
LanguageDetectionDocumentResult	Contém a deteção de idioma para um documento.
LanguageDetectionResult	Contém o resultado da deteção de idioma para a solicitação.
LanguageDetectionTaskParameters	Parâmetros suportados para uma tarefa de Deteção de Idioma.
LanguageDetectionTaskResult	Contém o resultado da tarefa de deteção de idioma para a solicitação.
LanguageInput	Contém a entrada de deteção de idioma.
LengthMetadata	Representa o modelo de metadados da entidade Length.
LengthUnit	A unidade de medida de comprimento.
LinkedEntitiesDocumentResult	Resultado do documento de vinculação de entidade.
LinkedEntity	O objeto LinkedEntity que contém a entidade detetada com as fontes/links associados.
Match	O objeto Match que contém o texto da entidade detetada com o deslocamento e o comprimento.
MatchLongestEntityPolicyType	Representa a política de sobreposição mais longa Match. Não há sobreposição de entidades, na medida do possível. 1. Se houver entidades sobrepostas, a mais longa será devolvida. 2. Se o conjunto de caracteres previsto para 2 ou mais entidades for exatamente o mesmo, selecione a entidade que tem a pontuação de confiança mais alta.3. Se as pontuações da entidade forem idênticas, retorne todas as entidades que ainda estão presentes após a aplicação das regras anteriores. 3. Se houver sobreposição parcial (como no Hello Text Analytics), siga as etapas acima a partir de 1.
MetadataKind	O tipo de objeto de metadados da entidade.
MultiLanguageAnalysisInput	Recolha de documentos de entrada a analisar pelo serviço.
MultiLanguageInput	Contém um documento de entrada a ser analisado pelo serviço.
NumberKind	O tipo da entidade numérica extraída.
NumberMetadata	Um metadados para instâncias de entidade numérica.
NumericRangeMetadata	representa os metadados de intervalos numéricos.
OrdinalMetadata	Um metadados para instâncias de entidade numérica.
PiiCategory	(Opcional) descreve as categorias de PII a serem retornadas
PiiDomain	Domínio para tarefa PII
PiiEntitiesDocumentResult	Contém os resultados da PII.
PiiResult	Contém o PiiResult.
PiiTaskParameters	Parâmetros suportados para uma tarefa de Reconhecimento de Entidades PII.
PiiTaskResult	Contém a tarefa LRO PIIEntityRecognition de texto de análise.
RangeInclusivity	A abrangência desta propriedade de propriedade.
RangeKind	O tipo de entidade do intervalo de números.
RelativeTo	O ponto de referência que o número ordinal denota.
RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.
ScriptCode	Identifica o script do documento de entrada. Mapeia para o código de script padrão ISO 15924.
ScriptKind	Identifica o script do documento de entrada. Mapeia para o nome formal da norma ISO 15924.
SentenceAssessment	Representa uma avaliação de sentença e as avaliações ou objetos alvo relacionados a ela.
SentenceSentiment	Sentimento da frase de um documento.
SentenceSentimentValue	O sentimento previsto para a sentença.
SentenceTarget	Representa um destino de frase e as avaliações ou objetos de destino relacionados a ele.
SentimentAnalysisTaskParameters	Parâmetros suportados para uma tarefa de Análise de Sentimento.
SentimentConfidenceScores	Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.
SentimentDocumentResult	Um objeto que representa os resultados pré-construídos 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 LRO SentimentAnalysis de texto de análise.
SpeedMetadata	Representa o modelo de metadados da entidade Speed.
SpeedUnit	A velocidade Unidade de medida
StringIndexType	Tipo de índice de cadeia de caracteres
TargetConfidenceScoreLabel	Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.
TargetRelation	Representa a relação entre avaliações e/ou metas.
TargetRelationType	O tipo relacionado ao destino.
TemperatureMetadata	Representa o modelo de metadados da entidade de informação.
TemperatureUnit	A unidade de medida de temperatura.
TemporalModifier	Um modificador opcional de uma instância de data/hora.
TemporalSetMetadata	Um Metadados para instâncias de entidade de conjunto temporal.
TemporalSpanMetadata	representa os metadados de um período de data e/ou hora.
TemporalSpanValues	Objeto de span temporal.
TimeMetadata	Um Metadados para instâncias de entidade de tempo.
TokenSentimentValue	O sentimento previsto para a sentença.
VolumeMetadata	Representa o modelo de metadados da entidade Volume.
VolumeUnit	A unidade de medida volumétrica
WarningCodeValue	Define a lista dos códigos de aviso.
WeightMetadata	Representa o modelo de metadados da entidade Weight ).
WeightUnit	A unidade de medida de peso.

AgeMetadata

Object

Representa o modelo de metadados da entidade Age.

Name	Tipo	Description
metadataKind	string: AgeMetadata	O tipo de objeto de metadados da entidade.
unit	AgeUnit	Unidade de medida para a idade.
value	number (double)	O valor numérico que o texto extraído denota.

AgeUnit

Enumeração

A unidade de medida etária

Valor	Description
Unspecified	Período de tempo não especificado
Year	Período de um ano
Month	Período de tempo de um mês
Week	Período de tempo de uma semana
Day	Período de tempo de um dia

AllowOverlapEntityPolicyType

Object

Representa a política de sobreposição de permissão. Não será aplicada nenhuma lógica de pós-processamento para as entidades. Tudo o que o modelo prevê é o que será devolvido ao usuário. Isso permite que o usuário obtenha uma visão completa dos valores possíveis de cada modelo e aplique sua própria lógica personalizada na seleção de entidades

Name	Tipo	Default value	Description
policyKind	string: allowOverlap	matchLongest	O tipo de objeto OverlapPolicy da entidade.

AnalyzeTextEntityLinkingInput

Object

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

Name	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 realizar.
parameters	EntityLinkingTaskParameters	Parâmetros da tarefa.

AnalyzeTextEntityRecognitionInput

Object

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

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

AnalyzeTextKeyPhraseExtractionInput

Object

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 realizar.
parameters	KeyPhraseTaskParameters	Parâmetros da tarefa de extração de frases-chave.

AnalyzeTextLanguageDetectionInput

Object

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 realizar.
parameters	LanguageDetectionTaskParameters	parâmetros da tarefa.

AnalyzeTextPiiEntitiesRecognitionInput

Object

Contém a entrada da tarefa PIIEntityRecognition de texto de análise.

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

AnalyzeTextSentimentAnalysisInput

Object

Contém a entrada da tarefa SentimentAnalysis de texto de análise.

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

AnalyzeTextTaskKind

Enumeração

O tipo de tarefas de análise de texto suportadas.

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

AnalyzeTextTaskResultsKind

Enumeração

O tipo do objeto de resposta retornado pela tarefa de texto de análise.

Valor	Description
SentimentAnalysisResults	Resultados da análise de sentimento
EntityRecognitionResults	Resultados de reconhecimento de entidades
PiiEntityRecognitionResults	Resultados do reconhecimento de entidades PII
KeyPhraseExtractionResults	Resultados da extração de frases-chave
LanguageDetectionResults	Resultados da deteção de idioma
EntityLinkingResults	Resultados de vinculação de entidade

AreaMetadata

Object

Representa o modelo de metadados da entidade Area.

Name	Tipo	Description
metadataKind	string: AreaMetadata	O tipo de objeto de metadados da entidade.
unit	AreaUnit	Unidade de medida por área.
value	number (double)	O valor numérico que o texto extraído denota.

AreaUnit

Enumeração

A unidade de medida da área.

Valor	Description
Unspecified	Unidade de área não especificada
SquareKilometer	Unidade de área em quilómetros quadrados
SquareHectometer	Unidade de área em hectómetros quadrados
SquareDecameter	Unidade de área em decámetros quadrados
SquareDecimeter	Unidade de área em decímetros quadrados
SquareMeter	Unidade de área em metros quadrados
SquareCentimeter	Unidade de área em centímetros quadrados
SquareMillimeter	Unidade de área em milímetros quadrados
SquareInch	Unidade de área em polegadas quadradas
SquareFoot	Unidade de área em pés quadrados
SquareMile	Unidade de área em milhas quadradas
SquareYard	Unidade de área em metros quadrados
Acre	Unidade de área em acres

CurrencyMetadata

Object

Representa o modelo de metadados da entidade Currency ).

Name	Tipo	Description
iso4217	string	O código alfabético baseado em outra norma ISO, ISO 3166, que lista os códigos para nomes de países. As duas primeiras letras do código ISO 4217 de três letras são as mesmas que o código do nome do país e, sempre que possível, a terceira letra corresponde à primeira letra do nome da moeda.
metadataKind	string: CurrencyMetadata	O tipo de objeto de metadados da entidade.
unit	string	Unidade monetária.
value	number (double)	O valor numérico que o texto extraído denota.

DateMetadata

Object

Um Metadados para instâncias de entidade de data.

Name	Tipo	Description
dateValues	DateValue[]	Lista de valores de data.
metadataKind	string: DateMetadata	O tipo de objeto de metadados da entidade.

DateTimeMetadata

Object

Um Metadados para instâncias de entidade datetime.

Name	Tipo	Description
dateValues	DateValue[]	Lista de valores de data.
metadataKind	string: DateTimeMetadata	O tipo de objeto de metadados da entidade.

DateValue

Object

Representa o valor da data.

Name	Tipo	Description
modifier	TemporalModifier	Modificador para datetime para indicar ponto de referência como antes, depois etc.
timex	string	Uma representação alargada de data/hora ISO 8601, conforme descrito em (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	O tempo real que o texto extraído denota.

DetectedLanguage

Object

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

Name	Tipo	Description
confidenceScore	number (double)	Um índice de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira.
iso6391Name	string	Uma representação de duas letras da língua detetada 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).
scriptIso15924Code	ScriptCode	Identifica o código de script do documento de entrada de acordo com a norma ISO 15924.
scriptName	ScriptKind	Identifica o nome do script do documento de entrada de acordo com a norma ISO 15924.

DocumentError

Object

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

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

DocumentSentimentValue

Enumeração

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

Valor	Description
positive	Declaração positiva
neutral	Declaração neutra
negative	Declaração negativa
mixed	Declaração mista

DocumentStatistics

Object

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

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

DocumentWarning

Object

Contém o objeto warnings 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 indicando o objeto de destino.

EntitiesDocumentResultWithMetadata

Object

Os documentos da entidade resultam com metadados.

Name	Tipo	Description
entities	EntityWithMetadata[]	Entidades reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

EntitiesResult

Object

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

Name	Tipo	Description
documents	EntitiesDocumentResultWithMetadata[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

EntitiesTaskParameters

Object

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

Name	Tipo	Default value	Description
exclusionList	EntityCategory[]		(Opcional) parâmetro de solicitação que filtra todas as entidades que estão incluídas no excludeList. Quando um usuário especifica uma excludeList, ele não pode obter uma previsão retornada com uma entidade nessa lista. Aplicaremos inclusionList antes de exclusionList
inclusionList	EntityCategory[]		Parâmetro de solicitação (opcional) que limita a saída aos tipos de entidade solicitados incluídos nesta lista. Aplicaremos inclusionList antes de exclusionList
inferenceOptions	EntityInferenceOptions		(Opcional) parâmetro de solicitação que permite ao usuário fornecer configurações para executar a inferência.
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Opcional) descreve o tipo de política de sobreposição a ser aplicada à saída ner.
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

Object

Contém a tarefa de entidade

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

Entity

Object

Define o objeto de entidade detetado contendo a categoria de entidade e o texto da entidade detetados, etc.

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

EntityCategory

Enumeração

Contém todas as categorias de entidades detetadas pelo reconhecimento da entidade.

Valor	Description
Address	Menções específicas ao nível da rua dos locais: números de casas/edifícios, ruas, avenidas, autoestradas, cruzamentos referenciados pelo nome.
Numeric	Valores numéricos, incluindo dígitos e palavras numéricas.
Age	Valores relacionados com a idade.
Currency	Valores relacionados com a moeda.
Number	Números sem unidade
NumberRange	Gama de Números
Percentage	Valores relacionados com a percentagem.
Ordinal	Números ordinais.
Temperature	Valores relacionados com a temperatura.
Dimension	Dimensão das medições
Length	Comprimento de um objeto.
Weight	Peso de um objeto.
Height	Altura de um objeto.
Speed	Velocidade de um objeto.
Area	Área de um objeto.
Volume	Volume de um objeto.
Information	Unidade de medida para informação digital.
Temporal	Itens relativos ao tempo.
Date	Datas do calendário.
Time	Horas do dia.
DateTime	Calendário de datas com hora.
DateRange	Intervalo de datas.
TimeRange	Intervalo de tempos.
DateTimeRange	Intervalo de data e hora.
Duration	Duração do tempo.
SetTemporal	Conjunto de valores relacionados ao tempo.
Event	Eventos sociais, esportivos, empresariais, políticos, educacionais, naturais, históricos, criminais, violentos, legais, militares com um período cronometrado.
SportsEvent	Valores relacionados com eventos desportivos.
CulturalEvent	Valores relacionados com eventos culturais.
NaturalEvent	Valores relacionados com eventos naturais.
Location	Ponto ou lugar particular no espaço físico.
GPE	Cidades, países/regiões, estados.
City	Valores relacionados com a cidade.
State	Valores relacionados com o Estado.
CountryRegion	Valores relacionados com o país ou a região.
Continent	Valores continentais.
Structural	Estruturas artificiais.
Airport	Aeroportos.
Geological	Características geográficas e naturais, como rios, oceanos e desertos.
Organization	Corporações, agências e outros grupos de pessoas definidos por alguma estrutura organizacional estabelecida. Esses rótulos podem incluir empresas, partidos/movimentos políticos, bandas musicais, clubes esportivos, órgãos governamentais e organizações públicas. Nacionalidades ou religiões não são ORGANIZAÇÃO.
OrganizationMedical	Empresas e grupos médicos.
OrganizationStockExchange	Grupos de bolsas de valores.
OrganizationSports	Organizações relacionadas com o desporto.
Person	Primeiro, último e nomes do meio, nomes de personagens fictícios e pseudônimos. Títulos, como 'Mr.' ou «Presidente», não são considerados parte da entidade nomeada.
PersonType	Funções humanas classificadas por membros de um grupo.
Email	Endereços de e-mail.
URL	URLs para websites.
IP	endereços IP de rede.
PhoneNumber	Números de telefone (apenas números de telefone dos EUA e da UE).
Product	Único ou grupo de objetos comerciais, consumíveis, eletrônicos, veículos, grupos de alimentos.
ComputingProduct	Produtos informáticos.
Skill	Uma capacidade, habilidade ou experiência.

EntityInferenceOptions

Object

A classe que abriga as opções de inferência permitiu o reconhecimento da entidade nomeada.

Name	Tipo	Default value	Description
excludeNormalizedValues	boolean	False	Opção para incluir/excluir os valores de entidade detetados a serem normalizados e incluídos nos metadados. Os tipos de entidade numérica e temporal suportam a normalização de valores.

EntityLinkingResult

Object

Resultado da vinculação de entidade.

Name	Tipo	Description
documents	LinkedEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

EntityLinkingTaskParameters

Object

Parâmetros suportados para uma tarefa de Vinculação de Entidade.

Name	Tipo	Default value	Description
loggingOptOut	boolean	False	desativação de 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

Object

Contém o resultado da tarefa de vinculação de entidade de texto de análise.

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

EntityTag

Object

Objeto de tag de entidade que contém o nome das tags e qualquer pontuação de confiança associada. As Tags de Entidade são usadas para expressar algumas semelhanças/afinidade entre entidades.

Name	Tipo	Description
confidenceScore	number (double)	Pontuação de deteção entre 0 e 1 da entidade extraída.
name	string	Nome da tag. Os nomes das tags de entidade serão exclusivos globalmente.

EntityWithMetadata

Object

Objeto de entidade com tags e metadados.

Name	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number (double)	Escore de confiança entre 0 e 1 da entidade extraída.
length	integer (int32)	Comprimento do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	O objeto de metadados da entidade.
offset	integer (int32)	Posição inicial para o texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.
subcategory	string	(Opcional) Subtipo de entidade.
tags	EntityTag[]	Lista de tags de entidade. As tags são para expressar algumas semelhanças/afinidade entre entidades.
text	string	Texto da entidade conforme aparece na solicitação.
type	string	Um tipo de entidade é a menor (ou mais fina) granularidade na qual a entidade foi detetada. O tipo é mapeado para os atributos de metadados específicos associados à entidade detetada.

Error

Object

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

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

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválida
InvalidArgument	Erro de argumento inválido
Unauthorized	Erro de acesso não autorizado
Forbidden	Erro de acesso proibido
NotFound	Erro não encontrado
ProjectNotFound	Erro de projeto não encontrado
OperationNotFound	Erro de operação não encontrado
AzureCognitiveSearchNotFound	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexNotFound	Erro de índice da Pesquisa Cognitiva do Azure não encontrado
TooManyRequests	Erro de muitas solicitações
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexLimitReached	Erro atingido pelo limite do índice da Pesquisa Cognitiva do Azure
InternalServerError	Erro interno do servidor
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
QuotaExceeded	Erro de quota excedida
Conflict	Erro de conflito
Warning	Erro de aviso

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InformationMetadata

Object

Representa o modelo de metadados da entidade Information (data).

Name	Tipo	Description
metadataKind	string: InformationMetadata	O tipo de objeto de metadados da entidade.
unit	InformationUnit	Unidade de medida para informação.
value	number (double)	O valor numérico que o texto extraído denota.

InformationUnit

Enumeração

A informação (dados) Unidade de medida.

Valor	Description
Unspecified	Unidade de tamanho de dados não especificada
Bit	Unidade de tamanho de dados em bits
Kilobit	Unidade de tamanho de dados em kilobits
Megabit	Unidade de tamanho de dados em megabits
Gigabit	Unidade de tamanho de dados em gigabits
Terabit	Unidade de tamanho de dados em terabits
Petabit	Unidade de tamanho de dados em petabits
Byte	Unidade de tamanho de dados em bytes
Kilobyte	Unidade de tamanho de dados em kilobytes
Megabyte	Unidade de tamanho de dados em megabytes
Gigabyte	Unidade de tamanho de dados em gigabytes
Terabyte	Unidade de tamanho de dados em terabytes
Petabyte	Unidade de tamanho de dados em petabytes

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválida
InvalidParameterValue	Erro de valor de parâmetro inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
AzureCognitiveSearchNotFound	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
ExtractionFailure	Erro de falha de extração
InvalidRequestBodyFormat	Erro de formato de corpo de solicitação inválido
EmptyRequest	Erro de solicitação vazia
MissingInputDocuments	Erro de documentos de entrada ausentes
InvalidDocument	Erro de documento inválido
ModelVersionIncorrect	Erro de versão incorreta do modelo
InvalidDocumentBatch	Erro de lote de documento inválido
UnsupportedLanguageCode	Erro de código de idioma não suportado
InvalidCountryHint	Erro de dica de país inválido

InnerErrorModel

Object

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

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

KeyPhraseResult

Object

Contém o KeyPhraseResult.

Name	Tipo	Description
documents	KeyPhrasesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

KeyPhrasesDocumentResult

Object

Contém os resultados da extração da frase-chave para um documento.

Name	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 foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

KeyPhraseTaskParameters

Object

Parâmetros suportados para uma tarefa de extração de frase-chave.

Name	Tipo	Default value	Description
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo

KeyPhraseTaskResult

Object

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 frases-chave

LanguageDetectionAnalysisInput

Object

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

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

LanguageDetectionDocumentResult

Object

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

Name	Tipo	Description
detectedLanguage	DetectedLanguage	Idioma detetado.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LanguageDetectionResult

Object

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

Name	Tipo	Description
documents	LanguageDetectionDocumentResult[]	Enumeração dos resultados da deteção de idioma para cada documento de entrada.
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

LanguageDetectionTaskParameters

Object

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

Name	Tipo	Default value	Description
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo

LanguageDetectionTaskResult

Object

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

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

LanguageInput

Object

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

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

LengthMetadata

Object

Representa o modelo de metadados da entidade Length.

Name	Tipo	Description
metadataKind	string: LengthMetadata	O tipo de objeto de metadados da entidade.
unit	LengthUnit	Unidade de medida para o comprimento.
value	number (double)	O valor numérico que o texto extraído denota.

LengthUnit

Enumeração

A unidade de medida de comprimento.

Valor	Description
Unspecified	Unidade de comprimento não especificada.
Kilometer	Unidade de comprimento em quilómetros.
Hectometer	Unidade de comprimento em hectómetros.
Decameter	Unidade de comprimento em decámetros.
Meter	Unidade de comprimento em metros.
Decimeter	Unidade de comprimento em decímetros.
Centimeter	Unidade de comprimento em centímetros.
Millimeter	Unidade de comprimento em milímetros.
Micrometer	Unidade de comprimento em micrômetros.
Nanometer	Unidade de comprimento em nanómetros.
Picometer	Unidade de comprimento em picometros.
Mile	Unidade de comprimento em milhas.
Yard	Unidade de comprimento em quintais.
Inch	Unidade de comprimento em polegadas.
Foot	Unidade de comprimento em pés.
LightYear	Unidade de comprimento em anos-luz.
Point	Unidade de comprimento em pontos.

LinkedEntitiesDocumentResult

Object

Resultado do documento de vinculação de entidade.

Name	Tipo	Description
entities	LinkedEntity[]	Entidades reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
statistics	DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

LinkedEntity

Object

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

Name	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 entidades, como Wiki/Bing, etc.
id	string	Identificador exclusivo da entidade reconhecida da fonte de dados.
language	string	Linguagem utilizada na fonte de dados.
matches	Match[]	Lista de instâncias Esta entidade aparece no texto.
name	string	Nome formal de vinculação de entidade.
url	string	URL da página da entidade da fonte de dados.

Match

Object

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

Name	Tipo	Description
confidenceScore	number (double)	Se um item bem conhecido for reconhecido, um número decimal denotando o nível de confiança entre 0 e 1 será retornado.
length	integer (int32)	Comprimento do texto correspondente à entidade.
offset	integer (int32)	Posição inicial do texto de correspondência da entidade.
text	string	Texto da entidade conforme aparece na solicitação.

MatchLongestEntityPolicyType

Object

Representa a política de sobreposição mais longa Match. Não há sobreposição de entidades, na medida do possível. 1. Se houver entidades sobrepostas, a mais longa será devolvida. 2. Se o conjunto de caracteres previsto para 2 ou mais entidades for exatamente o mesmo, selecione a entidade que tem a pontuação de confiança mais alta.3. Se as pontuações da entidade forem idênticas, retorne todas as entidades que ainda estão presentes após a aplicação das regras anteriores. 3. Se houver sobreposição parcial (como no Hello Text Analytics), siga as etapas acima a partir de 1.

Name	Tipo	Default value	Description
policyKind	string: matchLongest	matchLongest	O tipo de objeto OverlapPolicy da entidade.

MetadataKind

Enumeração

O tipo de objeto de metadados da entidade.

Valor	Description
DateMetadata	Metadados para valores relacionados à data.
DateTimeMetadata	Metadados para valores relacionados com data e hora.
TimeMetadata	Metadados para valores relacionados ao tempo.
TemporalSetMetadata	Metadados para o conjunto de valores relacionados ao tempo.
NumberMetadata	Metadados para valores numéricos.
OrdinalMetadata	Metadados para números ordinais.
SpeedMetadata	Metadados para valores relacionados com a velocidade.
WeightMetadata	Metadados para valores relacionados com o peso.
LengthMetadata	Metadados para valores relacionados ao comprimento.
VolumeMetadata	Metadados para valores relacionados ao volume.
AreaMetadata	Metadados para valores relacionados à área.
AgeMetadata	Metadados para valores relacionados com a idade.
InformationMetadata	Metadados para valores relacionados com informações.
TemperatureMetadata	Metadados para valores relacionados com a temperatura.
CurrencyMetadata	Metadados para valores relacionados com moedas.
NumericRangeMetadata	Metadados para valores de intervalo numérico.
TemporalSpanMetadata	Metadados para valores de extensão temporal.

MultiLanguageAnalysisInput

Object

Recolha de documentos de entrada a analisar pelo serviço.

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

MultiLanguageInput

Object

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

Name	Tipo	Description
id	string	Um identificador de documento exclusivo e não vazio.
language	string	(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão. (O seguinte aplica-se apenas a 2023-04-15-preview e superior) Para Auto Language Detection, use "auto". Se não estiver definido, use "en" para inglês como padrão.
text	string	O texto de entrada a ser processado.

NumberKind

Enumeração

O tipo da entidade numérica extraída.

Valor	Description
Integer	Número inteiro
Decimal	Número decimal
Power	Número de potência
Fraction	Número da fração
Percent	Número percentual
Unspecified	Tipo de número não especificado

NumberMetadata

Object

Um metadados para instâncias de entidade numérica.

Name	Tipo	Description
metadataKind	string: NumberMetadata	O tipo de objeto de metadados da entidade.
numberKind	NumberKind	Tipo do tipo de número.
value	number (double)	Uma representação numérica do que o texto extraído denota.

NumericRangeMetadata

Object

representa os metadados de intervalos numéricos.

Name	Tipo	Description
maximum	number (double)	O valor final do intervalo.
metadataKind	string: NumericRangeMetadata	O tipo de objeto de metadados da entidade.
minimum	number (double)	O valor inicial do intervalo.
rangeInclusivity	RangeInclusivity	A abrangência desta gama.
rangeKind	RangeKind	Tipo de intervalos numéricos suportados - como número, velocidade, etc.

OrdinalMetadata

Object

Um metadados para instâncias de entidade numérica.

Name	Tipo	Description
metadataKind	string: OrdinalMetadata	O tipo de objeto de metadados da entidade.
offset	string	O deslocamento em relação à referência (por exemplo, deslocamento = -1 indica o penúltimo)
relativeTo	RelativeTo	O ponto de referência que o número ordinal denota.
value	string	Uma expressão aritmética simples que o ordinal denota.

PiiCategory

Enumeração

(Opcional) descreve as categorias de PII a serem retornadas

Valor	Description
ABARoutingNumber	Número de roteamento ABA
ARNationalIdentityNumber	Número de Identidade Nacional da RA
AUBankAccountNumber	Número da conta bancária AT
AUDriversLicenseNumber	Número da Carteira de Motorista AU
AUMedicalAccountNumber	Número de Conta Médica AU
AUPassportNumber	Número de passaporte AU
AUTaxFileNumber	Número de identificação fiscal AU
AUBusinessNumber	Número de Negócio AU
AUCompanyNumber	Número da empresa AU
ATIdentityCard	Bilhete de Identidade AT
ATTaxIdentificationNumber	Número de identificação fiscal AT
ATValueAddedTaxNumber	Número de Imposto sobre o Valor Acrescentado AT
AzureDocumentDBAuthKey	Chave de autenticação do Banco de Dados de Documentos do Azure
AzureIAASDatabaseConnectionAndSQLString	Conexão de banco de dados IAAS do Azure e cadeia de caracteres SQL
AzureIoTConnectionString	Cadeia de Conexão do Azure IoT
AzurePublishSettingPassword	Senha de configuração de publicação do Azure
AzureRedisCacheString	Cadeia de caracteres do cache Redis do Azure
AzureSAS	Azure SAS
AzureServiceBusString	Cadeia de caracteres do Barramento de Serviço do Azure
AzureStorageAccountKey	Chave da Conta de Armazenamento do Azure
AzureStorageAccountGeneric	Conta de Armazenamento do Azure Genérica
BENationalNumber	Número Nacional BE
BENationalNumberV2	BE Número Nacional V2
BEValueAddedTaxNumber	Número de Imposto sobre o Valor Acrescentado BE
BRCPFNumber	Número do CPF BR
BRLegalEntityNumber	Número de Pessoa Jurídica BR
BRNationalIDRG	BR National ID RG
BGUniformCivilNumber	BG Número Civil Uniforme
CABankAccountNumber	Número da conta bancária CA
CADriversLicenseNumber	Número da Carteira de Motorista CA
CAHealthServiceNumber	Número do serviço de saúde da autoridade de certificação
CAPassportNumber	Número de passaporte CA
CAPersonalHealthIdentification	Identificação pessoal de saúde da CA
CASocialInsuranceNumber	Número de Seguro Social CA
CLIdentityCardNumber	Número do Bilhete de Identidade CL
CNResidentIdentityCardNumber	Número do Bilhete de Identidade de Residente CN
CreditCardNumber	Número do Cartão de Crédito
HRIdentityCardNumber	Número do Bilhete de Identidade HR
HRNationalIDNumber	Número de identificação nacional HR
HRPersonalIdentificationNumber	Número de Identificação Pessoal RH
HRPersonalIdentificationOIBNumberV2	HR Identificação Pessoal OIB Número V2
CYIdentityCard	Bilhete de Identidade CY
CYTaxIdentificationNumber	Número de identificação fiscal CY
CZPersonalIdentityNumber	Número de Identidade Pessoal CZ
CZPersonalIdentityV2	CZ Identidade Pessoal V2
DKPersonalIdentificationNumber	Número de identificação pessoal DK
DKPersonalIdentificationV2	DK Identificação Pessoal V2
DrugEnforcementAgencyNumber	Número da Agência Antidrogas
EEPersonalIdentificationCode	Código de Identificação Pessoal EE
EUDebitCardNumber	Número do Cartão de Débito da UE
EUDriversLicenseNumber	Número da Carteira de Habilitação da UE
EUGPSCoordinates	Coordenadas GPS da UE
EUNationalIdentificationNumber	Número de identificação nacional da UE
EUPassportNumber	Número de passaporte da UE
EUSocialSecurityNumber	Número de segurança social na UE
EUTaxIdentificationNumber	Número de identificação fiscal da UE
FIEuropeanHealthNumber	FI Número Europeu de Saúde
FINationalID	Identificação nacional FI
FINationalIDV2	FI ID Nacional V2
FIPassportNumber	Número de passaporte FI
FRDriversLicenseNumber	Número da Carteira de Habilitação FR
FRHealthInsuranceNumber	FR Número de seguro de saúde
FRNationalID	Identificação nacional FR
FRPassportNumber	FR Número de passaporte
FRSocialSecurityNumber	FR Número de Segurança Social
FRTaxIdentificationNumber	Número de identificação fiscal FR
FRValueAddedTaxNumber	Número de Imposto sobre o Valor Acrescentado FR
DEDriversLicenseNumber	Número da Carteira de Habilitação DE
DEPassportNumber	Número de passaporte DE
DEIdentityCardNumber	Número do Bilhete de Identidade DE
DETaxIdentificationNumber	Número de identificação fiscal DE
DEValueAddedNumber	Número de valor acrescentado DE
GRNationalIDCard	GR Cartão Nacional de Identificação
GRNationalIDV2	GR ID Nacional V2
GRTaxIdentificationNumber	GR Número de Identificação Fiscal
HKIdentityCardNumber	Número do Bilhete de Identidade HK
HUValueAddedNumber	Número de valor acrescentado da HU
HUPersonalIdentificationNumber	Número de identificação pessoal HU
HUTaxIdentificationNumber	Número de identificação fiscal do HU
INPermanentAccount	Conta Permanente IN
INUniqueIdentificationNumber	Número de identificação único IN
IDIdentityCardNumber	Número do Bilhete de Identidade
InternationalBankingAccountNumber	Número de Conta Bancária Internacional
IEPersonalPublicServiceNumber	IE Número de Serviço Público Pessoal
IEPersonalPublicServiceNumberV2	Número de Serviço Público Pessoal do IE V2
ILBankAccountNumber	Número da conta bancária IL
ILNationalID	IL Identificação Nacional
ITDriversLicenseNumber	Número da Carteira de Motorista de TI
ITFiscalCode	Código Fiscal de TI
ITValueAddedTaxNumber	Número de Imposto sobre Valor Agregado de TI
JPBankAccountNumber	Número de conta bancária JP
JPDriversLicenseNumber	Número da Carteira de Habilitação JP
JPPassportNumber	Número de passaporte JP
JPResidentRegistrationNumber	Número de Registo de Residente JP
JPSocialInsuranceNumber	Número de Segurança Social JP
JPMyNumberCorporate	JP Meu Número Corporativo
JPMyNumberPersonal	JP Meu Número Pessoal
JPResidenceCardNumber	Número do Cartão de Residência JP
LVPersonalCode	Código Pessoal LV
LTPersonalCode	Código Pessoal LT
LUNationalIdentificationNumberNatural	LU Número de Identificação Nacional Natural
LUNationalIdentificationNumberNonNatural	LU Número Nacional de Identificação Não Natural
MYIdentityCardNumber	Número do Bilhete de Identidade MY
MTIdentityCardNumber	Número do Bilhete de Identidade MT
MTTaxIDNumber	Número de identificação fiscal MT
NLCitizensServiceNumber	NL Número de Serviço ao Cidadão
NLCitizensServiceNumberV2	NL Número de Serviço ao Cidadão V2
NLTaxIdentificationNumber	NL Número de identificação fiscal
NLValueAddedTaxNumber	NL Número de Imposto sobre o Valor Acrescentado
NZBankAccountNumber	Número de conta bancária NZ
NZDriversLicenseNumber	Número da Carteira de Motorista NZ
NZInlandRevenueNumber	NZ Número de Receita Interna
NZMinistryOfHealthNumber	NZ Ministério da Saúde Número
NZSocialWelfareNumber	NZ Número de Bem-Estar Social
NOIdentityNumber	SEM Número de Identidade
PHUnifiedMultiPurposeIDNumber	Número de identificação multiuso unificado PH
PLIdentityCard	Bilhete de Identidade PL
PLNationalID	PL Identificação Nacional
PLNationalIDV2	PL ID Nacional V2
PLPassportNumber	PL Número de passaporte
PLTaxIdentificationNumber	Número de Identificação Fiscal PL
PLREGONNumber	Número PL REGON
PTCitizenCardNumber	Número do Cartão de Cidadão PT
PTCitizenCardNumberV2	Cartão de Cidadão PT Número V2
PTTaxIdentificationNumber	Número de Identificação Fiscal PT
ROPersonalNumericalCode	Código numérico pessoal RO
RUPassportNumberDomestic	RU Número de passaporte doméstico
RUPassportNumberInternational	Número de passaporte RU Internacional
SANationalID	Identificação nacional SA
SGNationalRegistrationIdentityCardNumber	Número do Bilhete de Identidade de Registo Nacional SG
SKPersonalNumber	Número Pessoal SK
SITaxIdentificationNumber	SI Número de Identificação Fiscal
SIUniqueMasterCitizenNumber	SI Número Único de Cidadão Mestre
ZAIdentificationNumber	Número de identificação ZA
KRResidentRegistrationNumber	Número de Registo de Residente KR
ESDNI	ES DNI
ESSocialSecurityNumber	ES Número de Segurança Social
ESTaxIdentificationNumber	Número de identificação fiscal ES
SQLServerConnectionString	Cadeia de conexão do SQL Server
SENationalID	Identificação nacional SE
SENationalIDV2	ID nacional SE V2
SEPassportNumber	Número de passaporte SE
SETaxIdentificationNumber	Número de identificação fiscal SE
SWIFTCode	Código SWIFT
CHSocialSecurityNumber	Número de Segurança Social CH
TWNationalID	Identificação nacional TW
TWPassportNumber	Número de passaporte TW
TWResidentCertificate	Certificado de Residente TW
THPopulationIdentificationCode	Código de Identificação da População TH
TRNationalIdentificationNumber	Número de identificação nacional TR
UKDriversLicenseNumber	Número da Carteira de Motorista do Reino Unido
UKElectoralRollNumber	Número dos cadernos eleitorais do Reino Unido
UKNationalHealthNumber	Número nacional de saúde do Reino Unido
UKNationalInsuranceNumber	Número de seguro nacional do Reino Unido
UKUniqueTaxpayerNumber	Número de contribuinte único do Reino Unido
USUKPassportNumber	Número de passaporte do Reino Unido dos EUA
USBankAccountNumber	Número de conta bancária nos EUA
USDriversLicenseNumber	Número da Carteira de Motorista dos EUA
USIndividualTaxpayerIdentification	Identificação de Contribuinte Individual dos EUA
USSocialSecurityNumber	Número de Segurança Social dos EUA
UAPassportNumberDomestic	Número de passaporte UA Doméstico
UAPassportNumberInternational	Número de passaporte UA Internacional
Organization	Organização
Email	Email
URL	URL
Age	Idade
PhoneNumber	Número de Telefone
IPAddress	Endereço IP
Date	Date
Person	Pessoa
Address	Address
DateOfBirth	Data de nascimento
BankAccountNumber	Número da conta bancária
PassportNumber	Número de passaporte
DriversLicenseNumber	Número da Carteira de Motorista
SortCode	Código de classificação. Número de 6 dígitos utilizado no Reino Unido para identificar um banco e uma sucursal específicos onde é mantida uma conta bancária
VehicleIdentificationNumber	VIN
All	Todas as categorias de PII.
Default	Categorias de PII padrão para o idioma.

PiiDomain

Enumeração

Domínio para tarefa PII

Valor	Description
phi	Indica que as entidades no domínio Informações Pessoais de Saúde devem ser editadas.
none	Indica que nenhum domínio é especificado.

PiiEntitiesDocumentResult

Object

Contém os resultados da PII.

Name	Tipo	Description
entities	Entity[]	Entidades reconhecidas no documento.
id	string	Identificador de documento exclusivo e não vazio.
redactedText	string	Retorna texto editado.
statistics	DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

PiiResult

Object

Contém o PiiResult.

Name	Tipo	Description
documents	PiiEntitiesDocumentResult[]	Resposta por documento
errors	DocumentError[]	Erros por ID do documento.
modelVersion	string	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

PiiTaskParameters

Object

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

Name	Tipo	Default value	Description
domain	PiiDomain	none	Domínio para tarefa PII
loggingOptOut	boolean	True	desativação de 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

Object

Contém a tarefa LRO PIIEntityRecognition de texto de análise.

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

RangeInclusivity

Enumeração

A abrangência desta propriedade de propriedade.

Valor	Description
NoneInclusive	Sem inclusão
LeftInclusive	Lado esquerdo inclusivo
RightInclusive	Lado direito inclusivo
LeftRightInclusive	Ambos os lados inclusivos

RangeKind

Enumeração

O tipo de entidade do intervalo de números.

Valor	Description
Number	Intervalo de números
Speed	Faixa de velocidade
Weight	Faixa de peso
Length	Faixa de comprimento
Volume	Intervalo de volume
Area	Gama de áreas
Age	Faixa etária
Information	Gama de informações
Temperature	Faixa de temperatura
Currency	Intervalo de moedas

RelativeTo

Enumeração

O ponto de referência que o número ordinal denota.

Valor	Description
Current	Estado ou posição atual
End	Estado ou posição final
Start	Estado ou posição inicial

RequestStatistics

Object

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

Name	Tipo	Description
documentsCount	integer (int32)	Número de documentos apresentados no pedido.
erroneousDocumentsCount	integer (int32)	Número de documentos inválidos. Isso inclui documentos vazios, com limite de tamanho excessivo ou sem suporte.
transactionsCount	integer (int64)	Número de transações para a solicitação.
validDocumentsCount	integer (int32)	Número de documentos válidos. Isso exclui documentos vazios, com limite de tamanho excessivo ou idiomas não suportados.

ScriptCode

Enumeração

Identifica o script do documento de entrada. Mapeia para o código de script padrão ISO 15924.

Valor	Description
Arab	Código de script para o script árabe.
Armn	Código de script para o script armênio.
Beng	Código de script para o script Bangla.
Cans	Código de script para o script UnifiedCanadianAboriginalSyllabics.
Cyrl	Código de script para o script cirílico.
Deva	Código de script para o script Devanagari.
Ethi	Código de script para o script etíope.
Geor	Código de script para o script georgiano.
Grek	Código de script para o script grego.
Gujr	Código de script para o script Gujarati.
Guru	Código de script para o script Gurmukhi.
Hang	Código de script para o script Hangul.
Hani	Código de script para o script HanLiteral.
Hans	Código de script para o script HanSimplified .
Hant	Código de script para o script HanTradicional.
Hebr	Código de script para o script hebraico.
Jpan	Código de script para o script japonês.
Khmr	Código de script para o script Khmer.
Knda	Código de script para o script Kannada.
Laoo	Código de script para o script Lao.
Latn	Código de script para o alfabeto latino.
Mlym	Código de script para o script Malayalam.
Mong	Código de script para o script mongol.
Mtei	Código de script para o script Meitei.
Mymr	Código de script para o script de Mianmar.
Olck	Código de script para o script Santali.
Orya	Código de script para o script Odia.
Sinh	Código de script para o script cingalês.
Shrd	Código de script para o script Sharada.
Taml	Código de script para o script tâmil.
Telu	Código de script para o script Telugu.
Thaa	Código de script para o script Thaana.
Thai	Código de script para o script tailandês.
Tibt	Código de script para o script tibetano.

ScriptKind

Enumeração

Identifica o script do documento de entrada. Mapeia para o nome formal da norma ISO 15924.

Valor	Description
Arabic	Nome do script para o script árabe.
Armenian	Nome do script para o script armênio.
Bangla	Nome do script Bangla.
UnifiedCanadianAboriginalSyllabics	Nome do script UnifiedCanadianAboriginalSyllabics.
Cyrillic	Nome do script para o script cirílico.
Devanagari	Nome do script Devanagari.
Ethiopic	Nome do script para o script etíope.
Georgian	Nome do script para o script georgiano.
Greek	Nome do script para o script grego.
Gujarati	Nome do script Gujarati.
Gurmukhi	Nome do script para o script Gurmukhi.
Hangul	Nome do script Hangul.
HanLiteral	Nome do script para o script HanLiteral.
HanSimplified	Nome do script para o script HanSimplified .
HanTraditional	Nome do script para o script HanTradicional.
Hebrew	Nome do script para o script hebraico.
Japanese	Nome do script para o script japonês.
Khmer	Nome do script Khmer.
Kannada	Nome do script Kannada.
Lao	Nome do script para o script Laos.
Latin	Nome do script para o alfabeto latino.
Malayalam	Nome do script para o script Malayalam.
Meitei	Nome do script Meitei.
Mongolian	Nome do script para o script mongol.
Myanmar	Nome do script para o script Myanmar.
Odia	Nome do script Odia.
Santali	Nome do script Santali.
Sharada	Nome do script Sharada.
Sinhala	Nome do script cingalês.
Tamil	Nome do script para o script tâmil.
Telugu	Nome do script Telugu.
Thaana	Nome do script Thaana.
Thai	Nome do script tailandês.
Tibetan	Nome do script para o script tibetano.

SentenceAssessment

Object

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

Name	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.
isNegated	boolean	O indicador que representa se a avaliação é negada.
length	integer (int32)	O comprimento do alvo.
offset	integer (int32)	O deslocamento do alvo desde o início da frase.
sentiment	TokenSentimentValue	O sentimento da sentença.
text	string	O texto de destino detetado.

SentenceSentiment

Object

Sentimento da frase de um documento.

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

SentenceSentimentValue

Enumeração

O sentimento previsto para a sentença.

Valor	Description
positive	Sentimento positivo
neutral	Sentimento neutro
negative	Sentimento negativo

SentenceTarget

Object

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

Name	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.
length	integer (int32)	O comprimento do alvo.
offset	integer (int32)	O deslocamento do alvo 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 sentença.
text	string	O texto de destino detetado.

SentimentAnalysisTaskParameters

Object

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

Name	Tipo	Default value	Description
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo
opinionMining	boolean	False	Se deve ou não usar a mineração de opinião no pedido.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres.

SentimentConfidenceScores

Object

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

Name	Tipo	Description
negative	number (double)	Pontuação de confiança para sentimento negativo
neutral	number (double)	Pontuação de confiança para sentimento neutro
positive	number (double)	Pontuação de confiança para sentimento positivo

SentimentDocumentResult

Object

Um objeto que representa os resultados pré-construídos da Análise de Sentimento de cada documento.

Name	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 documento sentencia o sentimento.
sentiment	DocumentSentimentValue	Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).
statistics	DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

SentimentResponse

Object

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

Name	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	Este campo indica qual modelo é usado para pontuação.
statistics	RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

SentimentTaskResult

Object

Contém o resultado da tarefa LRO SentimentAnalysis de texto de análise.

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

SpeedMetadata

Object

Representa o modelo de metadados da entidade Speed.

Name	Tipo	Description
metadataKind	string: SpeedMetadata	O tipo de objeto de metadados da entidade.
unit	SpeedUnit	Unidade de medida para velocidade.
value	number (double)	O valor numérico que o texto extraído denota.

SpeedUnit

Enumeração

A velocidade Unidade de medida

Valor	Description
Unspecified	Unidade de velocidade não especificada.
MetersPerSecond	Unidade de velocidade em metros por segundo.
KilometersPerHour	Unidade de velocidade em quilómetros por hora.
KilometersPerMinute	Unidade de velocidade em quilômetros por minuto.
KilometersPerSecond	Unidade de velocidade em quilômetros por segundo.
MilesPerHour	Unidade de velocidade em milhas por hora.
Knots	Unidade de velocidade em nós.
FeetPerSecond	Unidade de velocidade em pés por segundo.
FeetPerMinute	Unidade de velocidade em pés por minuto.
YardsPerMinute	Unidade de velocidade em jardas por minuto.
YardsPerSecond	Unidade de velocidade em jardas por segundo.
MetersPerMillisecond	Unidade de velocidade em metros por milissegundo.
CentimetersPerMillisecond	Unidade de velocidade em centímetros por milissegundo.
KilometersPerMillisecond	Unidade de velocidade em quilômetros por milissegundo.

StringIndexType

Enumeração

Tipo de índice de cadeia de caracteres

Valor	Description
TextElements_v8	Os valores de deslocamento e comprimento retornados corresponderão a TextElements (Graphemes e clusters Grapheme) confirmando para o padrão Unicode 8.0.0. Use esta opção se seu aplicativo estiver escrito em .Net Framework ou .Net Core e você estiver usando StringInfo.
UnicodeCodePoint	Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Python.
Utf16CodeUnit	Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Java, JavaScript.

TargetConfidenceScoreLabel

Object

Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.

Name	Tipo	Description
negative	number (double)	Pontuação de confiança para sentimento negativo
positive	number (double)	Pontuação de confiança para sentimento positivo

TargetRelation

Object

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

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

TargetRelationType

Enumeração

O tipo relacionado ao destino.

Valor	Description
assessment	Relação de avaliação.
target	Relação alvo.

TemperatureMetadata

Object

Representa o modelo de metadados da entidade de informação.

Name	Tipo	Description
metadataKind	string: TemperatureMetadata	O tipo de objeto de metadados da entidade.
unit	TemperatureUnit	Unidade de medida para a temperatura.
value	number (double)	O valor numérico que o texto extraído denota.

TemperatureUnit

Enumeração

A unidade de medida de temperatura.

Valor	Description
Unspecified	Unidade de temperatura não especificada
Fahrenheit	Unidade de temperatura em Fahrenheit
Kelvin	Unidade de temperatura em Kelvin
Rankine	Unidade de temperatura em Rankine
Celsius	Unidade de temperatura em Celsius

TemporalModifier

Enumeração

Um modificador opcional de uma instância de data/hora.

Valor	Description
AfterApprox	Após um tempo aproximado
Before	Antes de um momento específico
BeforeStart	Antes do início de um período de tempo
Approx	Aproximadamente num momento específico
ReferenceUndefined	Referência a uma hora indefinida
SinceEnd	Desde o final de um período de tempo
AfterMid	Após o meio de um período de tempo
Start	No início de um período de tempo
After	Após um tempo específico
BeforeEnd	Antes do final de um período de tempo
Until	Até um momento específico
End	No final de um período de tempo
Less	Menos do que um tempo específico
Since	Desde um momento específico
AfterStart	Após o início de um período de tempo
BeforeApprox	Antes de um tempo aproximado
Mid	No meio de um período de tempo
More	Mais do que um tempo específico

TemporalSetMetadata

Object

Um Metadados para instâncias de entidade de conjunto temporal.

Name	Tipo	Description
dateValues	DateValue[]	Lista de valores de data.
metadataKind	string: TemporalSetMetadata	O tipo de objeto de metadados da entidade.

TemporalSpanMetadata

Object

representa os metadados de um período de data e/ou hora.

Name	Tipo	Description
metadataKind	string: TemporalSpanMetadata	O tipo de objeto de metadados da entidade.
spanValues	TemporalSpanValues[]	Lista de intervalos temporais detetados.

TemporalSpanValues

Object

Objeto de span temporal.

Name	Tipo	Description
begin	string	Valor inicial para a extensão.
duration	string	Um valor de duração opcional formatado com base na norma ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Valor final para a extensão.
modifier	TemporalModifier	Modificador para datetime para indicar ponto de referência como antes, depois etc.
timex	string	Um trio opcional contendo o início, o fim e a duração, todos declarados como strings formatadas ISO 8601.

TimeMetadata

Object

Um Metadados para instâncias de entidade de tempo.

Name	Tipo	Description
dateValues	DateValue[]	Lista de valores de data.
metadataKind	string: TimeMetadata	O tipo de objeto de metadados da entidade.

TokenSentimentValue

Enumeração

O sentimento previsto para a sentença.

Valor	Description
positive	Sentimento positivo
mixed	Sentimento misto
negative	Sentimento negativo

VolumeMetadata

Object

Representa o modelo de metadados da entidade Volume.

Name	Tipo	Description
metadataKind	string: VolumeMetadata	O tipo de objeto de metadados da entidade.
unit	VolumeUnit	Unidade de medida para o volume.
value	number (double)	O valor numérico que o texto extraído denota.

VolumeUnit

Enumeração

A unidade de medida volumétrica

Valor	Description
Unspecified	Unidade de volume não especificada.
CubicMeter	Unidade de volume em metros cúbicos.
CubicCentimeter	Unidade de volume em centímetros cúbicos.
CubicMillimeter	Unidade de volume em milímetros cúbicos.
Hectoliter	Unidade de volume em hectolitros.
Decaliter	Unidade de volume em decalitros.
Liter	Unidade de volume em litros.
Centiliter	Unidade de volume em centímetros.
Milliliter	Unidade de volume em mililitros.
CubicYard	Unidade de volume em quintais cúbicos.
CubicInch	Unidade de volume em polegadas cúbicas.
CubicFoot	Unidade de volume em pés cúbicos.
CubicMile	Unidade de volume em milhas cúbicas.
FluidOunce	Unidade de volume em onças fluidas.
Teaspoon	Unidade de volume em colheres de chá.
Tablespoon	Unidade de volume em colheres de sopa.
Pint	Unidade de volume em pints.
Quart	Unidade de volume em quarts.
Cup	Unidade de volume em copos.
Gill	Unidade de volume em brânquias.
Pinch	Unidade de volume em beliscões.
FluidDram	Unidade de volume em drenos fluidos.
Barrel	Unidade de volume em barris.
Minim	Unidade de volume em mínimos.
Cord	Unidade de volume em cabos.
Peck	Unidade de volume em bicadas.
Bushel	Unidade de volume em alqueires.
Hogshead	Unidade de volume em cabeças de porco.

WarningCodeValue

Enumeração

Define a lista dos códigos de aviso.

Valor	Description
LongWordsInDocument	Palavras longas no aviso do documento
DocumentTruncated	Aviso truncado do documento

WeightMetadata

Object

Representa o modelo de metadados da entidade Weight ).

Name	Tipo	Description
metadataKind	string: WeightMetadata	O tipo de objeto de metadados da entidade.
unit	WeightUnit	Unidade de medida para o peso.
value	number (double)	O valor numérico que o texto extraído denota.

WeightUnit

Enumeração

A unidade de medida de peso.

Valor	Description
Unspecified	Unidade de peso não especificada
Kilogram	Unidade de peso em quilogramas
Gram	Unidade de peso em gramas
Milligram	Unidade de peso em miligramas
Gallon	Unidade de volume em galões
MetricTon	Unidade de peso em toneladas métricas
Ton	Unidade de peso em toneladas
Pound	Unidade de peso em libras
Ounce	Unidade de peso em onças
Grain	Unidade de peso em grãos
PennyWeight	Unidade de peso em pennyweights
LongTonBritish	Unidade de peso em toneladas longas (britânico)
ShortTonUS	Unidade de peso em toneladas curtas (EUA)
ShortHundredWeightUS	Unidade de peso em cem pesos curtos (EUA)
Stone	Unidade de peso em pedras
Dram	Unidade de peso em drams

Partilhar via

Analyze Text - Analyze Text

Parâmetros do URI

Corpo do Pedido

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

SuccessfulEntityLinkingRequest

Pedido de amostra

Resposta da amostra

SuccessfulEntityRecognitionExclusionRequest

Pedido de amostra

Resposta da amostra

SuccessfulEntityRecognitionInclusionRequest

Pedido de amostra

Resposta da amostra

SuccessfulEntityRecognitionInferenceOptionsRequest

Pedido de amostra

Resposta da amostra

SuccessfulEntityRecognitionOverlapPolicy

Pedido de amostra

Resposta da amostra

SuccessfulEntityRecognitionRequest

Pedido de amostra

Resposta da amostra

SuccessfulKeyPhraseExtractionRequest

Pedido de amostra

Resposta da amostra

SuccessfulLanguageDetectionRequest

Pedido de amostra

Resposta da amostra

SuccessfulPiiEntityRecognitionRequest

Pedido de amostra

Resposta da amostra

SuccessfulSentimentAnalysisRequest

Pedido de amostra

Resposta da amostra

Definições

AgeMetadata

AgeUnit

AllowOverlapEntityPolicyType

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

AreaMetadata

AreaUnit

CurrencyMetadata

DateMetadata

DateTimeMetadata

DateValue

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResultWithMetadata

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityCategory

EntityInferenceOptions

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

EntityTag