@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20241020 → 0.0.20241025

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +507 -2
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20241020
12
+ // Revision: 20241025
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -94,12 +94,24 @@ declare namespace gapi.client {
94
94
  /** Application specific response metadata. Must be set in the first response for streaming APIs. */
95
95
  extensions?: Array<{[P in string]: any}>;
96
96
  }
97
+ interface GoogleApiMetric {
98
+ /** The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values. */
99
+ labels?: {[P in string]: string};
100
+ /** An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`. */
101
+ type?: string;
102
+ }
97
103
  interface GoogleApiMonitoredResource {
98
104
  /** Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`. */
99
105
  labels?: {[P in string]: string};
100
106
  /** Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`. */
101
107
  type?: string;
102
108
  }
109
+ interface GoogleApiMonitoredResourceMetadata {
110
+ /** Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */
111
+ systemLabels?: {[P in string]: any};
112
+ /** Output only. A map of user-defined metadata labels. */
113
+ userLabels?: {[P in string]: string};
114
+ }
103
115
  interface GoogleCloudDiscoveryengineLoggingErrorContext {
104
116
  /** The HTTP request which was processed when the error was triggered. */
105
117
  httpRequest?: GoogleCloudDiscoveryengineLoggingHttpRequestContext;
@@ -153,6 +165,78 @@ declare namespace gapi.client {
153
165
  /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
154
166
  name?: string;
155
167
  }
168
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest {
169
+ /** Optional. Specification to boost suggestions matching the condition. */
170
+ boostSpec?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec;
171
+ /** 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. */
172
+ includeTailSuggestions?: boolean;
173
+ /** 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. */
174
+ query?: string;
175
+ /** 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. */
176
+ queryModel?: string;
177
+ /** Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. */
178
+ suggestionTypes?: string[];
179
+ /** Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. */
180
+ userInfo?: GoogleCloudDiscoveryengineV1alphaUserInfo;
181
+ /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 */
182
+ userPseudoId?: string;
183
+ }
184
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
185
+ /** Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. */
186
+ conditionBoostSpecs?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[];
187
+ }
188
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec {
189
+ /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
190
+ boost?: number;
191
+ /** An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` */
192
+ condition?: string;
193
+ }
194
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse {
195
+ /** Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. */
196
+ contentSuggestions?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion[];
197
+ /** Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. */
198
+ peopleSuggestions?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion[];
199
+ /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
200
+ querySuggestions?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion[];
201
+ /** Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. */
202
+ recentSearchSuggestions?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion[];
203
+ /** True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. */
204
+ tailMatchTriggered?: boolean;
205
+ }
206
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion {
207
+ /** The type of the content suggestion. */
208
+ contentType?: string;
209
+ /** The name of the dataStore that this suggestion belongs to. */
210
+ dataStore?: string;
211
+ /** The document data snippet in the suggestion. Only a subset of fields will be populated. */
212
+ document?: GoogleCloudDiscoveryengineV1alphaDocument;
213
+ /** The suggestion for the query. */
214
+ suggestion?: string;
215
+ }
216
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion {
217
+ /** The name of the dataStore that this suggestion belongs to. */
218
+ dataStore?: string;
219
+ /** The document data snippet in the suggestion. Only a subset of fields is populated. */
220
+ document?: GoogleCloudDiscoveryengineV1alphaDocument;
221
+ /** The type of the person. */
222
+ personType?: string;
223
+ /** The suggestion for the query. */
224
+ suggestion?: string;
225
+ }
226
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion {
227
+ /** The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. */
228
+ completableFieldPaths?: string[];
229
+ /** The name of the dataStore that this suggestion belongs to. */
230
+ dataStore?: string[];
231
+ /** The suggestion for the query. */
232
+ suggestion?: string;
233
+ }
234
+ interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion {
235
+ /** The time when this recent rearch happened. */
236
+ recentSearchTime?: string;
237
+ /** The suggestion for the query. */
238
+ suggestion?: string;
239
+ }
156
240
  interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
