Text Analysis Runtime - Analyze Text

Serviço:

Azure AI Services

Versão da API:

2024-11-01

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

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos suportados (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 solicitação e nível de documento.

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

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

AnalyzeTextEntityLinkingInput

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

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

AnalyzeTextEntityRecognitionInput

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

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

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa analisar texto KeyPhraseExtraction.

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

AnalyzeTextLanguageDetectionInput

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

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

AnalyzeTextPiiEntitiesRecognitionInput

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

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

AnalyzeTextSentimentAnalysisInput

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

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

Respostas

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

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulEntityRecognitionExclusionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulEntityRecognitionInclusionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulEntityRecognitionInferenceOptionsRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulEntityRecognitionOverlapPolicy

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulEntityRecognitionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulKeyPhraseExtractionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulLanguageDetectionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulPiiEntityRecognitionRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

SuccessfulSentimentAnalysisRequest

Pedido de amostra

HTTP

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

Código de estado:

200

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

Definições

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

AgeMetadata

Representa o modelo de metadados da entidade Age.

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

AgeUnit

A unidade de medida etária

Name	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 um ano

AllowOverlapEntityPolicyType

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

Name	Tipo	Default value	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.

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

AnalyzeTextEntityRecognitionInput

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

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

AnalyzeTextKeyPhraseExtractionInput

Contém a entrada da tarefa analisar texto KeyPhraseExtraction.

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

AnalyzeTextLanguageDetectionInput

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

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

AnalyzeTextPiiEntitiesRecognitionInput

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

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

AnalyzeTextSentimentAnalysisInput

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

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

AnalyzeTextTaskKind

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

Name	Tipo	Description
EntityLinking	string	Tarefa de vinculação de entidade
EntityRecognition	string	Tarefa de reconhecimento de entidade
KeyPhraseExtraction	string	Tarefa de extração de frases-chave
LanguageDetection	string	Tarefa de deteçã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 de texto de análise.

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

AreaMetadata

Representa o modelo de metadados da entidade Area.

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

AreaUnit

A unidade de medida da área.

Name	Tipo	Description
Acre	string	Unidade de área em acres
SquareCentimeter	string	Unidade de área em centímetros quadrados
SquareDecameter	string	Unidade de área em decámetros quadrados
SquareDecimeter	string	Unidade de área em decímetros quadrados
SquareFoot	string	Unidade de área em pés 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 ).

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

DateMetadata

Um Metadados para instâncias de entidade de data.

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

DateTimeMetadata

Um Metadados para instâncias de entidade datetime.

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

DateValue

Representa o valor da data.

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

DetectedLanguage

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

Name	Tipo	Description
confidenceScore	number	Um índice de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira.
iso6391Name	string	Uma representação de duas letras da língua detetada de acordo com a norma ISO 639-1 (por exemplo, en, fr).
name	string	Nome longo de um idioma detetado (por exemplo, inglês, francês).
scriptIso15924Code	ScriptCode	Identifica o código de script do documento de entrada de acordo com a norma ISO 15924.
scriptName	ScriptKind	Identifica o nome do script do documento de entrada de acordo com a norma ISO 15924.

DocumentError

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

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

DocumentSentimentValue

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

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

DocumentStatistics

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

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

DocumentWarning

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

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

EntitiesDocumentResultWithMetadata

Os documentos da entidade resultam com metadados.

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

EntitiesResult

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

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

EntitiesTaskParameters

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

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

EntitiesTaskResult

Contém a tarefa de entidade

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

Entity

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

Name	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Escore 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 para o texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.
subcategory	string	(Opcional) Subtipo de entidade.
text	string	Texto da entidade conforme aparece na solicitação.

EntityCategory

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

