Text Analysis Runtime - Analyze Text

Referência

Serviço:: Azure AI Services

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

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

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

Com parâmetros opcionais:

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

Parâmetros de URI

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

Corpo da solicitação

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

Nome	Description
AnalyzeTextEntityLinkingInput	Contém a entrada de vinculação de entidade de texto de análise.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidade analisa a solicitação de tarefa de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contém a entrada da tarefa de análise de documento de detecção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa analisar texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa Analisar texto SentimentAnalysis.

AnalyzeTextEntityLinkingInput

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

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

AnalyzeTextEntityRecognitionInput

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

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

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.

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

AnalyzeTextLanguageDetectionInput

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

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

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa analisar texto PIIEntityRecognition.

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

AnalyzeTextSentimentAnalysisInput

Contém a entrada da tarefa Analisar texto SentimentAnalysis.

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

Respostas

Nome	Tipo	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

A solicitação foi bem-sucedida.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Escopos

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

Exemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

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

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-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 de exemplo

Código de status:: 200

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

Definições

Nome	Description
AgeMetadata	Representa o modelo de metadados da entidade Age.
AgeUnit	A Unidade de Idade da Medida
AllowOverlapEntityPolicyType	Representa a política de sobreposição de permissões. Não aplicará nenhuma lógica de pós-processamento para as entidades. O que quer que o modelo preveja é o que será retornado 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 entidade
AnalyzeTextEntityLinkingInput	Contém a entrada de vinculação de entidade de texto de análise.
AnalyzeTextEntityRecognitionInput	O reconhecimento de entidade analisa a solicitação de tarefa de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contém a entrada da tarefa de análise de documento de detecção de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contém a entrada da tarefa analisar texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contém a entrada da tarefa Analisar texto SentimentAnalysis.
AnalyzeTextTaskKind	O tipo de tarefas de texto de análise com suporte.
AnalyzeTextTaskResultsKind	O tipo do objeto de resposta retornado pela tarefa analyze-text.
AreaMetadata	Representa o modelo de metadados de entidade de área.
AreaUnit	A unidade de área de medida.
CurrencyMetadata	Representa o modelo de metadados da entidade Currency ).
DateMetadata	Metadados para instâncias de entidade de data.
DateTimeMetadata	Metadados para instâncias de entidade datetime.
DateValue	Representa o valor da data.
DetectedLanguage	Contém os detalhes do idioma detectado para o texto.
DocumentError	Contém detalhes dos erros encontrados durante uma execução de trabalho.
DocumentSentimentValue	Sentimento previsto para documento (Negativo, Neutro, Positivo ou Misto).
DocumentStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento.
DocumentWarning	Contém o objeto de avisos com avisos encontrados para o documento processado.
EntitiesDocumentResultWithMetadata	Os documentos de entidade resultam com metadados.
EntitiesResult	Contém o resultado da tarefa de reconhecimento de entidade.
EntitiesTaskParameters	Parâmetros com suporte para uma tarefa de Reconhecimento de Entidade.
EntitiesTaskResult	Contém a tarefa de entidade
Entity	Define o objeto de entidade detectado que contém a categoria de entidade e o texto da entidade detectados, etc.
EntityCategory	Contém todas as categorias de entidade detectadas pelo reconhecimento de entidade.
EntityInferenceOptions	A classe que abriga as opções de inferência permitidas para o reconhecimento de entidade nomeada.
EntityLinkingResult	Resultado da vinculação de entidade.
EntityLinkingTaskParameters	Parâmetros com suporte 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 marca de entidade que contém o nome das marcas abd qualquer pontuação de confiança associada. Marcas de entidade são usadas para expressar algumas semelhanças/afinidade entre entidades.
EntityWithMetadata	Objeto de entidade com marcas 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 de entidade de informações (dados).
InformationUnit	A unidade de medida de informações (dados).
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 de extração de frase-chave para um documento.
KeyPhraseTaskParameters	Parâmetros com suporte para uma tarefa de extração de frases-chave.
KeyPhraseTaskResult	Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contém a entrada de análise de documento de detecção de idioma.
LanguageDetectionDocumentResult	Contém a detecção de idioma de um documento.
LanguageDetectionResult	Contém o resultado da detecção de idioma para a solicitação.
LanguageDetectionTaskParameters	Parâmetros com suporte para uma tarefa de Detecção de Idioma.
LanguageDetectionTaskResult	Contém o resultado da tarefa de detecção de idioma para a solicitação.
LanguageInput	Contém a entrada de detecção de idioma.
LengthMetadata	Representa o modelo de metadados de entidade length.
LengthUnit	A unidade de comprimento da medida.
LinkedEntitiesDocumentResult	Resultado do documento de vinculação de entidade.
LinkedEntity	O objeto LinkedEntity que contém a entidade detectada com as fontes/links associados.
Match	O objeto Match que contém o texto da entidade detectado com o deslocamento e o comprimento.
MatchLongestEntityPolicyType	Representa a política de sobreposição mais longa de correspondência. Não há entidades sobrepostas tanto quanto possível. 1. Se houver entidades sobrepostas, a mais longa será retornada. 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 de 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 em Hello Text Analytics) siga as etapas acima a partir de 1.
MetadataKind	O tipo de objeto de metadados de entidade.
MultiLanguageAnalysisInput	Coleção de documentos de entrada a serem analisados pelo serviço.
MultiLanguageInput	Contém um documento de entrada a ser analisado pelo serviço.
NumberKind	O tipo da entidade de número extraída.
NumberMetadata	Metadados para instâncias de entidade numérica.
NumericRangeMetadata	representa os Metadados de intervalos numéricos.
OrdinalMetadata	Metadados para instâncias de entidade numérica.
PiiCategory	(Opcional) descreve as categorias de PII a serem retornadas
PiiDomain	Tarefa Domínio para PII
PiiEntitiesDocumentResult	Contém os resultados de PII.
PiiResult	Contém o PiiResult.
PiiTaskParameters	Parâmetros com suporte para uma tarefa de Reconhecimento de Entidades de PII.
PiiTaskResult	Contém a tarefa LRO de análise de texto PIIEntityRecognition.
RangeInclusivity	A inclusão de intervalo dessa propriedade.
RangeKind	O tipo da entidade de intervalo de números.
RelativeTo	O ponto de referência que o número ordinal indica.
RequestStatistics	se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo 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 padrão ISO 15924.
SentenceAssessment	Representa uma avaliação de sentença e as avaliações ou objetos de destino relacionados a ela.
SentenceSentiment	O sentimento da frase de um documento.
SentenceSentimentValue	O sentimento previsto para a frase.
SentenceTarget	Representa um destino de frase e as avaliações ou objetos de destino relacionados a ele.
SentimentAnalysisTaskParameters	Parâmetros com suporte para uma tarefa de Análise de Sentimento.
SentimentConfidenceScores	Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa.
SentimentDocumentResult	Um objeto que representa os resultados predefinidos da Análise de Sentimento de cada documento.
SentimentResponse	Resultados da análise de sentimento para os documentos de entrada.
SentimentTaskResult	Contém o resultado da tarefa LRO de análise de texto SentimentAnalysis.
SpeedMetadata	Representa o modelo de metadados da entidade Speed.
SpeedUnit	A unidade de velocidade de medida
StringIndexType	Tipo de índice de cadeia de caracteres
TargetConfidenceScoreLabel	Representa as pontuações de confiança em todas as classes de sentimento: positivas e negativas.
TargetRelation	Representa a relação entre avaliações e/ou destinos.
TargetRelationType	O tipo relacionado ao destino.
TemperatureMetadata	Representa o modelo de metadados de entidade de informações.
TemperatureUnit	A unidade de temperatura da medida.
TemporalModifier	Um modificador opcional de uma instância de data/hora.
TemporalSetMetadata	Metadados para instâncias de entidade do conjunto temporal.
TemporalSpanMetadata	representa os Metadados de uma data e/ou intervalo de tempo.
TemporalSpanValues	Objeto de intervalo temporal.
TimeMetadata	Metadados para instâncias de entidade de tempo.
TokenSentimentValue	O sentimento previsto para a frase.
VolumeMetadata	Representa o modelo de metadados de entidade de volume.
VolumeUnit	A unidade de volume de medida
WarningCodeValue	Define a lista dos códigos de aviso.
WeightMetadata	Representa o modelo de metadados de entidade Weight ).
WeightUnit	A unidade de peso da medida.

