Skip to content

Commit ba22e24

Browse files
feat(discoveryengine): update the API
#### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.keywordSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.properties.semanticSearchThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.properties.semanticRelevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description
1 parent e451043 commit ba22e24

File tree

6 files changed

+503
-17
lines changed

6 files changed

+503
-17
lines changed

discovery/discoveryengine-v1.json

Lines changed: 102 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8801,7 +8801,7 @@
88018801
}
88028802
}
88038803
},
8804-
"revision": "20251216",
8804+
"revision": "20251217",
88058805
"rootUrl": "https://discoveryengine.googleapis.com/",
88068806
"schemas": {
88078807
"GoogleApiDistribution": {
@@ -16925,7 +16925,7 @@
1692516925
"description": "Optional. The specification for returning the relevance score."
1692616926
},
1692716927
"relevanceThreshold": {
16928-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
16928+
"description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
1692916929
"enum": [
1693016930
"RELEVANCE_THRESHOLD_UNSPECIFIED",
1693116931
"LOWEST",
@@ -25340,12 +25340,16 @@
2534025340
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
2534125341
"type": "string"
2534225342
},
25343+
"relevanceFilterSpec": {
25344+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
25345+
"description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
25346+
},
2534325347
"relevanceScoreSpec": {
2534425348
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
2534525349
"description": "Optional. The specification for returning the relevance score."
2534625350
},
2534725351
"relevanceThreshold": {
25348-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
25352+
"description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
2534925353
"enum": [
2535025354
"RELEVANCE_THRESHOLD_UNSPECIFIED",
2535125355
"LOWEST",
@@ -25997,6 +26001,51 @@
2599726001
},
2599826002
"type": "object"
2599926003
},
26004+
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": {
26005+
"description": "Relevance filtering specification.",
26006+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
26007+
"properties": {
26008+
"keywordSearchThreshold": {
26009+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26010+
"description": "Optional. Relevance filtering threshold specification for keyword search."
26011+
},
26012+
"semanticSearchThreshold": {
26013+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26014+
"description": "Optional. Relevance filtering threshold specification for semantic search."
26015+
}
26016+
},
26017+
"type": "object"
26018+
},
26019+
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
26020+
"description": "Specification for relevance filtering on a specific sub-search.",
26021+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26022+
"properties": {
26023+
"relevanceThreshold": {
26024+
"description": "Pre-defined relevance threshold for the sub-search.",
26025+
"enum": [
26026+
"RELEVANCE_THRESHOLD_UNSPECIFIED",
26027+
"LOWEST",
26028+
"LOW",
26029+
"MEDIUM",
26030+
"HIGH"
26031+
],
26032+
"enumDescriptions": [
26033+
"Default value. In this case, server behavior defaults to Google defined threshold.",
26034+
"Lowest relevance threshold.",
26035+
"Low relevance threshold.",
26036+
"Medium relevance threshold.",
26037+
"High relevance threshold."
26038+
],
26039+
"type": "string"
26040+
},
26041+
"semanticRelevanceThreshold": {
26042+
"description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
26043+
"format": "float",
26044+
"type": "number"
26045+
}
26046+
},
26047+
"type": "object"
26048+
},
2600026049
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
2600126050
"description": "The specification for returning the document relevance score.",
2600226051
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
@@ -29393,12 +29442,16 @@
2939329442
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
2939429443
"type": "string"
2939529444
},
29445+
"relevanceFilterSpec": {
29446+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
29447+
"description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
29448+
},
2939629449
"relevanceScoreSpec": {
2939729450
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
2939829451
"description": "Optional. The specification for returning the relevance score."
2939929452
},
2940029453
"relevanceThreshold": {
29401-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
29454+
"description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
2940229455
"enum": [
2940329456
"RELEVANCE_THRESHOLD_UNSPECIFIED",
2940429457
"LOWEST",
@@ -30046,6 +30099,51 @@
3004630099
},
3004730100
"type": "object"
3004830101
},
30102+
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": {
30103+
"description": "Relevance filtering specification.",
30104+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
30105+
"properties": {
30106+
"keywordSearchThreshold": {
30107+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30108+
"description": "Optional. Relevance filtering threshold specification for keyword search."
30109+
},
30110+
"semanticSearchThreshold": {
30111+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30112+
"description": "Optional. Relevance filtering threshold specification for semantic search."
30113+
}
30114+
},
30115+
"type": "object"
30116+
},
30117+
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
30118+
"description": "Specification for relevance filtering on a specific sub-search.",
30119+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30120+
"properties": {
30121+
"relevanceThreshold": {
30122+
"description": "Pre-defined relevance threshold for the sub-search.",
30123+
"enum": [
30124+
"RELEVANCE_THRESHOLD_UNSPECIFIED",
30125+
"LOWEST",
30126+
"LOW",
30127+
"MEDIUM",
30128+
"HIGH"
30129+
],
30130+
"enumDescriptions": [
30131+
"Default value. In this case, server behavior defaults to Google defined threshold.",
30132+
"Lowest relevance threshold.",
30133+
"Low relevance threshold.",
30134+
"Medium relevance threshold.",
30135+
"High relevance threshold."
30136+
],
30137+
"type": "string"
30138+
},
30139+
"semanticRelevanceThreshold": {
30140+
"description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
30141+
"format": "float",
30142+
"type": "number"
30143+
}
30144+
},
30145+
"type": "object"
30146+
},
3004930147
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
3005030148
"description": "The specification for returning the document relevance score.",
3005130149
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",

