You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+22
Original file line number
Diff line number
Diff line change
@@ -1092,6 +1092,10 @@ <h3>Method Details</h3>
1092
1092
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
1093
1093
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
1094
1094
},
1095
+
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
1096
+
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
1097
+
},
1098
+
"relevanceThreshold": "A String", # 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.
1095
1099
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
1096
1100
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
1097
1101
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
@@ -1214,6 +1218,13 @@ <h3>Method Details</h3>
1214
1218
},
1215
1219
},
1216
1220
"id": "A String", # Document.id of the searched Document.
1221
+
"modelScores": { # Output only. Google provided available scores.
1222
+
"a_key": { # Double list.
1223
+
"values": [ # Double values.
1224
+
3.14,
1225
+
],
1226
+
},
1227
+
},
1217
1228
},
1218
1229
],
1219
1230
"searchLinkPromotions": [ # Promotions for site search.
@@ -1416,6 +1427,10 @@ <h3>Method Details</h3>
1416
1427
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
1417
1428
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
1418
1429
},
1430
+
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
1431
+
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
1432
+
},
1433
+
"relevanceThreshold": "A String", # 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.
1419
1434
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
1420
1435
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
1421
1436
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
@@ -1538,6 +1553,13 @@ <h3>Method Details</h3>
1538
1553
},
1539
1554
},
1540
1555
"id": "A String", # Document.id of the searched Document.
1556
+
"modelScores": { # Output only. Google provided available scores.
1557
+
"a_key": { # Double list.
1558
+
"values": [ # Double values.
1559
+
3.14,
1560
+
],
1561
+
},
1562
+
},
1541
1563
},
1542
1564
],
1543
1565
"searchLinkPromotions": [ # Promotions for site search.
Copy file name to clipboardexpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
+5
Original file line number
Diff line number
Diff line change
@@ -143,6 +143,7 @@ <h3>Method Details</h3>
143
143
"location": "A String", # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
144
144
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
145
145
},
146
+
"allowCrossRegion": True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
146
147
"dialogflowAgentToLink": "A String", # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
147
148
},
148
149
"chatEngineMetadata": { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
@@ -256,6 +257,7 @@ <h3>Method Details</h3>
256
257
"location": "A String", # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
257
258
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
258
259
},
260
+
"allowCrossRegion": True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
259
261
"dialogflowAgentToLink": "A String", # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
260
262
},
261
263
"chatEngineMetadata": { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
@@ -310,6 +312,7 @@ <h3>Method Details</h3>
310
312
"location": "A String", # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
311
313
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
312
314
},
315
+
"allowCrossRegion": True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
313
316
"dialogflowAgentToLink": "A String", # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
314
317
},
315
318
"chatEngineMetadata": { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
@@ -371,6 +374,7 @@ <h3>Method Details</h3>
371
374
"location": "A String", # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
372
375
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
373
376
},
377
+
"allowCrossRegion": True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
374
378
"dialogflowAgentToLink": "A String", # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
375
379
},
376
380
"chatEngineMetadata": { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
@@ -414,6 +418,7 @@ <h3>Method Details</h3>
414
418
"location": "A String", # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
415
419
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
416
420
},
421
+
"allowCrossRegion": True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
417
422
"dialogflowAgentToLink": "A String", # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
418
423
},
419
424
"chatEngineMetadata": { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
Copy file name to clipboardexpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+22
Original file line number
Diff line number
Diff line change
@@ -1092,6 +1092,10 @@ <h3>Method Details</h3>
1092
1092
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
1093
1093
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
1094
1094
},
1095
+
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
1096
+
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
1097
+
},
1098
+
"relevanceThreshold": "A String", # 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.
1095
1099
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
1096
1100
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
1097
1101
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
@@ -1214,6 +1218,13 @@ <h3>Method Details</h3>
1214
1218
},
1215
1219
},
1216
1220
"id": "A String", # Document.id of the searched Document.
1221
+
"modelScores": { # Output only. Google provided available scores.
1222
+
"a_key": { # Double list.
1223
+
"values": [ # Double values.
1224
+
3.14,
1225
+
],
1226
+
},
1227
+
},
1217
1228
},
1218
1229
],
1219
1230
"searchLinkPromotions": [ # Promotions for site search.
@@ -1416,6 +1427,10 @@ <h3>Method Details</h3>
1416
1427
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
1417
1428
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
1418
1429
},
1430
+
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
1431
+
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
1432
+
},
1433
+
"relevanceThreshold": "A String", # 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.
1419
1434
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
1420
1435
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
1421
1436
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
@@ -1538,6 +1553,13 @@ <h3>Method Details</h3>
1538
1553
},
1539
1554
},
1540
1555
"id": "A String", # Document.id of the searched Document.
1556
+
"modelScores": { # Output only. Google provided available scores.
1557
+
"a_key": { # Double list.
1558
+
"values": [ # Double values.
1559
+
3.14,
1560
+
],
1561
+
},
1562
+
},
1541
1563
},
1542
1564
],
1543
1565
"searchLinkPromotions": [ # Promotions for site search.
0 commit comments