Name	Tipo	Description
Address	string	Menções específicas ao nível da rua dos locais: números de casas/edifícios, ruas, avenidas, autoestradas, cruzamentos referenciados pelo nome.
Age	string	Valores relacionados com a idade.
Airport	string	Aeroportos.
Area	string	Área de um objeto.
City	string	Valores relacionados com a cidade.
ComputingProduct	string	Produtos informáticos.
Continent	string	Valores continentais.
CountryRegion	string	Valores relacionados com o país ou a região.
CulturalEvent	string	Valores relacionados com eventos culturais.
Currency	string	Valores relacionados com a moeda.
Date	string	Datas do calendário.
DateRange	string	Intervalo de datas.
DateTime	string	Calendário de datas com hora.
DateTimeRange	string	Intervalo de data e hora.
Dimension	string	Dimensão das medições
Duration	string	Duração do tempo.
Email	string	Endereços de e-mail.
Event	string	Eventos sociais, esportivos, empresariais, políticos, educacionais, naturais, históricos, criminais, 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ção digital.
Length	string	Comprimento de um objeto.
Location	string	Ponto ou lugar particular no espaço físico.
NaturalEvent	string	Valores relacionados com eventos naturais.
Number	string	Números sem unidade
NumberRange	string	Gama 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 ORGANIZAÇÃO.
OrganizationMedical	string	Empresas e grupos médicos.
OrganizationSports	string	Organizações relacionadas com o desporto.
OrganizationStockExchange	string	Grupos bolsistas.
Percentage	string	Valores relacionados com a percentagem.
Person	string	Primeiro, último e nomes do meio, nomes de personagens fictícios e pseudônimos. Títulos, como 'Mr.' ou «Presidente», não são considerados parte da entidade nomeada.
PersonType	string	Funções humanas classificadas por membros de um grupo.
PhoneNumber	string	Números de telefone (apenas números de telefone dos EUA e da UE).
Product	string	Único ou grupo de objetos comerciais, consumíveis, eletrônicos, veículos, grupos de alimentos.
SetTemporal	string	Conjunto de valores relacionados ao tempo.
Skill	string	Uma capacidade, habilidade ou experiência.
Speed	string	Velocidade de um objeto.
SportsEvent	string	Valores relacionados com eventos desportivos.
State	string	Valores relacionados com o Estado.
Structural	string	Estruturas artificiais.
Temperature	string	Valores relacionados com a temperatura.
Temporal	string	Itens relativos ao tempo.
Time	string	Horas do dia.
TimeRange	string	Intervalo de tempos.
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 permitiu o reconhecimento da entidade nomeada.

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

EntityLinkingResult

Resultado da vinculação de entidade.

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

EntityLinkingTaskParameters

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

Name	Tipo	Default value	Description
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo
stringIndexType	StringIndexType	TextElements_v8	Parâmetro opcional para fornecer o tipo de índice de cadeia de caracteres usado para interpretar deslocamentos de cadeia de caracteres. O padrão é TextElements (Graphemes).

EntityLinkingTaskResult

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

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

EntityTag

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

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

EntityWithMetadata

Objeto de entidade com tags e metadados.

Name	Tipo	Description
category	string	Tipo de entidade.
confidenceScore	number	Escore 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 para o texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.
subcategory	string	(Opcional) Subtipo de entidade.
tags	EntityTag[]	Lista de tags de entidade. As tags são para expressar algumas semelhanças/afinidade entre entidades.
text	string	Texto da entidade conforme aparece na solicitação.
type	string	Um tipo de entidade é a menor (ou mais fina) granularidade na qual a entidade foi detetada. O tipo é mapeado para os atributos de metadados específicos associados à entidade detetada.

Error

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

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

ErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string	Erro atingido pelo limite do índice da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexNotFound	string	Erro de índice da Pesquisa Cognitiva do Azure não encontrado
AzureCognitiveSearchNotFound	string	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	string	Erro de limitação da Pesquisa Cognitiva do Azure
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álida
NotFound	string	Erro não encontrado
OperationNotFound	string	Erro de operação não encontrado
ProjectNotFound	string	Erro de projeto não encontrado
QuotaExceeded	string	Erro de quota excedida
ServiceUnavailable	string	Erro de serviço indisponível
Timeout	string	Erro de tempo limite
TooManyRequests	string	Erro de muitas solicitações
Unauthorized	string	Erro de acesso não autorizado
Warning	string	Erro de aviso

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InformationMetadata

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

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

InformationUnit

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

Name	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 kilobits
Kilobyte	string	Unidade de tamanho de dados em kilobytes
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.

Name	Tipo	Description
AzureCognitiveSearchNotFound	string	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	string	Erro de limitação da Pesquisa Cognitiva do Azure
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 de lote de documento inválido
InvalidParameterValue	string	Erro de valor de parâmetro inválido
InvalidRequest	string	Erro de solicitação inválida
InvalidRequestBodyFormat	string	Erro de formato de corpo de 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 de versão incorreta do modelo
UnsupportedLanguageCode	string	Erro de código de idioma não suportado

InnerErrorModel

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

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

KeyPhraseResult

Contém o KeyPhraseResult.

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

KeyPhrasesDocumentResult

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

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

KeyPhraseTaskParameters

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

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

