Skip to content

Release search azure.search preview: 2024-11-01-preview #30485

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

Merged
jonathanserbent merged 14 commits into from
Oct 4, 2024
Merged

Release search azure.search preview: 2024-11-01-preview #30485

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
479346c
Copy over old spec into new folder
Sep 9, 2024
99d8479
Update version to 11-01
Sep 9, 2024
24c9c79
Initial feature spec changes
Sep 9, 2024
057a1e5
Additional Feature Changes and Examples
Sep 24, 2024
17fe8ec
Swagger Prettier Check
Sep 24, 2024
7a70e3b
Swagger Lint
Sep 24, 2024
ca9f4d6
Fix order of semanticQuery Parameter
Oct 1, 2024
576b30d
Apply feedback
Oct 1, 2024
ae4b49a
Add back defaultoversampling and rerankWithOriginalVectors
Oct 3, 2024
7a9f370
Semantic query order
Oct 3, 2024
04c392b
Spellcheck CI
Oct 3, 2024
cad1472
swagger prettier CI
Oct 3, 2024
2893d68
Make the QueryRewrites List of List of strings into a List of objects…
Oct 4, 2024
946bd6e
Merge branch 'main' into release-search-Azure.Search-preview/2024-11-…
jonathanserbent Oct 4, 2024
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
Prev Previous commit
Next Next commit
Make the QueryRewrites List of List of strings into a List of objects… 
… which contain a list of string
  • Loading branch information
Jonathan Serbent committed Oct 4, 2024
commit 2893d68616ad89fec992f0a3b4be2518c8546109
48 changes: 29 additions & 19 deletions specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,8 @@
"disabled",
Copy link
Member

@alzimmermsft alzimmermsft Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in another comment elsewhere, all is supported and we should look into adding that as an option here.

"semantic",
"vector",
"queryRewrites"
"queryRewrites",
"all"
],
"x-ms-enum": {
"name": "QueryDebugMode",
Expand All @@ -539,6 +540,11 @@
"value": "queryRewrites",
"name": "QueryRewrites",
"description": "Allows the user to explore the list of query rewrites generated for their search request."
},
{
"value": "all",
"name": "All",
"description": "Turn on all debug options."
}
]
},
Expand Down Expand Up @@ -585,7 +591,7 @@
"lexicon"
],
"x-ms-enum": {
"name": "Speller",
"name": "QuerySpellerType",
"modelAsString": true,
"values": [
{
Expand Down Expand Up @@ -1348,10 +1354,10 @@
"x-ms-client-name": "SemanticPartialResponseType",
"description": "Type of partial response that was returned for a semantic ranking request."
},
"@search.semanticQueryRewriteResultType": {
"$ref": "#/definitions/SemanticQueryRewriteResultType",
"@search.semanticQueryRewritesResultType": {
"$ref": "#/definitions/SemanticQueryRewritesResultType",
"readOnly": true,
"x-ms-client-name": "SemanticQueryRewriteResultType",
"x-ms-client-name": "SemanticQueryRewritesResultType",
"description": "Type of query rewrite that was used to retrieve documents."
}
},
Expand Down Expand Up @@ -1573,7 +1579,7 @@
}
]
},
"description": "Enables a debugging tool that can be used to further explore your search results."
"description": "Enables a debugging tool that can be used to further explore your search results. You can enable multiple debug modes simultaneously by separating them with a | character, for example: semantic|queryRewrites."
},
"SearchMode": {
"type": "string",
Expand Down Expand Up @@ -2877,13 +2883,13 @@
},
"description": "Type of partial response that was returned for a semantic ranking request."
},
"SemanticQueryRewriteResultType": {
"SemanticQueryRewritesResultType": {
"type": "string",
"enum": [
"originalQueryOnly"
],
"x-ms-enum": {
"name": "SemanticQueryRewriteResultType",
"name": "SemanticQueryRewritesResultType",
"modelAsString": true,
"values": [
{
Expand Down Expand Up @@ -2989,7 +2995,7 @@
}
]
},
"description": "When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. This parameter is only valid if the query type is `semantic`."
"description": "This parameter is only valid if the query type is `semantic`. When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`."
},
"DebugInfo": {
"type": "object",
Expand Down Expand Up @@ -3196,17 +3202,14 @@
"type": "object",
"properties": {
"text": {
"type": "array",
"items": {
"type": "string"
},
"$ref": "#/definitions/QueryRewritesValuesDebugInfo",
"readOnly": true,
"description": "List of query rewrites generated for the text query."
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/VectorQueryRewritesDebugInfo"
"$ref": "#/definitions/QueryRewritesValuesDebugInfo"
},
"readOnly": true,
"description": "List of query rewrites generated for the vectorizable text queries."
Expand All @@ -3215,13 +3218,20 @@
"readOnly": true,
"description": "Contains debugging information specific to query rewrites."
},
"VectorQueryRewritesDebugInfo": {
"type": "array",
"items": {
"type": "string"
"QueryRewritesValuesDebugInfo": {
"type": "object",
"properties": {
"rewrites": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true,
"description": "List of query rewrites."
}
},
"readOnly": true,
"description": "List of query rewrites generated for the vectorizable text queries."
"description": "Contains debugging information specific to query rewrites."
}
},
"parameters": {
Expand Down