discovery/discoveryengine-v1alpha.json

Lines changed: 101 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12111,7 +12111,7 @@
1211112111
}
1211212112
}
1211312113
},
12114-
"revision": "20251216",
12114+
"revision": "20251217",
1211512115
"rootUrl": "https://discoveryengine.googleapis.com/",
1211612116
"schemas": {
1211712117
"GoogleApiDistribution": {
@@ -27638,12 +27638,16 @@
2763827638
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
2763927639
"type": "string"
2764027640
},
27641+
"relevanceFilterSpec": {
27642+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
27643+
"description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
27644+
},
2764127645
"relevanceScoreSpec": {
2764227646
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
2764327647
"description": "Optional. The specification for returning the relevance score."
2764427648
},
2764527649
"relevanceThreshold": {
27646-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
27650+
"description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
2764727651
"enum": [
2764827652
"RELEVANCE_THRESHOLD_UNSPECIFIED",
2764927653
"LOWEST",
@@ -28295,6 +28299,51 @@
2829528299
},
2829628300
"type": "object"
2829728301
},
28302+
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": {
28303+
"description": "Relevance filtering specification.",
28304+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
28305+
"properties": {
28306+
"keywordSearchThreshold": {
28307+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
28308+
"description": "Optional. Relevance filtering threshold specification for keyword search."
28309+
},
28310+
"semanticSearchThreshold": {
28311+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
28312+
"description": "Optional. Relevance filtering threshold specification for semantic search."
28313+
}
28314+
},
28315+
"type": "object"
28316+
},
28317+
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
28318+
"description": "Specification for relevance filtering on a specific sub-search.",
28319+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
28320+
"properties": {
28321+
"relevanceThreshold": {
28322+
"description": "Pre-defined relevance threshold for the sub-search.",
28323+
"enum": [
28324+
"RELEVANCE_THRESHOLD_UNSPECIFIED",
28325+
"LOWEST",
28326+
"LOW",
28327+
"MEDIUM",
28328+
"HIGH"
28329+
],
28330+
"enumDescriptions": [
28331+
"Default value. In this case, server behavior defaults to Google defined threshold.",
28332+
"Lowest relevance threshold.",
28333+
"Low relevance threshold.",
28334+
"Medium relevance threshold.",
28335+
"High relevance threshold."
28336+
],
28337+
"type": "string"
28338+
},
28339+
"semanticRelevanceThreshold": {
28340+
"description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
28341+
"format": "float",
28342+
"type": "number"
28343+
}
28344+
},
28345+
"type": "object"
28346+
},
2829828347
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
2829928348
"description": "The specification for returning the document relevance score.",
2830028349
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
@@ -34125,12 +34174,16 @@
3412534174
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
3412634175
"type": "string"
3412734176
},
34177+
"relevanceFilterSpec": {
34178+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
34179+
"description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
34180+
},
3412834181
"relevanceScoreSpec": {
3412934182
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
3413034183
"description": "Optional. The specification for returning the relevance score."
3413134184
},
3413234185
"relevanceThreshold": {
34133-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
34186+
"description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
3413434187
"enum": [
3413534188
"RELEVANCE_THRESHOLD_UNSPECIFIED",
3413634189
"LOWEST",
@@ -34778,6 +34831,51 @@
3477834831
},
3477934832
"type": "object"
3478034833
},
34834+
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": {
34835+
"description": "Relevance filtering specification.",
34836+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
34837+
"properties": {
34838+
"keywordSearchThreshold": {
34839+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
34840+
"description": "Optional. Relevance filtering threshold specification for keyword search."
34841+
},
34842+
"semanticSearchThreshold": {
34843+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
34844+
"description": "Optional. Relevance filtering threshold specification for semantic search."
34845+
}
34846+
},
34847+
"type": "object"
34848+
},
34849+
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
34850+
"description": "Specification for relevance filtering on a specific sub-search.",
34851+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
34852+
"properties": {
34853+
"relevanceThreshold": {
34854+
"description": "Pre-defined relevance threshold for the sub-search.",
34855+
"enum": [
34856+
"RELEVANCE_THRESHOLD_UNSPECIFIED",
34857+
"LOWEST",
34858+
"LOW",
34859+
"MEDIUM",
34860+
"HIGH"
34861+
],
34862+
"enumDescriptions": [
34863+
"Default value. In this case, server behavior defaults to Google defined threshold.",
34864+
"Lowest relevance threshold.",
34865+
"Low relevance threshold.",
34866+
"Medium relevance threshold.",
34867+
"High relevance threshold."
34868+
],
34869+
"type": "string"
34870+
},
34871+
"semanticRelevanceThreshold": {
34872+
"description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
34873+
"format": "float",
34874+
"type": "number"
34875+
}
34876+
},
34877+
"type": "object"
34878+
},
3478134879
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
3478234880
"description": "The specification for returning the document relevance score.",
3478334881
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",

0 commit comments

Comments
 (0)