From 981fb28bfc88ba15b65eb5390b8a92f3a207b0a9 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Thu, 17 Sep 2020 10:58:29 -0700 Subject: [PATCH 01/15] Add CustomEntityLookupSkill to searchservice.json --- .../2019-05-06-preview/searchservice.json | 151 ++++++++++++++++++ 1 file changed, 151 insertions(+) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index c2a69aac29b9..465fb1e3fd4e 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -6925,6 +6925,55 @@ }, "description": "Base type for skills." }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "description": "Input field mapping for a skill." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sentitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sentitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + }, "InputFieldMappingEntry": { "properties": { "name": { @@ -7190,6 +7239,22 @@ "format": "int32", "x-nullable": true, "description": "The desired maximum page length. Default is 10000." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, "externalDocs": { @@ -7197,6 +7262,35 @@ }, "description": "A skill to split a string into chunks of text." }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "entitiesDefinitionUri": { + "type": "string", + "description": "Path to a JSON or CSV file containing all the target text to match against." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "description": "The inline CustomEntity definition." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, "TextTranslationSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", "allOf": [ @@ -7830,6 +7924,63 @@ }, "description": "The language codes supported for input text by SplitSkill." }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, "EntityRecognitionSkillLanguage": { "type": "string", "enum": [ From b3cc2043aca14ecf2fcaf0b37e1d58dd5d2e520b Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Thu, 17 Sep 2020 11:53:19 -0700 Subject: [PATCH 02/15] Fix typos --- .../2019-05-06-preview/searchservice.json | 102 +++++++++++++----- 1 file changed, 76 insertions(+), 26 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index 465fb1e3fd4e..23b053294667 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -6929,25 +6929,72 @@ "properties": { "name": { "type": "string", - "description": "The name of the input." + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." }, - "source": { + "description": { "type": "string", - "description": "The source of the input." + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, - "sourceContext": { + "type": { "type": "string", - "description": "The source context used for selecting recursive inputs." + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, - "inputs": { + "subtype": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { "type": "array", "items": { - "$ref": "#/definitions/InputFieldMappingEntry" + "$ref": "#/definitions/CustomEntityAlias" }, - "description": "The recursive inputs used when creating a complex type." + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." } }, - "description": "Input field mapping for a skill." + "required": [ + "name", + "description", + "type", + "subtype", + "id" + ], + "description": "An object that contains information about the matches that were found, and related metadata." }, "CustomEntityAlias": { "properties": { @@ -6972,7 +7019,10 @@ "description": "Determine the fuzzy edit distance of the alias." } }, - "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." }, "InputFieldMappingEntry": { "properties": { @@ -7239,22 +7289,6 @@ "format": "int32", "x-nullable": true, "description": "The desired maximum page length. Default is 10000." - }, - "globalDefaultCaseSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." - }, - "globalDefaultAccentSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." - }, - "globalDefaultFuzzyEditDistance": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, "externalDocs": { @@ -7284,6 +7318,22 @@ "$ref": "#/definitions/CustomEntity" }, "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, "externalDocs": { From 01a4fb89c96ef1a78989975df5ff90153e66c7f7 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Thu, 17 Sep 2020 13:00:35 -0700 Subject: [PATCH 03/15] remove non-required fields from "required" --- .../preview/2019-05-06-preview/searchservice.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index 23b053294667..fc3858c2ae96 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -6988,11 +6988,7 @@ } }, "required": [ - "name", - "description", - "type", - "subtype", - "id" + "name" ], "description": "An object that contains information about the matches that were found, and related metadata." }, From 9fe6d357e7773a3725c6e9852b6f440b737634d4 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Mon, 28 Sep 2020 11:31:44 -0700 Subject: [PATCH 04/15] Move API change to 2020-06-30 --- .../2019-05-06-preview/searchservice.json | 197 ----------------- .../2020-06-30-Preview/searchservice.json | 198 ++++++++++++++++++ 2 files changed, 198 insertions(+), 197 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index fc3858c2ae96..c2a69aac29b9 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -6925,101 +6925,6 @@ }, "description": "Base type for skills." }, - "CustomEntity": { - "properties": { - "name": { - "type": "string", - "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." - }, - "description": { - "type": "string", - "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." - }, - "type": { - "type": "string", - "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." - }, - "subtype": { - "type": "string", - "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." - }, - "id": { - "type": "string", - "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." - }, - "caseSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." - }, - "accentSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." - }, - "fuzzyEditDistance": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." - }, - "defaultCaseSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." - }, - "defaultAccentSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." - }, - "defaultFuzzyEditDistance": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." - }, - "aliases": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomEntityAlias" - }, - "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." - } - }, - "required": [ - "name" - ], - "description": "An object that contains information about the matches that were found, and related metadata." - }, - "CustomEntityAlias": { - "properties": { - "text": { - "type": "string", - "description": "The text of the alias." - }, - "caseSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Determine if the alias is case sentitive." - }, - "accentSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "Determine if the alias is accent sentitive." - }, - "fuzzyEditDistance": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "Determine the fuzzy edit distance of the alias." - } - }, - "required": [ - "text" - ], - "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." - }, "InputFieldMappingEntry": { "properties": { "name": { @@ -7292,51 +7197,6 @@ }, "description": "A skill to split a string into chunks of text." }, - "CustomEntityLookupSkill": { - "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", - "allOf": [ - { - "$ref": "#/definitions/SearchIndexerSkill" - } - ], - "properties": { - "defaultLanguageCode": { - "$ref": "#/definitions/CustomEntityLookupSkillLanguage", - "description": "A value indicating which language code to use. Default is en." - }, - "entitiesDefinitionUri": { - "type": "string", - "description": "Path to a JSON or CSV file containing all the target text to match against." - }, - "inlineEntitiesDefinition": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomEntity" - }, - "description": "The inline CustomEntity definition." - }, - "globalDefaultCaseSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." - }, - "globalDefaultAccentSensitive": { - "type": "boolean", - "x-nullable": true, - "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." - }, - "globalDefaultFuzzyEditDistance": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." - } - }, - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" - }, - "description": "A skill looks for text from a custom, user-defined list of words and phrases." - }, "TextTranslationSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", "allOf": [ @@ -7970,63 +7830,6 @@ }, "description": "The language codes supported for input text by SplitSkill." }, - "CustomEntityLookupSkillLanguage": { - "type": "string", - "enum": [ - "da", - "de", - "en", - "es", - "fi", - "fr", - "it", - "ko", - "pt" - ], - "x-ms-enum": { - "name": "CustomEntityLookupSkillLanguage", - "modelAsString": true, - "values": [ - { - "value": "da", - "description": "Danish" - }, - { - "value": "de", - "description": "German" - }, - { - "value": "en", - "description": "English" - }, - { - "value": "es", - "description": "Spanish" - }, - { - "value": "fi", - "description": "Finnish" - }, - { - "value": "fr", - "description": "French" - }, - { - "value": "it", - "description": "Italian" - }, - { - "value": "ko", - "description": "Korean" - }, - { - "value": "pt", - "description": "Portuguese" - } - ] - }, - "description": "The language codes supported for input text by CustomEntityLookupSkill." - }, "EntityRecognitionSkillLanguage": { "type": "string", "enum": [ diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index ff607b71c3b9..4c94e18cd02b 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -6943,6 +6943,101 @@ }, "description": "Base type for skills." }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sentitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sentitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, "InputFieldMappingEntry": { "properties": { "name": { @@ -7215,6 +7310,51 @@ }, "description": "A skill to split a string into chunks of text." }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "entitiesDefinitionUri": { + "type": "string", + "description": "Path to a JSON or CSV file containing all the target text to match against." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, "TextTranslationSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", "allOf": [ @@ -7245,6 +7385,7 @@ }, "description": "A skill to translate text from one language to another." }, + "WebApiSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", "allOf": [ @@ -7849,6 +7990,63 @@ }, "description": "The language codes supported for input text by SplitSkill." }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, "EntityRecognitionSkillLanguage": { "type": "string", "enum": [ From 59133f7870210007fc77db917f53031e5cbfeeb5 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Mon, 28 Sep 2020 11:38:19 -0700 Subject: [PATCH 05/15] remove whiteline --- .../Azure.Search/preview/2020-06-30-Preview/searchservice.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 4c94e18cd02b..4132ad5591df 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7385,7 +7385,6 @@ }, "description": "A skill to translate text from one language to another." }, - "WebApiSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", "allOf": [ From f72c587c0a7d4d77ff4f24a0df6590805d035c76 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Tue, 29 Sep 2020 15:12:49 -0700 Subject: [PATCH 06/15] Update searchservice.json --- .../Azure.Search/preview/2020-06-30-Preview/searchservice.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 4132ad5591df..f2350aa1232c 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7324,7 +7324,7 @@ }, "entitiesDefinitionUri": { "type": "string", - "description": "Path to a JSON or CSV file containing all the target text to match against." + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run; any updates to this file mid-run won't be realized until subsequent runs. This config must be accessible over HTTPS." }, "inlineEntitiesDefinition": { "type": "array", From 09d1f4c357294c1bd1567361a36955f233513d99 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Tue, 29 Sep 2020 16:08:16 -0700 Subject: [PATCH 07/15] fix typo copied from public API docs. --- .../preview/2020-06-30-Preview/searchservice.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index f2350aa1232c..c5584f2a87db 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7019,12 +7019,12 @@ "caseSensitive": { "type": "boolean", "x-nullable": true, - "description": "Determine if the alias is case sentitive." + "description": "Determine if the alias is case sensitive." }, "accentSensitive": { "type": "boolean", "x-nullable": true, - "description": "Determine if the alias is accent sentitive." + "description": "Determine if the alias is accent sensitive." }, "fuzzyEditDistance": { "type": "integer", @@ -7336,7 +7336,7 @@ "globalDefaultCaseSensitive": { "type": "boolean", "x-nullable": true, - "description": "A global flag for CaseSentitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultAccentSensitive": { "type": "boolean", From 078593a425815c8af32766d3bd4d5ed59203029b Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Fri, 2 Oct 2020 15:35:59 -0700 Subject: [PATCH 08/15] Update searchservice.json Remove unnecessary x-nullable --- .../preview/2020-06-30-Preview/searchservice.json | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index c5584f2a87db..5b9959749fff 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -6967,34 +6967,28 @@ }, "caseSensitive": { "type": "boolean", - "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." }, "accentSensitive": { "type": "boolean", - "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", - "x-nullable": true, "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." }, "defaultCaseSensitive": { "type": "boolean", - "x-nullable": true, "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." }, "defaultAccentSensitive": { "type": "boolean", - "x-nullable": true, "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." }, "defaultFuzzyEditDistance": { "type": "integer", "format": "int32", - "x-nullable": true, "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." }, "aliases": { @@ -7018,18 +7012,15 @@ }, "caseSensitive": { "type": "boolean", - "x-nullable": true, "description": "Determine if the alias is case sensitive." }, "accentSensitive": { "type": "boolean", - "x-nullable": true, "description": "Determine if the alias is accent sensitive." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", - "x-nullable": true, "description": "Determine the fuzzy edit distance of the alias." } }, @@ -7335,18 +7326,15 @@ }, "globalDefaultCaseSensitive": { "type": "boolean", - "x-nullable": true, "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultAccentSensitive": { "type": "boolean", - "x-nullable": true, "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultFuzzyEditDistance": { "type": "integer", "format": "int32", - "x-nullable": true, "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, From e27dfb6e8688ea3f9c22aa17d466114675bf140a Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Thu, 8 Oct 2020 16:36:21 -0700 Subject: [PATCH 09/15] Update specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Co-authored-by: Heath Stewart --- .../Azure.Search/preview/2020-06-30-Preview/searchservice.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 5b9959749fff..2fab7207b13d 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7315,7 +7315,7 @@ }, "entitiesDefinitionUri": { "type": "string", - "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run; any updates to this file mid-run won't be realized until subsequent runs. This config must be accessible over HTTPS." + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." }, "inlineEntitiesDefinition": { "type": "array", From 2d51020c17bfb492a0331421207fa58a85fcd380 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Fri, 9 Oct 2020 14:14:53 -0700 Subject: [PATCH 10/15] Add GA CustomEntityLookupSkill --- .../preview/2020-06-30/searchservice.json | 185 ++++++++++++++++++ 1 file changed, 185 insertions(+) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index 57a5eedf1b93..abc8112e13c2 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -6943,6 +6943,92 @@ }, "description": "Base type for skills." }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "description": "Determine if the alias is case sensitive." + }, + "accentSensitive": { + "type": "boolean", + "description": "Determine if the alias is accent sensitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, "InputFieldMappingEntry": { "properties": { "name": { @@ -7215,6 +7301,48 @@ }, "description": "A skill to split a string into chunks of text." }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "entitiesDefinitionUri": { + "type": "string", + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, "TextTranslationSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", "allOf": [ @@ -7849,6 +7977,63 @@ }, "description": "The language codes supported for input text by SplitSkill." }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, "EntityRecognitionSkillLanguage": { "type": "string", "enum": [ From 07a54b4b68297dbc9e30e5b439a8591b3ffe73f9 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Mon, 19 Oct 2020 14:56:09 -0700 Subject: [PATCH 11/15] Update searchservice.json --- .../preview/2020-06-30-Preview/searchservice.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 2fab7207b13d..2a1d05a322e4 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -6971,7 +6971,7 @@ }, "accentSensitive": { "type": "boolean", - "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should considers accented and unaccented letters such as 'é' and 'e' to be identical." }, "fuzzyEditDistance": { "type": "integer", @@ -6980,7 +6980,7 @@ }, "defaultCaseSensitive": { "type": "boolean", - "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + "description": "Changes the default case sensitivity value for this entity. It can be used to change the default value of all aliases caseSensitive values." }, "defaultAccentSensitive": { "type": "boolean", @@ -6996,7 +6996,7 @@ "items": { "$ref": "#/definitions/CustomEntityAlias" }, - "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + "description": "An array of CustomEntityAlias that can be used to specify alternative spellings or synonyms to the root entity name." } }, "required": [ From 2185d99f87ffae33bb225048e2e87da1ca859f6b Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Mon, 19 Oct 2020 14:58:04 -0700 Subject: [PATCH 12/15] Update searchservice.json --- .../Azure.Search/preview/2020-06-30/searchservice.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index abc8112e13c2..4f4f21a7610d 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -6971,7 +6971,7 @@ }, "accentSensitive": { "type": "boolean", - "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should considers accented and unaccented letters such as 'é' and 'e' to be identical." }, "fuzzyEditDistance": { "type": "integer", @@ -6980,7 +6980,7 @@ }, "defaultCaseSensitive": { "type": "boolean", - "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + "description": "Changes the default case sensitivity value for this entity. It can be used to change the default value of all aliases caseSensitive values." }, "defaultAccentSensitive": { "type": "boolean", @@ -6996,7 +6996,7 @@ "items": { "$ref": "#/definitions/CustomEntityAlias" }, - "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + "description": "An array of CustomEntityAlias that can be used to specify alternative spellings or synonyms to the root entity name." } }, "required": [ From ab0e8b72c546782413e0d7780b999133e74abadf Mon Sep 17 00:00:00 2001 From: Shuyang Zhang Date: Wed, 21 Oct 2020 16:22:26 -0700 Subject: [PATCH 13/15] Add back x-nullable --- .../2020-06-30-Preview/searchservice.json | 17 +++++++++++++++++ .../preview/2020-06-30/searchservice.json | 16 ++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 2fab7207b13d..baf2ad49c710 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -6951,44 +6951,54 @@ }, "description": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "type": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "subtype": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "id": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "caseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." }, "accentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." }, "defaultCaseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." }, "defaultAccentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." }, "defaultFuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." }, "aliases": { @@ -7008,19 +7018,23 @@ "properties": { "text": { "type": "string", + "x-nullable": true, "description": "The text of the alias." }, "caseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Determine if the alias is case sensitive." }, "accentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Determine if the alias is accent sensitive." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Determine the fuzzy edit distance of the alias." } }, @@ -7326,15 +7340,18 @@ }, "globalDefaultCaseSensitive": { "type": "boolean", + "x-nullable": true, "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultAccentSensitive": { "type": "boolean", + "x-nullable": true, "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultFuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index abc8112e13c2..9fdecdef2581 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -6951,44 +6951,54 @@ }, "description": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "type": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "subtype": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "id": { "type": "string", + "x-nullable": true, "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." }, "caseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." }, "accentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." }, "defaultCaseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." }, "defaultAccentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." }, "defaultFuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." }, "aliases": { @@ -7012,15 +7022,18 @@ }, "caseSensitive": { "type": "boolean", + "x-nullable": true, "description": "Determine if the alias is case sensitive." }, "accentSensitive": { "type": "boolean", + "x-nullable": true, "description": "Determine if the alias is accent sensitive." }, "fuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "Determine the fuzzy edit distance of the alias." } }, @@ -7326,15 +7339,18 @@ }, "globalDefaultCaseSensitive": { "type": "boolean", + "x-nullable": true, "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultAccentSensitive": { "type": "boolean", + "x-nullable": true, "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." }, "globalDefaultFuzzyEditDistance": { "type": "integer", "format": "int32", + "x-nullable": true, "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." } }, From 8a75854f3e82bee0b2a11f414d471d7135ef1c39 Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Wed, 21 Oct 2020 16:29:26 -0700 Subject: [PATCH 14/15] Update searchservice.json --- .../preview/2020-06-30-Preview/searchservice.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index baf2ad49c710..d1d1109234f9 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7006,6 +7006,7 @@ "items": { "$ref": "#/definitions/CustomEntityAlias" }, + "x-nullable": true, "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." } }, @@ -7018,7 +7019,6 @@ "properties": { "text": { "type": "string", - "x-nullable": true, "description": "The text of the alias." }, "caseSensitive": { @@ -7325,10 +7325,12 @@ "properties": { "defaultLanguageCode": { "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, "description": "A value indicating which language code to use. Default is en." }, "entitiesDefinitionUri": { "type": "string", + "x-nullable": true, "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." }, "inlineEntitiesDefinition": { @@ -7336,6 +7338,7 @@ "items": { "$ref": "#/definitions/CustomEntity" }, + "x-nullable": true, "description": "The inline CustomEntity definition." }, "globalDefaultCaseSensitive": { From 3940d0a1bd05fce1c884bf15a7bea9caa51d35af Mon Sep 17 00:00:00 2001 From: Shuyang Zhang <62564394+shuyangmsft@users.noreply.github.com> Date: Wed, 21 Oct 2020 16:30:36 -0700 Subject: [PATCH 15/15] Update searchservice.json --- .../Azure.Search/preview/2020-06-30/searchservice.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index 9fdecdef2581..6adb053f5fcc 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -7006,6 +7006,7 @@ "items": { "$ref": "#/definitions/CustomEntityAlias" }, + "x-nullable": true, "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." } }, @@ -7324,10 +7325,12 @@ "properties": { "defaultLanguageCode": { "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, "description": "A value indicating which language code to use. Default is en." }, "entitiesDefinitionUri": { "type": "string", + "x-nullable": true, "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." }, "inlineEntitiesDefinition": { @@ -7335,6 +7338,7 @@ "items": { "$ref": "#/definitions/CustomEntity" }, + "x-nullable": true, "description": "The inline CustomEntity definition." }, "globalDefaultCaseSensitive": {