157
241
  /** If set true, automatic refresh is disabled for the DataStore. */
158
242
  disableAutomaticRefresh?: boolean;
@@ -214,6 +298,8 @@ declare namespace gapi.client {
214
298
  answerGenerationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
215
299
  /** 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. */
216
300
  asynchronousMode?: boolean;
301
+ /** Optional. Grounding specification. */
302
+ groundingSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec;
217
303
  /** Required. Current user query. */
218
304
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
219
305
  /** Query understanding specification. */
@@ -257,6 +343,12 @@ declare namespace gapi.client {
257
343
  /** Customized preamble. */
258
344
  preamble?: string;
259
345
  }
346
+ interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec {
347
+ /** Optional. Specifies whether to enable the filtering based on grounding score and at what level. */
348
+ filteringLevel?: string;
349
+ /** 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. */
350
+ includeGroundingSupports?: boolean;
351
+ }
260
352
  interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec {
261
353
  /** Query classification specification. */
262
354
  queryClassificationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
@@ -864,6 +956,10 @@ declare namespace gapi.client {
864
956
  /** Search Results. */
865
957
  searchResults?: GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
866
958
  }
959
+ interface GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries {
960
+ /** The QPS of the crawl rate. */
961
+ qpsTimeSeries?: GoogleMonitoringV3TimeSeries;
962
+ }
867
963
  interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
868
964
  /** Operation create time. */
869
965
  createTime?: string;
@@ -981,6 +1077,12 @@ declare namespace gapi.client {
981
1077
  /** If set true, the DataStore will not be available for serving search requests. */
982
1078
  disabledForServing?: boolean;
983
1079
  }
1080
+ interface GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries {
1081
+ /** Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. */
1082
+ autoRefreshCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
1083
+ /** Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */
1084
+ userTriggeredCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
1085
+ }
984
1086
  interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
985
1087
  /** Operation create time. */
986
1088
  createTime?: string;
@@ -1672,6 +1774,22 @@ declare namespace gapi.client {
1672
1774
  /** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
1673
1775
  mode?: string;
1674
1776
  }
1777
+ interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse {
1778
+ /** The historical dedicated crawl rate timeseries data, used for monitoring. */
1779
+ dedicatedCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries;
1780
+ /** Errors from service when handling the request. */
1781
+ error?: GoogleRpcStatus;
1782
+ /** The historical organic crawl rate timeseries data, used for monitoring. */
1783
+ organicCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries;
1784
+ /** Output only. The state of the response. */
1785
+ state?: string;
1786
+ }
1787
+ interface GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries {
1788
+ /** Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. */
1789
+ googleOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
1790
+ /** Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. */
1791
+ vertexAiOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
1792
+ }
1675
1793
  interface GoogleCloudDiscoveryengineV1alphaPageInfo {
1676
1794
  /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1677
1795
  pageCategory?: string;
@@ -2786,7 +2904,7 @@ declare namespace gapi.client {
2786
2904
  engine?: string;
2787
2905
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
2788
2906
  eventTime?: string;
2789
- /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
2907
+ /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
2790
2908
  eventType?: string;
2791
2909
  /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2792
2910
  filter?: string;
@@ -4243,6 +4361,36 @@ declare namespace gapi.client {
4243
4361
  /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
4244
4362
  response?: {[P in string]: any};
4245
4363
  }
4364
+ interface GoogleMonitoringV3Point {
4365
+ /** The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. */
4366
+ interval?: GoogleMonitoringV3TimeInterval;
4367
+ /** The value of the data point. */
4368
+ value?: GoogleMonitoringV3TypedValue;
4369
+ }
4370
+ interface GoogleMonitoringV3TimeInterval {
4371
+ /** Required. The end of the time interval. */
4372
+ endTime?: string;
4373
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
4374
+ startTime?: string;
4375
+ }
4376
+ interface GoogleMonitoringV3TimeSeries {
4377
+ /** Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. */
4378
+ description?: string;
4379
+ /** Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. */
4380
+ metadata?: GoogleApiMonitoredResourceMetadata;
4381
+ /** The associated metric. A fully-specified metric used to identify the time series. */
4382
+ metric?: GoogleApiMetric;
4383
+ /** The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`. */
4384
+ metricKind?: string;
4385
+ /** The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`. */
4386
+ points?: GoogleMonitoringV3Point[];
4387
+ /** The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources). */
4388
+ resource?: GoogleApiMonitoredResource;
4389
+ /** The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty. */
4390
+ unit?: string;
4391
+ /** The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field. */
4392
+ valueType?: string;
4393
+ }
4246
4394
  interface GoogleMonitoringV3TypedValue {
4247
4395
  /** A Boolean value: `true` or `false`. */
4248
4396
  boolValue?: boolean;
@@ -5043,6 +5191,66 @@ declare namespace gapi.client {
5043
5191
  documents: DocumentsResource;
5044
5192
  operations: OperationsResource;
5045
5193
  }
5194
+ interface CompletionConfigResource {
5195
+ /** Completes the user input with advanced keyword suggestions. */
5196
+ completeQuery(request: {
5197
+ /** V1 error format. */
5198
+ '$.xgafv'?: string;
5199
+ /** OAuth access token. */
5200
+ access_token?: string;
5201
+ /** Data format for response. */
5202
+ alt?: string;
5203
+ /** JSONP */
5204
+ callback?: string;
5205
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
5206
+ completionConfig: string;
5207
+ /** Selector specifying which fields to include in a partial response. */
5208
+ fields?: string;
5209
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5210
+ key?: string;
5211
+ /** OAuth 2.0 token for the current user. */
5212
+ oauth_token?: string;
5213
+ /** Returns response with indentations and line breaks. */
5214
+ prettyPrint?: boolean;
5215
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5216
+ quotaUser?: string;
5217
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5218
+ upload_protocol?: string;
5219
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5220
+ uploadType?: string;
5221
+ /** Request body */
5222
+ resource: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest;
5223
+ }): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
5224
+ completeQuery(
5225
+ request: {
5226
+ /** V1 error format. */
5227
+ '$.xgafv'?: string;
5228
+ /** OAuth access token. */
5229
+ access_token?: string;
5230
+ /** Data format for response. */
5231
+ alt?: string;
5232
+ /** JSONP */
5233
+ callback?: string;
5234
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
5235
+ completionConfig: string;
5236
+ /** Selector specifying which fields to include in a partial response. */
5237
+ fields?: string;
5238
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5239
+ key?: string;
5240
+ /** OAuth 2.0 token for the current user. */
5241
+ oauth_token?: string;
5242
+ /** Returns response with indentations and line breaks. */
5243
+ prettyPrint?: boolean;
5244
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5245
+ quotaUser?: string;
5246
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5247
+ upload_protocol?: string;
5248
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5249
+ uploadType?: string;
5250
+ },
5251
+ body: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest
5252
+ ): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
5253
+ }
5046
5254
  interface CompletionSuggestionsResource {
5047
5255
  /** Imports CompletionSuggestions for a DataStore. */
5048
5256
  import(request: {
@@ -6368,6 +6576,64 @@ declare namespace gapi.client {
6368
6576
  },
6369
6577
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
6370
6578
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6579
+ /** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
6580
+ searchLite(request: {
6581
+ /** V1 error format. */
6582
+ '$.xgafv'?: string;
6583
+ /** OAuth access token. */
6584
+ access_token?: string;
6585
+ /** Data format for response. */
6586
+ alt?: string;
6587
+ /** JSONP */
6588
+ callback?: string;
6589
+ /** Selector specifying which fields to include in a partial response. */
6590
+ fields?: string;
6591
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
6592
+ key?: string;
6593
+ /** OAuth 2.0 token for the current user. */
6594
+ oauth_token?: string;
6595
+ /** Returns response with indentations and line breaks. */
6596
+ prettyPrint?: boolean;
6597
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
6598
+ quotaUser?: string;
6599
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
6600
+ servingConfig: string;
6601
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6602
+ upload_protocol?: string;
6603
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6604
+ uploadType?: string;
6605
+ /** Request body */
6606
+ resource: GoogleCloudDiscoveryengineV1alphaSearchRequest;
6607
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6608
+ searchLite(
6609
+ request: {
6610
+ /** V1 error format. */
6611
+ '$.xgafv'?: string;
6612
+ /** OAuth access token. */
6613
+ access_token?: string;
6614
+ /** Data format for response. */
6615
+ alt?: string;
6616
+ /** JSONP */
6617
+ callback?: string;
6618
+ /** Selector specifying which fields to include in a partial response. */
6619
+ fields?: string;
6620
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
6621
+ key?: string;
6622
+ /** OAuth 2.0 token for the current user. */
6623
+ oauth_token?: string;
6624
+ /** Returns response with indentations and line breaks. */
6625
+ prettyPrint?: boolean;
6626
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
6627
+ quotaUser?: string;
6628
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
6629
+ servingConfig: string;
6630
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6631
+ upload_protocol?: string;
6632
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6633
+ uploadType?: string;
6634
+ },
6635
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest
6636
+ ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6371
6637
  }
6372
6638
  interface AnswersResource {
6373
6639
  /** Gets a Answer. */
@@ -8117,6 +8383,7 @@ declare namespace gapi.client {
8117
8383
  body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
8118
8384
  ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
8119
8385
  branches: BranchesResource;
8386
+ completionConfig: CompletionConfigResource;
8120
8387
  completionSuggestions: CompletionSuggestionsResource;
8121
8388
  controls: ControlsResource;
8122
8389
  conversations: ConversationsResource;
@@ -8130,6 +8397,66 @@ declare namespace gapi.client {
8130
8397
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
8131
8398
  userEvents: UserEventsResource;
8132
8399
  }
8400
+ interface CompletionConfigResource {
8401
+ /** Completes the user input with advanced keyword suggestions. */
8402
+ completeQuery(request: {
8403
+ /** V1 error format. */
8404
+ '$.xgafv'?: string;
8405
+ /** OAuth access token. */
8406
+ access_token?: string;
8407
+ /** Data format for response. */
8408
+ alt?: string;
8409
+ /** JSONP */
8410
+ callback?: string;
8411
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
8412
+ completionConfig: string;
8413
+ /** Selector specifying which fields to include in a partial response. */
8414
+ fields?: string;
8415
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
8416
+ key?: string;
8417
+ /** OAuth 2.0 token for the current user. */
8418
+ oauth_token?: string;
8419
+ /** Returns response with indentations and line breaks. */
8420
+ prettyPrint?: boolean;
8421
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
8422
+ quotaUser?: string;
8423
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8424
+ upload_protocol?: string;
8425
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8426
+ uploadType?: string;
8427
+ /** Request body */
8428
+ resource: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest;
8429
+ }): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
8430
+ completeQuery(
8431
+ request: {
8432
+ /** V1 error format. */
8433
+ '$.xgafv'?: string;
8434
+ /** OAuth access token. */
8435
+ access_token?: string;
8436
+ /** Data format for response. */
8437
+ alt?: string;
8438
+ /** JSONP */
8439
+ callback?: string;
8440
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
8441
+ completionConfig: string;
8442
+ /** Selector specifying which fields to include in a partial response. */
8443
+ fields?: string;
8444
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
8445
+ key?: string;
8446
+ /** OAuth 2.0 token for the current user. */
8447
+ oauth_token?: string;
8448
+ /** Returns response with indentations and line breaks. */
8449
+ prettyPrint?: boolean;
8450
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
8451
+ quotaUser?: string;
8452
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8453
+ upload_protocol?: string;
8454
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8455
+ uploadType?: string;
8456
+ },
8457
+ body: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest
8458
+ ): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
8459
+ }
8133
8460
  interface ControlsResource {
8134
8461
  /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
8135
8462
  create(request: {
@@ -8969,6 +9296,64 @@ declare namespace gapi.client {
8969
9296
  },
8970
9297
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
8971
9298
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
9299
+ /** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
9300
+ searchLite(request: {
9301
+ /** V1 error format. */
9302
+ '$.xgafv'?: string;
9303
+ /** OAuth access token. */
9304
+ access_token?: string;
9305
+ /** Data format for response. */
9306
+ alt?: string;
9307
+ /** JSONP */
9308
+ callback?: string;
9309
+ /** Selector specifying which fields to include in a partial response. */
9310
+ fields?: string;
9311
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
9312
+ key?: string;
9313
+ /** OAuth 2.0 token for the current user. */
9314
+ oauth_token?: string;
9315
+ /** Returns response with indentations and line breaks. */
9316
+ prettyPrint?: boolean;
9317
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
9318
+ quotaUser?: string;
9319
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
9320
+ servingConfig: string;
9321
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9322
+ upload_protocol?: string;
9323
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9324
+ uploadType?: string;
9325
+ /** Request body */
9326
+ resource: GoogleCloudDiscoveryengineV1alphaSearchRequest;
9327
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
9328
+ searchLite(
9329
+ request: {
9330
+ /** V1 error format. */
9331
+ '$.xgafv'?: string;
9332
+ /** OAuth access token. */
9333
+ access_token?: string;
9334
+ /** Data format for response. */
9335
+ alt?: string;
9336
+ /** JSONP */
9337
+ callback?: string;
9338
+ /** Selector specifying which fields to include in a partial response. */
9339
+ fields?: string;
9340
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
9341
+ key?: string;
9342
+ /** OAuth 2.0 token for the current user. */
9343
+ oauth_token?: string;
9344
+ /** Returns response with indentations and line breaks. */
9345
+ prettyPrint?: boolean;
9346
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
9347
+ quotaUser?: string;
9348
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
9349
+ servingConfig: string;
9350
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9351
+ upload_protocol?: string;
9352
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9353
+ uploadType?: string;
9354
+ },
9355
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest
9356
+ ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8972
9357
  }
8973
9358
  interface AnswersResource {
8974
9359
  /** Gets a Answer. */
@@ -9597,6 +9982,7 @@ declare namespace gapi.client {
9597
9982
  },
9598
9983
  body: GoogleCloudDiscoveryengineV1alphaTuneEngineRequest
9599
9984
  ): Request<GoogleLongrunningOperation>;
9985
+ completionConfig: CompletionConfigResource;
9600
9986
  controls: ControlsResource;
9601
9987
  conversations: ConversationsResource;
9602
9988
  operations: OperationsResource;
@@ -10249,6 +10635,66 @@ declare namespace gapi.client {
10249
10635
  documents: DocumentsResource;
10250
10636
  operations: OperationsResource;
10251
10637
  }
10638
+ interface CompletionConfigResource {
10639
+ /** Completes the user input with advanced keyword suggestions. */
10640
+ completeQuery(request: {
10641
+ /** V1 error format. */
10642
+ '$.xgafv'?: string;
10643
+ /** OAuth access token. */
10644
+ access_token?: string;
10645
+ /** Data format for response. */
10646
+ alt?: string;
10647
+ /** JSONP */
10648
+ callback?: string;
10649
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
10650
+ completionConfig: string;
10651
+ /** Selector specifying which fields to include in a partial response. */
10652
+ fields?: string;
10653
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
10654
+ key?: string;
10655
+ /** OAuth 2.0 token for the current user. */
10656
+ oauth_token?: string;
10657
+ /** Returns response with indentations and line breaks. */
10658
+ prettyPrint?: boolean;
10659
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
10660
+ quotaUser?: string;
10661
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10662
+ upload_protocol?: string;
10663
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10664
+ uploadType?: string;
10665
+ /** Request body */
10666
+ resource: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest;
10667
+ }): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
10668
+ completeQuery(
10669
+ request: {
10670
+ /** V1 error format. */
10671
+ '$.xgafv'?: string;
10672
+ /** OAuth access token. */
10673
+ access_token?: string;
10674
+ /** Data format for response. */
10675
+ alt?: string;
10676
+ /** JSONP */
10677
+ callback?: string;
10678
+ /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
10679
+ completionConfig: string;
10680
+ /** Selector specifying which fields to include in a partial response. */
10681
+ fields?: string;
10682
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
10683
+ key?: string;
10684
+ /** OAuth 2.0 token for the current user. */
10685
+ oauth_token?: string;
10686
+ /** Returns response with indentations and line breaks. */
10687
+ prettyPrint?: boolean;
10688
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
10689
+ quotaUser?: string;
10690
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10691
+ upload_protocol?: string;
10692
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10693
+ uploadType?: string;
10694
+ },
10695
+ body: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest
10696
+ ): Request<GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse>;
10697
+ }
10252
10698
  interface CompletionSuggestionsResource {
10253
10699
  /** Imports CompletionSuggestions for a DataStore. */
10254
10700
  import(request: {
@@ -11482,6 +11928,64 @@ declare namespace gapi.client {
11482
11928
  },
11483
11929
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
11484
11930
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
11931
+ /** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
11932
+ searchLite(request: {
11933
+ /** V1 error format. */
11934
+ '$.xgafv'?: string;
11935
+ /** OAuth access token. */
11936
+ access_token?: string;
11937
+ /** Data format for response. */
11938
+ alt?: string;
11939
+ /** JSONP */
11940
+ callback?: string;
11941
+ /** Selector specifying which fields to include in a partial response. */
11942
+ fields?: string;
11943
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
11944
+ key?: string;
11945
+ /** OAuth 2.0 token for the current user. */
11946
+ oauth_token?: string;
11947
+ /** Returns response with indentations and line breaks. */
11948
+ prettyPrint?: boolean;
11949
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
11950
+ quotaUser?: string;
11951
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
11952
+ servingConfig: string;
11953
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11954
+ upload_protocol?: string;
11955
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11956
+ uploadType?: string;
11957
+ /** Request body */
11958
+ resource: GoogleCloudDiscoveryengineV1alphaSearchRequest;
11959
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
11960
+ searchLite(
11961
+ request: {
11962
+ /** V1 error format. */
11963
+ '$.xgafv'?: string;
11964
+ /** OAuth access token. */
11965
+ access_token?: string;
11966
+ /** Data format for response. */
11967
+ alt?: string;
11968
+ /** JSONP */
11969
+ callback?: string;
11970
+ /** Selector specifying which fields to include in a partial response. */
11971
+ fields?: string;
11972
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
11973
+ key?: string;
11974
+ /** OAuth 2.0 token for the current user. */
11975
+ oauth_token?: string;
11976
+ /** Returns response with indentations and line breaks. */
11977
+ prettyPrint?: boolean;
11978
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
11979
+ quotaUser?: string;
11980
+ /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
11981
+ servingConfig: string;
11982
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11983
+ upload_protocol?: string;
11984
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11985
+ uploadType?: string;
11986
+ },
11987
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest
11988
+ ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
11485
11989
  }
11486
11990
  interface AnswersResource {
11487
11991
  /** Gets a Answer. */
@@ -12873,6 +13377,7 @@ declare namespace gapi.client {
12873
13377
  body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
12874
13378
  ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
12875
13379
  branches: BranchesResource;
13380
+ completionConfig: CompletionConfigResource;
12876
13381
  completionSuggestions: CompletionSuggestionsResource;
12877
13382
  controls: ControlsResource;
12878
13383
  conversations: ConversationsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20241020",
3
+ "version": "0.0.20241025",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",