AgeMetadata

Representa o modelo de metadados da entidade Age.

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

AgeUnit

A Unidade de Idade da Medida

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

AllowOverlapEntityPolicyType

Representa a política de sobreposição de permissões. Não aplicará nenhuma lógica de pós-processamento para as entidades. O que quer que o modelo preveja é o que será retornado 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 entidade

Nome	Tipo	Valor padrão	Description
policyKind	string: allowOverlap	matchLongest	O tipo de objeto OverlapPolicy da entidade.

AnalyzeTextEntityLinkingInput

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

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

AnalyzeTextEntityRecognitionInput

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

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

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa Analisar texto KeyPhraseExtraction.

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

AnalyzeTextLanguageDetectionInput

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

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

AnalyzeTextPiiEntitiesRecognitionInput

Contém a entrada da tarefa analisar texto PIIEntityRecognition.

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

AnalyzeTextSentimentAnalysisInput

Contém a entrada da tarefa Analisar texto SentimentAnalysis.

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

AnalyzeTextTaskKind

O tipo de tarefas de texto de análise com suporte.

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

AnalyzeTextTaskResultsKind

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

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

AreaMetadata

Representa o modelo de metadados de entidade de área.

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

AreaUnit

A unidade de área de medida.

Nome	Tipo	Description
Acre	string	Unidade de área em acres
SquareCentimeter	string	Unidade de área em centímetros quadrados
SquareDecameter	string	Unidade de área em decameters quadrados
SquareDecimeter	string	Unidade de área em decímetros quadrados
SquareFoot	string	Unidade de área em metros quadrados
SquareHectometer	string	Unidade de área em hectômetros quadrados
SquareInch	string	Unidade de área em polegadas quadradas
SquareKilometer	string	Unidade de área em quilômetros quadrados
SquareMeter	string	Unidade de área em metros quadrados
SquareMile	string	Unidade de área em milhas quadradas
SquareMillimeter	string	Unidade de área em milímetros quadrados
SquareYard	string	Unidade de área em metros quadrados
Unspecified	string	Unidade de área não especificada

