Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add TAv3 skills to latest GA swagger spec #15536

Merged
merged 1 commit into from
Aug 6, 2021
Merged

Add TAv3 skills to latest GA swagger spec #15536

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7709,6 +7709,162 @@
},
"description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1."
},
"SentimentSkillV3": {
"x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill",
"allOf": [
{
"$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
"defaultLanguageCode": {
"type": "string",
"x-nullable": true,
"description": "A value indicating which language code to use. Default is en."
},
"includeOpinionMining": {
"type": "boolean",
"default": false,
"description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false."
},
"modelVersion": {
"type": "string",
"x-nullable": true,
"description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
}
},
"externalDocs": {
"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3"
},
"description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level."
},
"EntityLinkingSkill": {
"x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill",
"allOf": [
{
"$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
"defaultLanguageCode": {
"type": "string",
"x-nullable": true,
"description": "A value indicating which language code to use. Default is en."
},
"minimumPrecision": {
"type": "number",
"format": "double",
"minimum": 0.0,
"maximum": 1.0,
"x-nullable": true,
"description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included."
},
"modelVersion": {
"type": "string",
"x-nullable": true,
"description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
}
},
"externalDocs": {
"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3"
},
"description": "Using the Text Analytics API, extracts linked entities from text."
},
"EntityRecognitionSkillV3": {
"x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill",
"allOf": [
{
"$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"x-nullable": false
},
"description": "A list of entity categories that should be extracted."
},
"defaultLanguageCode": {
"type": "string",
"x-nullable": true,
"description": "A value indicating which language code to use. Default is en."
},
"minimumPrecision": {
"type": "number",
"format": "double",
"minimum": 0.0,
"maximum": 1.0,
"x-nullable": true,
"description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included."
},
"modelVersion": {
"type": "string",
"x-nullable": true,
"description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
}
},
"externalDocs": {
"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3"
},
"description": "Using the Text Analytics API, extracts entities of different types from text."
},
"PIIDetectionSkill": {
"x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill",
"allOf": [
{
"$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
"defaultLanguageCode": {
"type": "string",
"x-nullable": true,
"description": "A value indicating which language code to use. Default is en."
},
"minimumPrecision": {
"type": "number",
"format": "double",
"x-nullable": true,
"minimum": 0.0,
"maximum": 1.0,
"description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included."
},
"maskingMode": {
"$ref": "#/definitions/PIIDetectionSkillMaskingMode",
"description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'."
},
"maskingCharacter": {
"type": "string",
"x-nullable": true,
"maxLength": 1,
"description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'."
},
"modelVersion": {
"type": "string",
"x-nullable": true,
"description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
},
"piiCategories": {
"type": "array",
"items": {
"type": "string",
"x-nullable": false
},
"description": "A list of PII entity categories that should be extracted and masked."
},
"domain": {
"type": "string",
"x-nullable": true,
"description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'."
}
},
"externalDocs": {
"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-pii-detection"
},
"description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it."
},
"SplitSkill": {
"x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill",
"allOf": [
Expand Down Expand Up @@ -8074,6 +8230,30 @@
},
"description": "A string indicating what entity categories to return."
},
"PIIDetectionSkillMaskingMode": {
"type": "string",
"enum": [
"none",
"replace"
],
"x-ms-enum": {
"name": "PIIDetectionSkillMaskingMode",
"modelAsString": true,
"values": [
{
"value": "none",
"name": "None",
"description": "No masking occurs and the maskedText output will not be returned."
},
{
"value": "replace",
"name": "Replace",
"description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText."
}
]
},
"description": "A string indicating what maskingMode to use to mask the personal information detected in the input text."
},
"SentimentSkillLanguage": {
"type": "string",
"enum": [
Expand Down