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

[Azure Cognitive Search] Add missing x-nullable annotations, part 2 #10293

Merged
merged 2 commits into from
Jul 30, 2020
Merged

[Azure Cognitive Search] Add missing x-nullable annotations, part 2 #10293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f91e71e
[Azure Cognitive Search] Add missing x-nullable annotations, part 2
Jul 29, 2020
bc12b42
[Azure Cognitive Search] Fix example causing validation error
Jul 29, 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
27 changes: 18 additions & 9 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 @@ -5518,12 +5518,14 @@
"k1": {
"type": "number",
"format": "double",
"description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency."
"description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.",
"x-nullable": true
},
"b": {
"type": "number",
"format": "double",
"description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document."
"description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.",
"x-nullable": true
}
},
"description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)."
Expand Down Expand Up @@ -6246,21 +6248,24 @@
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
"description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.",
"x-nullable": true
},
"searchAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields."
"description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.",
"x-nullable": true
},
"indexAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
"description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.",
"x-nullable": true
},
"synonymMaps": {
"externalDocs": {
Expand Down Expand Up @@ -6540,7 +6545,8 @@
"text": {
"x-ms-client-name": "TextWeights",
"$ref": "#/definitions/TextWeights",
"description": "Parameters that boost scoring based on text matches in certain index fields."
"description": "Parameters that boost scoring based on text matches in certain index fields.",
"x-nullable": true
},
"functions": {
"type": "array",
Expand Down Expand Up @@ -6695,7 +6701,8 @@
},
"corsOptions": {
"$ref": "#/definitions/CorsOptions",
"description": "Options to control Cross-Origin Resource Sharing (CORS) for the index."
"description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.",
"x-nullable": true
},
"suggesters": {
"type": "array",
Expand Down Expand Up @@ -6749,7 +6756,8 @@
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
}
},
"x-nullable": true
},
"similarity": {
"$ref": "#/definitions/Similarity",
Expand Down Expand Up @@ -8371,7 +8379,8 @@
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
}
},
"x-nullable": true
},
"@odata.etag": {
"x-ms-client-name": "ETag",
Expand Down
4 changes: 0 additions & 4 deletions ...ata-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@
"synonymMaps": {
"usage": 2,
"quota": 3
},
"skillsetCount": {
"usage": 0,
"quota": 3
}
},
"limits": {
Expand Down
27 changes: 18 additions & 9 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 @@ -5518,12 +5518,14 @@
"k1": {
"type": "number",
"format": "double",
"description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency."
"description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.",
"x-nullable": true
},
"b": {
"type": "number",
"format": "double",
"description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document."
"description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.",
"x-nullable": true
}
},
"description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)."
Expand Down Expand Up @@ -6246,21 +6248,24 @@
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
"description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.",
"x-nullable": true
},
"searchAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields."
"description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.",
"x-nullable": true
},
"indexAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
"$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
"description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.",
"x-nullable": true
},
"synonymMaps": {
"externalDocs": {
Expand Down Expand Up @@ -6540,7 +6545,8 @@
"text": {
"x-ms-client-name": "TextWeights",
"$ref": "#/definitions/TextWeights",
"description": "Parameters that boost scoring based on text matches in certain index fields."
"description": "Parameters that boost scoring based on text matches in certain index fields.",
"x-nullable": true
},
"functions": {
"type": "array",
Expand Down Expand Up @@ -6695,7 +6701,8 @@
},
"corsOptions": {
"$ref": "#/definitions/CorsOptions",
"description": "Options to control Cross-Origin Resource Sharing (CORS) for the index."
"description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.",
"x-nullable": true
},
"suggesters": {
"type": "array",
Expand Down Expand Up @@ -6749,7 +6756,8 @@
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
}
},
"x-nullable": true
},
"similarity": {
"$ref": "#/definitions/Similarity",
Expand Down Expand Up @@ -8371,7 +8379,8 @@
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
}
},
"x-nullable": true
},
"@odata.etag": {
"x-ms-client-name": "ETag",
Expand Down