CurrencyMetadata

Representa o modelo de metadados da entidade Currency ).

Nome	Tipo	Description
iso4217	string	O código alfabético baseado em outro padrão ISO, ISO 3166, que lista os códigos para nomes de país. As duas primeiras letras do código de três letras ISO 4217 são iguais ao 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 de entidade.
unit	string	Unidade de moeda.
value	number	O valor numérico que o texto extraído denota.

DateMetadata

Metadados para instâncias de entidade de data.

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

DateTimeMetadata

Metadados para instâncias de entidade datetime.

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

DateValue

Representa o valor da data.

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

DetectedLanguage

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

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

DocumentError

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

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

DocumentSentimentValue

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

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

DocumentStatistics

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

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

DocumentWarning

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

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

EntitiesDocumentResultWithMetadata

Os documentos de entidade resultam com metadados.

Nome	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 o conteúdo do documento.
warnings	DocumentWarning[]	Avisos encontrados durante o processamento do documento.

EntitiesResult

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

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

EntitiesTaskParameters

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

Nome	Tipo	Valor padrão	Description
exclusionList	EntityCategory[]		(Opcional) parâmetro de solicitação que filtra todas as entidades incluídas na excludeList. Quando um usuário especifica um excludeList, ele não pode obter uma previsão retornada com uma entidade nessa lista. Aplicaremos inclusionList antes de exclusionList
inclusionList	EntityCategory[]		(Opcional) parâmetro de solicitação 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 que o usuário forneça configurações para executar a inferência.
loggingOptOut	boolean	False	recusar o registro em 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 do ner.
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. Padrão para TextElements (Graphemes).

EntitiesTaskResult

Contém a tarefa de entidade

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

Entity

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

Nome	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Pontuação de confiança entre 0 e 1 da entidade extraída.
length	integer	Comprimento do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado.
offset	integer	Posição inicial do 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

Contém todas as categorias de entidade detectadas pelo reconhecimento de entidade.

