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
+24
Original file line number
Diff line number
Diff line change
@@ -127,6 +127,18 @@ <h3>Method Details</h3>
127
127
},
128
128
},
129
129
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
130
+
"endUserSpec": { # End user specification. # Optional. End user specification.
131
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
135
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
136
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
132
144
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
@@ -1637,6 +1649,18 @@ <h3>Method Details</h3>
1637
1649
},
1638
1650
},
1639
1651
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
1652
+
"endUserSpec": { # End user specification. # Optional. End user specification.
1653
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
1657
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
1658
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
1642
1666
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+24
Original file line number
Diff line number
Diff line change
@@ -127,6 +127,18 @@ <h3>Method Details</h3>
127
127
},
128
128
},
129
129
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
130
+
"endUserSpec": { # End user specification. # Optional. End user specification.
131
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
135
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
136
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
132
144
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
@@ -1637,6 +1649,18 @@ <h3>Method Details</h3>
1637
1649
},
1638
1650
},
1639
1651
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
1652
+
"endUserSpec": { # End user specification. # Optional. End user specification.
1653
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
1657
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
1658
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
1642
1666
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+24
Original file line number
Diff line number
Diff line change
@@ -127,6 +127,18 @@ <h3>Method Details</h3>
127
127
},
128
128
},
129
129
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
130
+
"endUserSpec": { # End user specification. # Optional. End user specification.
131
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
135
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
136
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
132
144
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
@@ -1637,6 +1649,18 @@ <h3>Method Details</h3>
1637
1649
},
1638
1650
},
1639
1651
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
1652
+
"endUserSpec": { # End user specification. # Optional. End user specification.
1653
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
1657
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
1658
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
1642
1666
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
+6
Original file line number
Diff line number
Diff line change
@@ -107,6 +107,12 @@ <h3>Method Details</h3>
107
107
"includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
108
108
"query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.
109
109
"queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
110
+
"suggestionTypeSpecs": [ # Optional. Specification of each suggestion type.
111
+
{ # Specification of each suggestion type.
112
+
"maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type.
"suggestionTypes": [ # Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+24
Original file line number
Diff line number
Diff line change
@@ -136,6 +136,18 @@ <h3>Method Details</h3>
136
136
},
137
137
},
138
138
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
139
+
"endUserSpec": { # End user specification. # Optional. End user specification.
140
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
144
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
145
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
141
153
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
@@ -2339,6 +2351,18 @@ <h3>Method Details</h3>
2339
2351
},
2340
2352
},
2341
2353
"asynchronousMode": True or False, # Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
2354
+
"endUserSpec": { # End user specification. # Optional. End user specification.
2355
+
"endUserMetadata": [ # Optional. End user metadata.
"content": "A String", # Chunk textual content. It is limited to 8000 characters.
2359
+
"documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
2360
+
"title": "A String", # Title of the document.
"filteringLevel": "A String", # Optional. Specifies whether to enable the filtering based on grounding score and at what level.
2344
2368
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html
+6
Original file line number
Diff line number
Diff line change
@@ -107,6 +107,12 @@ <h3>Method Details</h3>
107
107
"includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
108
108
"query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.
109
109
"queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
110
+
"suggestionTypeSpecs": [ # Optional. Specification of each suggestion type.
111
+
{ # Specification of each suggestion type.
112
+
"maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type.
"suggestionTypes": [ # Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
0 commit comments