KeyPhraseTaskResult

Contém o resultado da tarefa analisar texto KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

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

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

LanguageDetectionDocumentResult

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

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

LanguageDetectionResult

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

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

LanguageDetectionTaskParameters

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

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

LanguageDetectionTaskResult

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

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

LanguageInput

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

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

LengthMetadata

Representa o modelo de metadados da entidade Length.

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

LengthUnit

A unidade de medida de comprimento.

Name	Tipo	Description
Centimeter	string	Unidade de comprimento em centímetros.
Decameter	string	Unidade de comprimento em decámetros.
Decimeter	string	Unidade de comprimento em decímetros.
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 micrômetros.
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 picometros.
Point	string	Unidade de comprimento em pontos.
Unspecified	string	Unidade de comprimento não especificada.
Yard	string	Unidade de comprimento em quintais.

LinkedEntitiesDocumentResult

Resultado do documento de vinculação de entidade.

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

LinkedEntity

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

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

Match

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

Name	Tipo	Description
confidenceScore	number	Se um item bem conhecido for reconhecido, um número decimal denotando o nível de confiança entre 0 e 1 será retornado.
length	integer	Comprimento do texto correspondente à entidade.
offset	integer	Posição inicial do 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 Match. Não há sobreposição de entidades, na medida do possível. 1. Se houver entidades sobrepostas, a mais longa será devolvida. 2. Se o conjunto de caracteres previsto para 2 ou mais entidades for exatamente o mesmo, selecione a entidade que tem a pontuação de confiança mais alta.3. Se as pontuações da entidade forem idênticas, retorne todas as entidades que ainda estão presentes após a aplicação das regras anteriores. 3. Se houver sobreposição parcial (como no Hello Text Analytics), siga as etapas acima a partir de 1.

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

MetadataKind

O tipo de objeto de metadados da entidade.

Name	Tipo	Description
AgeMetadata	string	Metadados para valores relacionados com a idade.
AreaMetadata	string	Metadados para valores relacionados à área.
CurrencyMetadata	string	Metadados para valores relacionados com moedas.
DateMetadata	string	Metadados para valores relacionados à data.
DateTimeMetadata	string	Metadados para valores relacionados com data e hora.
InformationMetadata	string	Metadados para valores relacionados com 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 com a velocidade.
TemperatureMetadata	string	Metadados para valores relacionados com a temperatura.
TemporalSetMetadata	string	Metadados para o conjunto de valores relacionados ao tempo.
TemporalSpanMetadata	string	Metadados para valores de extensão temporal.
TimeMetadata	string	Metadados para valores relacionados ao tempo.
VolumeMetadata	string	Metadados para valores relacionados ao volume.
WeightMetadata	string	Metadados para valores relacionados com o peso.

MultiLanguageAnalysisInput

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

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

MultiLanguageInput

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

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

NumberKind

O tipo da entidade numérica extraída.

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

NumberMetadata

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

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

NumericRangeMetadata

representa os metadados de intervalos numéricos.

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

OrdinalMetadata

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

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

PiiCategory

(Opcional) descreve as categorias de PII a serem retornadas

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

PiiDomain

Domínio para tarefa PII

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

PiiEntitiesDocumentResult

Contém os resultados da PII.

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

PiiResult

Contém o PiiResult.

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

PiiTaskParameters

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

Name	Tipo	Default value	Description
domain	PiiDomain	none	Domínio para tarefa PII
loggingOptOut	boolean	False	desativação de log
modelVersion	string	latest	Versão do modelo
piiCategories	PiiCategory[]		Enumeração de categorias de PII a serem retornadas na resposta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType a ser usado para análise.

PiiTaskResult

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

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

RangeInclusivity

A abrangência desta propriedade de propriedade.

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

RangeKind

O tipo de entidade do intervalo de números.

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

RelativeTo

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

Name	Tipo	Description
Current	string	Estado ou posição atual
End	string	Estado ou posição final
Start	string	Estado ou posição inicial

RequestStatistics

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

Name	Tipo	Description
documentsCount	integer	Número de documentos apresentados no pedido.
erroneousDocumentsCount	integer	Número de documentos inválidos. Isso inclui documentos vazios, com limite 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 vazios, com limite de tamanho excessivo ou idiomas não suportados.

ScriptCode

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

Name	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 etíope.
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 HanTradicional.
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 alfabeto 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 de Mianmar.
Olck	string	Código de script para o script 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 cingalês.
Taml	string	Código de script para o script tâmil.
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 da norma ISO 15924.