Nome	Tipo	Description
Address	string	Menções específicas em nível de rua de locais: números de casas/edifícios, ruas, avenidas, rodovias, cruzamentos referenciados pelo nome.
Age	string	Valores relacionados à idade.
Airport	string	Aeroportos.
Area	string	Área de um objeto.
City	string	Valores relacionados à cidade.
ComputingProduct	string	Produtos de computação.
Continent	string	Valores relacionados ao continente.
CountryRegion	string	Valores relacionados a país ou região.
CulturalEvent	string	Valores relacionados a eventos culturais.
Currency	string	Valores relacionados à moeda.
Date	string	Datas do calendário.
DateRange	string	Intervalo de datas.
DateTime	string	Datas de calendário com hora.
DateTimeRange	string	Intervalo de data e hora.
Dimension	string	Dimensão das medidas
Duration	string	Duração do tempo.
Email	string	Endereços de email.
Event	string	Eventos sociais, esportivos, empresariais, políticos, educacionais, naturais, históricos, criminosos, violentos, legais, militares com um período cronometrado.
GPE	string	Cidades, países/regiões, estados.
Geological	string	Características geográficas e naturais, como rios, oceanos e desertos.
Height	string	Altura de um objeto.
IP	string	endereços IP de rede.
Information	string	Unidade de medida para informações digitais.
Length	string	Comprimento de um objeto.
Location	string	Ponto ou lugar específico no espaço físico.
NaturalEvent	string	Valores naturais relacionados a eventos.
Number	string	Números sem uma unidade
NumberRange	string	Intervalo de números
Numeric	string	Valores numéricos, incluindo dígitos e palavras numéricas.
Ordinal	string	Números ordinais.
Organization	string	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 ORGANIZATION.
OrganizationMedical	string	Empresas médicas e grupos.
OrganizationSports	string	Organizações relacionadas ao esporte.
OrganizationStockExchange	string	Grupos de bolsas de valores.
Percentage	string	Valores relacionados à porcentagem.
Person	string	Nomes de primeiro, último e meio, nomes de personagens fictícios e aliases. Títulos, como "Sr.". ou 'Presidente', não são considerados parte da entidade nomeada.
PersonType	string	Funções humanas classificadas por uma associação de grupo.
PhoneNumber	string	Números de telefone (somente números de telefone dos EUA e da UE).
Product	string	Um ou grupo de objetos comerciais e consumíveis, eletrônicos, veículos, grupos alimentares.
SetTemporal	string	Conjunto de valores relacionados ao tempo.
Skill	string	Uma funcionalidade, habilidade ou experiência.
Speed	string	Velocidade de um objeto.
SportsEvent	string	Valores relacionados a eventos esportivos.
State	string	Valores relacionados ao estado.
Structural	string	Estruturas feitas pelo homem.
Temperature	string	Valores relacionados à temperatura.
Temporal	string	Itens relacionados ao tempo.
Time	string	Horas do dia.
TimeRange	string	Intervalo de tempo.
URL	string	URLs para sites.
Volume	string	Volume de um objeto.
Weight	string	Peso de um objeto.

EntityInferenceOptions

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

Nome	Tipo	Valor padrão	Description
excludeNormalizedValues	boolean	False	Opção para incluir/excluir os valores de entidade detectados a serem normalizados e incluídos nos metadados. Os tipos de entidade numérica e temporal dão suporte à normalização de valor.

EntityLinkingResult

Resultado da vinculação de entidade.

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

EntityLinkingTaskParameters

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

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

EntityLinkingTaskResult

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

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

EntityTag

Objeto de marca de entidade que contém o nome das marcas abd qualquer pontuação de confiança associada. Marcas de entidade são usadas para expressar algumas semelhanças/afinidade entre entidades.

Nome	Tipo	Description
confidenceScore	number	Pontuação de detecção entre 0 e 1 da entidade extraída.
name	string	Nome da marca. Os nomes de marca de entidade serão exclusivos globalmente.

EntityWithMetadata

Objeto de entidade com marcas e metadados.

Nome	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Pontuação de confiança entre 0 e 1 da entidade extraída.
length	integer	Comprimento do texto da entidade. O uso de 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	Posição inicial do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.
subcategory	string	(Opcional) Subtipo de entidade.
tags	EntityTag[]	Lista de marcas de entidade. As marcas devem expressar algumas semelhanças/afinidade entre entidades.
text	string	Texto da entidade conforme aparece na solicitação.
type	string	Um tipo de entidade é a granularidade mais baixa (ou melhor) na qual a entidade foi detectada. O tipo é mapeado para os atributos de metadados específicos associados à entidade detectada.

