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 CustomEnityLookupSkill to 2020-06-30 and 2020-06-30-Preview #11113

Merged
merged 16 commits into from
Jan 6, 2021
Merged

Add CustomEnityLookupSkill to 2020-06-30 and 2020-06-30-Preview #11113

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
981fb28
Add CustomEntityLookupSkill to searchservice.json
shuyangmsft Sep 17, 2020
b3cc204
Fix typos
shuyangmsft Sep 17, 2020
01a4fb8
remove non-required fields from "required"
shuyangmsft Sep 17, 2020
9fe6d35
Move API change to 2020-06-30
shuyangmsft Sep 28, 2020
59133f7
remove whiteline
shuyangmsft Sep 28, 2020
f72c587
Update searchservice.json
shuyangmsft Sep 29, 2020
09d1f4c
fix typo copied from public API docs.
shuyangmsft Sep 29, 2020
078593a
Update searchservice.json
shuyangmsft Oct 2, 2020
e27dfb6
Update specification/search/data-plane/Azure.Search/preview/2020-06-3…
shuyangmsft Oct 8, 2020
2d51020
Add GA CustomEntityLookupSkill
shuyangmsft Oct 9, 2020
07a54b4
Update searchservice.json
shuyangmsft Oct 19, 2020
2185d99
Update searchservice.json
shuyangmsft Oct 19, 2020
ab0e8b7
Add back x-nullable
shuyangmsft Oct 21, 2020
7e97cab
Merge branch 'master' of https://github.com/shuyangmsft/azure-rest-ap…
shuyangmsft Oct 21, 2020
8a75854
Update searchservice.json
shuyangmsft Oct 21, 2020
3940d0a
Update searchservice.json
shuyangmsft Oct 21, 2020
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
185 changes: 185 additions & 0 deletions specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6943,6 +6943,92 @@
},
"description": "Base type for skills."
},
"CustomEntity": {
"properties": {
shuyangmsft marked this conversation as resolved.
Show resolved Hide resolved
"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."
shuyangmsft marked this conversation as resolved.
Show resolved Hide resolved
},
"accentSensitive": {
"type": "boolean",
"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",
"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",
shuyangmsft marked this conversation as resolved.
Show resolved Hide resolved
"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",
"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 CustomEntityAlias 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": {
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand Down
Loading