Name	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 Bangla.
Cyrillic	string	Nome do script para o script cirílico.
Devanagari	string	Nome do script Devanagari.
Ethiopic	string	Nome do script para o script etíope.
Georgian	string	Nome do script para o script georgiano.
Greek	string	Nome do script para o script grego.
Gujarati	string	Nome do script 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 HanTradicional.
Hangul	string	Nome do script 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 Kannada.
Khmer	string	Nome do script Khmer.
Lao	string	Nome do script para o script Laos.
Latin	string	Nome do script para o alfabeto latino.
Malayalam	string	Nome do script para o script Malayalam.
Meitei	string	Nome do script Meitei.
Mongolian	string	Nome do script para o script mongol.
Myanmar	string	Nome do script para o script Myanmar.
Odia	string	Nome do script Odia.
Santali	string	Nome do script Santali.
Sharada	string	Nome do script Sharada.
Sinhala	string	Nome do script cingalês.
Tamil	string	Nome do script para o script tâmil.
Telugu	string	Nome do script Telugu.
Thaana	string	Nome do script Thaana.
Thai	string	Nome do script tailandês.
Tibetan	string	Nome do script para o script tibetano.
UnifiedCanadianAboriginalSyllabics	string	Nome do script UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

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

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

SentenceSentiment

Sentimento da frase de um documento.

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

SentenceSentimentValue

O sentimento previsto para a sentença.

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

SentenceTarget

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

Name	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.
length	integer	O comprimento do alvo.
offset	integer	O deslocamento do alvo desde o início da frase.
relations	TargetRelation[]	A matriz de objetos de avaliação ou de destino que está relacionada ao destino.
sentiment	TokenSentimentValue	O sentimento da sentença.
text	string	O texto de destino detetado.

SentimentAnalysisTaskParameters

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

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

SentimentConfidenceScores

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

Name	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 pré-construídos da Análise de Sentimento de cada documento.

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

SentimentResponse

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

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

SentimentTaskResult

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

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

SpeedMetadata

Representa o modelo de metadados da entidade Speed.

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

SpeedUnit

A velocidade Unidade de medida

Name	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

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

TargetConfidenceScoreLabel

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

Name	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 metas.

Name	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.

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

TemperatureMetadata

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

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

TemperatureUnit

A unidade de medida de temperatura.

Name	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.

Name	Tipo	Description
After	string	Após um tempo 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 num momento específico
Before	string	Antes de um momento específico
BeforeApprox	string	Antes de um tempo aproximado
BeforeEnd	string	Antes do final 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	Menos do que um tempo específico
Mid	string	No meio de um período de tempo
More	string	Mais do que um tempo específico
ReferenceUndefined	string	Referência a uma hora indefinida
Since	string	Desde um momento específico
SinceEnd	string	Desde o final de um período de tempo
Start	string	No início de um período de tempo
Until	string	Até um momento específico

TemporalSetMetadata

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

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

TemporalSpanMetadata

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

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

TemporalSpanValues

Objeto de span temporal.

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

TimeMetadata

Um Metadados para instâncias de entidade de tempo.

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

TokenSentimentValue

O sentimento previsto para a sentença.

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

VolumeMetadata

Representa o modelo de metadados da entidade Volume.

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

VolumeUnit

A unidade de medida volumétrica

Name	Tipo	Description
Barrel	string	Unidade de volume em barris.
Bushel	string	Unidade de volume em alqueires.
Centiliter	string	Unidade de volume em centímetros.
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 quintais cúbicos.
Cup	string	Unidade de volume em copos.
Decaliter	string	Unidade de volume em decalitros.
FluidDram	string	Unidade de volume em drenos 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 cabeças de porco.
Liter	string	Unidade de volume em litros.
Milliliter	string	Unidade de volume em mililitros.
Minim	string	Unidade de volume em mínimos.
Peck	string	Unidade de volume em bicadas.
Pinch	string	Unidade de volume em beliscões.
Pint	string	Unidade de volume em pints.
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.

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

WeightMetadata

Representa o modelo de metadados da entidade Weight ).

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

WeightUnit

A unidade de medida de peso.

Name	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ânico)
MetricTon	string	Unidade de peso em toneladas métricas
Milligram	string	Unidade de peso em miligramas
Ounce	string	Unidade de peso em onças
PennyWeight	string	Unidade de peso em pennyweights
Pound	string	Unidade de peso em libras
ShortHundredWeightUS	string	Unidade de peso em cem 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