Error

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

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

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string	Erro atingido no limite de índice do Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	string	Erro não encontrado no índice do Azure Cognitive Search
AzureCognitiveSearchNotFound	string	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	string	Erro de limitação do Azure Cognitive Search
Conflict	string	Erro de conflito
Forbidden	string	Erro de acesso proibido
InternalServerError	string	Erro interno do servidor
InvalidArgument	string	Erro de argumento inválido
InvalidRequest	string	Erro de solicitação inválido
NotFound	string	Erro não encontrado
OperationNotFound	string	Erro de operação não encontrada
ProjectNotFound	string	Erro não encontrado no projeto
QuotaExceeded	string	Erro de cota excedido
ServiceUnavailable	string	Erro de serviço indisponível
Timeout	string	Erro de tempo limite
TooManyRequests	string	Erro de muitas solicitações
Unauthorized	string	Erro de acesso não autorizado
Warning	string	Erro de aviso

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InformationMetadata

Representa o modelo de metadados de entidade de informações (dados).

Nome	Tipo	Description
metadataKind	string: InformationMetadata	O tipo de objeto de metadados de entidade.
unit	InformationUnit	Unidade de medida para obter informações.
value	number	O valor numérico que o texto extraído denota.

InformationUnit

A unidade de medida de informações (dados).

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

InnerErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchNotFound	string	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	string	Erro de limitação do Azure Cognitive Search
EmptyRequest	string	Erro de solicitação vazia
ExtractionFailure	string	Erro de falha de extração
InvalidCountryHint	string	Erro de dica de país inválido
InvalidDocument	string	Erro de documento inválido
InvalidDocumentBatch	string	Erro em lote de documento inválido
InvalidParameterValue	string	Erro de valor de parâmetro inválido
InvalidRequest	string	Erro de solicitação inválido
InvalidRequestBodyFormat	string	Erro de formato do corpo da solicitação inválido
KnowledgeBaseNotFound	string	Erro não encontrado na base de dados de conhecimento
MissingInputDocuments	string	Erro de documentos de entrada ausentes
ModelVersionIncorrect	string	Erro incorreto da versão do modelo
UnsupportedLanguageCode	string	Erro de código de idioma sem suporte

InnerErrorModel

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

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

KeyPhraseResult

Contém o KeyPhraseResult.

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

KeyPhrasesDocumentResult

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

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

KeyPhraseTaskParameters

Parâmetros com suporte para uma tarefa de extração de frases-chave.

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

KeyPhraseTaskResult

Contém o resultado da tarefa Analisar texto KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

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

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

LanguageDetectionDocumentResult

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

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

LanguageDetectionResult

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

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

LanguageDetectionTaskParameters

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

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

LanguageDetectionTaskResult

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

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

LanguageInput

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

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

LengthMetadata

Representa o modelo de metadados de entidade length.

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

LengthUnit

A unidade de comprimento da medida.

Nome	Tipo	Description
Centimeter	string	Unidade de comprimento em centímetros.
Decameter	string	Unidade de comprimento em decameters.
Decimeter	string	Unidade de comprimento em decimeters.
Foot	string	Unidade de comprimento em pés.
Hectometer	string	Unidade de comprimento em hectômetros.
Inch	string	Unidade de comprimento em polegadas.
Kilometer	string	Unidade de comprimento em quilômetros.
LightYear	string	Unidade de comprimento em anos-luz.
Meter	string	Unidade de comprimento em metros.
Micrometer	string	Unidade de comprimento em micrometers.
Mile	string	Unidade de comprimento em milhas.
Millimeter	string	Unidade de comprimento em milímetros.
Nanometer	string	Unidade de comprimento em nanômetros.
Picometer	string	Unidade de comprimento em picometers.
Point	string	Unidade de comprimento em pontos.
Unspecified	string	Unidade de comprimento não especificada.
Yard	string	Unidade de comprimento em metros.

LinkedEntitiesDocumentResult

Resultado do documento de vinculação de entidade.

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

LinkedEntity

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

Nome	Tipo	Description
bingId	string	Identificador exclusivo da API de Pesquisa de Entidade do Bing da entidade reconhecida.
dataSource	string	Fonte de dados usada para extrair vinculação de entidade, como Wiki/Bing etc.
id	string	Identificador exclusivo da entidade reconhecida da fonte de dados.
language	string	Idioma usado na fonte de dados.
matches	Match[]	Lista de instâncias em que essa 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

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

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

