entities_recognition_generals
Creates, updates, deletes, gets or lists an entities_recognition_generals resource.
Overview
| Name | entities_recognition_generals |
| Type | Resource |
| Id | azure.ai_text_analytics.entities_recognition_generals |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
entities_recognition_general | exec | endpoint, id, text | model-version, showStats, loggingOptOut, stringIndexType | Named Entity Recognition. The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
loggingOptOut | boolean | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai. Default value is None. |
model-version | string | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. Default value is None. |
showStats | boolean | (Optional) if set to true, response will contain request and document level statistics. Default value is None. |
stringIndexType | string | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8", "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None. |
Lifecycle Methods
- entities_recognition_general
Named Entity Recognition. The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.
EXEC azure.ai_text_analytics.entities_recognition_generals.entities_recognition_general
@endpoint='{{ endpoint }}' --required,
@model-version='{{ model-version }}',
@showStats={{ showStats }},
@loggingOptOut={{ loggingOptOut }},
@stringIndexType='{{ stringIndexType }}'
@@json=
'{
"id": "{{ id }}",
"text": "{{ text }}",
"language": "{{ language }}"
}'
;