@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.1.20251203 → 0.1.20251209
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.
- package/index.d.ts +94 -4
- 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:
|
|
12
|
+
// Revision: 20251209
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -376,6 +376,8 @@ declare namespace gapi.client {
|
|
|
376
376
|
icon?: GoogleCloudDiscoveryengineV1alphaAgentImage;
|
|
377
377
|
/** Optional. The code of the language of the text in the description, display_name and starter_prompts fields. */
|
|
378
378
|
languageCode?: string;
|
|
379
|
+
/** Optional. The behavior of the Google managed agent. */
|
|
380
|
+
managedAgentDefinition?: any;
|
|
379
381
|
/** Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
|
|
380
382
|
name?: string;
|
|
381
383
|
/** Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection. */
|
|
@@ -3188,6 +3190,7 @@ declare namespace gapi.client {
|
|
|
3188
3190
|
/** All the customer's UserLicenses. */
|
|
3189
3191
|
userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
|
|
3190
3192
|
}
|
|
3193
|
+
interface GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition {}
|
|
3191
3194
|
interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
|
|
3192
3195
|
/** The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */
|
|
3193
3196
|
mediaProgressDuration?: string;
|
|
@@ -3817,7 +3820,7 @@ declare namespace gapi.client {
|
|
|
3817
3820
|
oneBoxPageSize?: number;
|
|
3818
3821
|
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
3819
3822
|
orderBy?: string;
|
|
3820
|
-
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
3823
|
+
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
3821
3824
|
pageCategories?: string[];
|
|
3822
3825
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
3823
3826
|
pageSize?: number;
|
|
@@ -4745,7 +4748,7 @@ declare namespace gapi.client {
|
|
|
4745
4748
|
eventTime?: string;
|
|
4746
4749
|
/** 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. Custom conversion value: * `conversion`: Customer defined conversion event. */
|
|
4747
4750
|
eventType?: string;
|
|
4748
|
-
/** 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. */
|
|
4751
|
+
/** Optional. 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. */
|
|
4749
4752
|
filter?: string;
|
|
4750
4753
|
/** Media-specific info. */
|
|
4751
4754
|
mediaInfo?: GoogleCloudDiscoveryengineV1alphaMediaInfo;
|
|
@@ -6048,7 +6051,7 @@ declare namespace gapi.client {
|
|
|
6048
6051
|
oneBoxPageSize?: number;
|
|
6049
6052
|
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
6050
6053
|
orderBy?: string;
|
|
6051
|
-
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
6054
|
+
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
6052
6055
|
pageCategories?: string[];
|
|
6053
6056
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
6054
6057
|
pageSize?: number;
|
|
@@ -6755,6 +6758,8 @@ declare namespace gapi.client {
|
|
|
6755
6758
|
kmsKeyName?: string;
|
|
6756
6759
|
/** Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
6757
6760
|
name?: string;
|
|
6761
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
6762
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
6758
6763
|
/** Optional. Stores serving config at DataStore level. */
|
|
6759
6764
|
servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
|
|
6760
6765
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
@@ -7147,6 +7152,10 @@ declare namespace gapi.client {
|
|
|
7147
7152
|
/** Required. Subscription tier information for the license config. */
|
|
7148
7153
|
subscriptionTier?: string;
|
|
7149
7154
|
}
|
|
7155
|
+
interface GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
|
|
7156
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
7157
|
+
mode?: string;
|
|
7158
|
+
}
|
|
7150
7159
|
interface GoogleCloudDiscoveryengineV1Project {
|
|
7151
7160
|
/** Output only. The current status of the project's configurable billing. */
|
|
7152
7161
|
configurableBillingStatus?: GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
|
|
@@ -10512,6 +10521,33 @@ declare namespace gapi.client {
|
|
|
10512
10521
|
},
|
|
10513
10522
|
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest,
|
|
10514
10523
|
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
10524
|
+
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
10525
|
+
delete(request?: {
|
|
10526
|
+
/** V1 error format. */
|
|
10527
|
+
'$.xgafv'?: string;
|
|
10528
|
+
/** OAuth access token. */
|
|
10529
|
+
access_token?: string;
|
|
10530
|
+
/** Data format for response. */
|
|
10531
|
+
alt?: string;
|
|
10532
|
+
/** JSONP */
|
|
10533
|
+
callback?: string;
|
|
10534
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10535
|
+
fields?: string;
|
|
10536
|
+
/** 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. */
|
|
10537
|
+
key?: string;
|
|
10538
|
+
/** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
10539
|
+
name: string;
|
|
10540
|
+
/** OAuth 2.0 token for the current user. */
|
|
10541
|
+
oauth_token?: string;
|
|
10542
|
+
/** Returns response with indentations and line breaks. */
|
|
10543
|
+
prettyPrint?: boolean;
|
|
10544
|
+
/** 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. */
|
|
10545
|
+
quotaUser?: string;
|
|
10546
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10547
|
+
upload_protocol?: string;
|
|
10548
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10549
|
+
uploadType?: string;
|
|
10550
|
+
}): Request<{}>;
|
|
10515
10551
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
10516
10552
|
get(request?: {
|
|
10517
10553
|
/** V1 error format. */
|
|
@@ -14631,6 +14667,33 @@ declare namespace gapi.client {
|
|
|
14631
14667
|
},
|
|
14632
14668
|
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest,
|
|
14633
14669
|
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
14670
|
+
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
14671
|
+
delete(request?: {
|
|
14672
|
+
/** V1 error format. */
|
|
14673
|
+
'$.xgafv'?: string;
|
|
14674
|
+
/** OAuth access token. */
|
|
14675
|
+
access_token?: string;
|
|
14676
|
+
/** Data format for response. */
|
|
14677
|
+
alt?: string;
|
|
14678
|
+
/** JSONP */
|
|
14679
|
+
callback?: string;
|
|
14680
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
14681
|
+
fields?: string;
|
|
14682
|
+
/** 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. */
|
|
14683
|
+
key?: string;
|
|
14684
|
+
/** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
14685
|
+
name: string;
|
|
14686
|
+
/** OAuth 2.0 token for the current user. */
|
|
14687
|
+
oauth_token?: string;
|
|
14688
|
+
/** Returns response with indentations and line breaks. */
|
|
14689
|
+
prettyPrint?: boolean;
|
|
14690
|
+
/** 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. */
|
|
14691
|
+
quotaUser?: string;
|
|
14692
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14693
|
+
upload_protocol?: string;
|
|
14694
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14695
|
+
uploadType?: string;
|
|
14696
|
+
}): Request<{}>;
|
|
14634
14697
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
14635
14698
|
get(request?: {
|
|
14636
14699
|
/** V1 error format. */
|
|
@@ -17855,6 +17918,33 @@ declare namespace gapi.client {
|
|
|
17855
17918
|
},
|
|
17856
17919
|
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest,
|
|
17857
17920
|
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
17921
|
+
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
17922
|
+
delete(request?: {
|
|
17923
|
+
/** V1 error format. */
|
|
17924
|
+
'$.xgafv'?: string;
|
|
17925
|
+
/** OAuth access token. */
|
|
17926
|
+
access_token?: string;
|
|
17927
|
+
/** Data format for response. */
|
|
17928
|
+
alt?: string;
|
|
17929
|
+
/** JSONP */
|
|
17930
|
+
callback?: string;
|
|
17931
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
17932
|
+
fields?: string;
|
|
17933
|
+
/** 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. */
|
|
17934
|
+
key?: string;
|
|
17935
|
+
/** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
17936
|
+
name: string;
|
|
17937
|
+
/** OAuth 2.0 token for the current user. */
|
|
17938
|
+
oauth_token?: string;
|
|
17939
|
+
/** Returns response with indentations and line breaks. */
|
|
17940
|
+
prettyPrint?: boolean;
|
|
17941
|
+
/** 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. */
|
|
17942
|
+
quotaUser?: string;
|
|
17943
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17944
|
+
upload_protocol?: string;
|
|
17945
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17946
|
+
uploadType?: string;
|
|
17947
|
+
}): Request<{}>;
|
|
17858
17948
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
17859
17949
|
get(request?: {
|
|
17860
17950
|
/** V1 error format. */
|