MatchLongestEntityPolicyType

Representa a política de sobreposição mais longa de correspondência. Não há entidades sobrepostas tanto quanto possível. 1. Se houver entidades sobrepostas, a mais longa será retornada. 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 de 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 em Hello Text Analytics) siga as etapas acima a partir de 1.

Nome	Tipo	Valor padrão	Description
policyKind	string: matchLongest	matchLongest	O tipo de objeto OverlapPolicy da entidade.

MetadataKind

O tipo de objeto de metadados de entidade.

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

MultiLanguageAnalysisInput

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

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

MultiLanguageInput

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

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

NumberKind

O tipo da entidade de número extraída.

Nome	Tipo	Description
Decimal	string	Número decimal
Fraction	string	Número de fração
Integer	string	Número inteiro
Percent	string	Número percentual
Power	string	Número de energia
Unspecified	string	Tipo de número não especificado

NumberMetadata

Metadados para instâncias de entidade numérica.

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

NumericRangeMetadata

representa os Metadados de intervalos numéricos.

Nome	Tipo	Description
maximum	number	O valor final do intervalo.
metadataKind	string: NumericRangeMetadata	O tipo de objeto de metadados de entidade.
minimum	number	O valor inicial do intervalo.
rangeInclusivity	RangeInclusivity	A inclusão desse intervalo.
rangeKind	RangeKind	Tipo de intervalos numéricos com suporte - como Número, Velocidade etc.

OrdinalMetadata

Metadados para instâncias de entidade numérica.

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

PiiCategory

(Opcional) descreve as categorias de PII a serem retornadas

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

PiiDomain

Tarefa Domínio para PII

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

PiiEntitiesDocumentResult

Contém os resultados de PII.

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

PiiResult

Contém o PiiResult.

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

PiiTaskParameters

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

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

PiiTaskResult

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

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

RangeInclusivity

A inclusão de intervalo dessa propriedade.

Nome	Tipo	Description
LeftInclusive	string	Lado esquerdo inclusivo
LeftRightInclusive	string	Ambos os lados, inclusive
NoneInclusive	string	Sem inclusividade
RightInclusive	string	Lado direito inclusivo

RangeKind

O tipo da entidade de intervalo de números.

Nome	Tipo	Description
Age	string	Faixa etária
Area	string	Intervalo de área
Currency	string	Intervalo de moeda
Information	string	Intervalo de informações
Length	string	Intervalo de comprimento
Number	string	Intervalo de números
Speed	string	Intervalo de velocidade
Temperature	string	Intervalo de temperatura
Volume	string	Intervalo de volume
Weight	string	Intervalo de peso

RelativeTo

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

Nome	Tipo	Description
Current	string	Estado ou posição atual
End	string	Estado ou posição final
Start	string	Iniciar estado ou posição

RequestStatistics

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

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

ScriptCode

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

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

ScriptKind

Identifica o script do documento de entrada. Mapeia para o nome formal padrão ISO 15924.

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

SentenceAssessment

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

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

SentenceSentiment

O sentimento da frase de um documento.

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

SentenceSentimentValue

O sentimento previsto para a frase.

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

SentenceTarget

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

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

SentimentAnalysisTaskParameters

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

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

SentimentConfidenceScores

Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa.

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

SentimentDocumentResult

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

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

SentimentResponse

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

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

SentimentTaskResult

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

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

SpeedMetadata

Representa o modelo de metadados da entidade Speed.

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

SpeedUnit

A unidade de velocidade de medida

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

StringIndexType

Tipo de índice de cadeia de caracteres

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

TargetConfidenceScoreLabel

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

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

TargetRelation

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

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

TargetRelationType

O tipo relacionado ao destino.

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

TemperatureMetadata

Representa o modelo de metadados de entidade de informações.

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

TemperatureUnit

A unidade de temperatura da medida.

Nome	Tipo	Description
Celsius	string	Unidade de temperatura em Celsius
Fahrenheit	string	Unidade de temperatura em Fahrenheit
Kelvin	string	Unidade de temperatura em Kelvin
Rankine	string	Unidade de temperatura em Rankine
Unspecified	string	Unidade de temperatura não especificada

TemporalModifier

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

Nome	Tipo	Description
After	string	Após um horário específico
AfterApprox	string	Após um tempo aproximado
AfterMid	string	Após o meio de um período de tempo
AfterStart	string	Após o início de um período de tempo
Approx	string	Aproximadamente em um momento específico
Before	string	Antes de uma hora específica
BeforeApprox	string	Antes de uma hora aproximada
BeforeEnd	string	Antes do fim de um período de tempo
BeforeStart	string	Antes do início de um período de tempo
End	string	No final de um período de tempo
Less	string	Menor que uma hora específica
Mid	string	No meio de um período de tempo
More	string	Mais do que uma hora específica
ReferenceUndefined	string	Referência a um tempo indefinido
Since	string	Desde uma hora específica
SinceEnd	string	Desde o fim de um período de tempo
Start	string	No início de um período de tempo
Until	string	Até uma hora específica

TemporalSetMetadata

Metadados para instâncias de entidade do conjunto temporal.

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

TemporalSpanMetadata

representa os Metadados de uma data e/ou intervalo de tempo.

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

TemporalSpanValues

Objeto de intervalo temporal.

Nome	Tipo	Description
begin	string	Valor inicial para o intervalo.
duration	string	Um valor de duração opcional formatado com base no ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Valor final para o intervalo.
modifier	TemporalModifier	Modificador para datetime para indicar ponto de referência como antes, depois etc.
timex	string	Um trigêmeo opcional que contém o início, o fim e a duração declarados como cadeias de caracteres formatadas iso 8601.

TimeMetadata

Metadados para instâncias de entidade de tempo.

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

TokenSentimentValue

O sentimento previsto para a frase.

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

VolumeMetadata

Representa o modelo de metadados de entidade de volume.

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

VolumeUnit

A unidade de volume de medida

Nome	Tipo	Description
Barrel	string	Unidade de volume em barris.
Bushel	string	Unidade de volume em bushels.
Centiliter	string	Unidade de volume em centilitros.
Cord	string	Unidade de volume em cabos.
CubicCentimeter	string	Unidade de volume em centímetros cúbicos.
CubicFoot	string	Unidade de volume em pés cúbicos.
CubicInch	string	Unidade de volume em polegadas cúbicas.
CubicMeter	string	Unidade de volume em metros cúbicos.
CubicMile	string	Unidade de volume em milhas cúbicas.
CubicMillimeter	string	Unidade de volume em milímetros cúbicos.
CubicYard	string	Unidade de volume em metros cúbicos.
Cup	string	Unidade de volume em copos.
Decaliter	string	Unidade de volume em decalques.
FluidDram	string	Unidade de volume em drams fluidos.
FluidOunce	string	Unidade de volume em onças fluidas.
Gill	string	Unidade de volume em brânquias.
Hectoliter	string	Unidade de volume em hectolitros.
Hogshead	string	Unidade de volume em hogsheads.
Liter	string	Unidade de volume em litros.
Milliliter	string	Unidade de volume em mililitros.
Minim	string	Unidade de volume em minims.
Peck	string	Unidade de volume em bicadas.
Pinch	string	Unidade de volume em pinçadas.
Pint	string	Unidade de volume em litros.
Quart	string	Unidade de volume em quarts.
Tablespoon	string	Unidade de volume em colheres de sopa.
Teaspoon	string	Unidade de volume em colheres de chá.
Unspecified	string	Unidade de volume não especificada.

WarningCodeValue

Define a lista dos códigos de aviso.

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

WeightMetadata

Representa o modelo de metadados de entidade Weight ).

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

WeightUnit

A unidade de peso da medida.

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

Compartilhar via

Text Analysis Runtime - Analyze Text

Parâmetros de URI

Corpo da solicitação

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

SuccessfulEntityLinkingRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulEntityRecognitionExclusionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulEntityRecognitionInclusionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulEntityRecognitionInferenceOptionsRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulEntityRecognitionOverlapPolicy

Solicitação de exemplo

Resposta de exemplo

SuccessfulEntityRecognitionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulKeyPhraseExtractionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulLanguageDetectionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulPiiEntityRecognitionRequest

Solicitação de exemplo

Resposta de exemplo

SuccessfulSentimentAnalysisRequest

Solicitação de exemplo

Resposta de exemplo

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