@googleapis/discoveryengine 27.0.0 → 27.1.0
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/CHANGELOG.md +8 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +1600 -118
- package/build/v1.js +271 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +1039 -28
- package/build/v1alpha.js +274 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +156 -2
- package/build/v1beta.js +43 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +2387 -266
- package/v1alpha.ts +1779 -65
- package/v1beta.ts +247 -2
package/build/v1.d.ts
CHANGED
|
@@ -3122,6 +3122,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3122
3122
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
3123
3123
|
*/
|
|
3124
3124
|
enableImageAnnotation?: boolean | null;
|
|
3125
|
+
/**
|
|
3126
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
3127
|
+
*/
|
|
3128
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
3125
3129
|
/**
|
|
3126
3130
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
3127
3131
|
*/
|
|
@@ -3190,6 +3194,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3190
3194
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3191
3195
|
*/
|
|
3192
3196
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
|
|
3197
|
+
/**
|
|
3198
|
+
* Output only. CMEK-related information for the Engine.
|
|
3199
|
+
*/
|
|
3200
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
3193
3201
|
/**
|
|
3194
3202
|
* Common config spec that specifies the metadata of the engine.
|
|
3195
3203
|
*/
|
|
@@ -3228,6 +3236,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
3228
3236
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
3229
3237
|
*/
|
|
3230
3238
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
3239
|
+
/**
|
|
3240
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
3241
|
+
*/
|
|
3242
|
+
modelConfigs?: {
|
|
3243
|
+
[key: string]: string;
|
|
3244
|
+
} | null;
|
|
3231
3245
|
/**
|
|
3232
3246
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3233
3247
|
*/
|
|
@@ -7663,6 +7677,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7663
7677
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
7664
7678
|
*/
|
|
7665
7679
|
enableImageAnnotation?: boolean | null;
|
|
7680
|
+
/**
|
|
7681
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
7682
|
+
*/
|
|
7683
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
7666
7684
|
/**
|
|
7667
7685
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
7668
7686
|
*/
|
|
@@ -7731,6 +7749,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7731
7749
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
7732
7750
|
*/
|
|
7733
7751
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
7752
|
+
/**
|
|
7753
|
+
* Output only. CMEK-related information for the Engine.
|
|
7754
|
+
*/
|
|
7755
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
|
|
7734
7756
|
/**
|
|
7735
7757
|
* Common config spec that specifies the metadata of the engine.
|
|
7736
7758
|
*/
|
|
@@ -7769,6 +7791,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
7769
7791
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
7770
7792
|
*/
|
|
7771
7793
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
7794
|
+
/**
|
|
7795
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
7796
|
+
*/
|
|
7797
|
+
modelConfigs?: {
|
|
7798
|
+
[key: string]: string;
|
|
7799
|
+
} | null;
|
|
7772
7800
|
/**
|
|
7773
7801
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
7774
7802
|
*/
|
|
@@ -11298,6 +11326,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11298
11326
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
11299
11327
|
*/
|
|
11300
11328
|
enableImageAnnotation?: boolean | null;
|
|
11329
|
+
/**
|
|
11330
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
11331
|
+
*/
|
|
11332
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
11301
11333
|
/**
|
|
11302
11334
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
11303
11335
|
*/
|
|
@@ -11380,6 +11412,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11380
11412
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
11381
11413
|
*/
|
|
11382
11414
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
11415
|
+
/**
|
|
11416
|
+
* Output only. CMEK-related information for the Engine.
|
|
11417
|
+
*/
|
|
11418
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
11383
11419
|
/**
|
|
11384
11420
|
* Common config spec that specifies the metadata of the engine.
|
|
11385
11421
|
*/
|
|
@@ -11418,6 +11454,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
11418
11454
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
11419
11455
|
*/
|
|
11420
11456
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
11457
|
+
/**
|
|
11458
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
11459
|
+
*/
|
|
11460
|
+
modelConfigs?: {
|
|
11461
|
+
[key: string]: string;
|
|
11462
|
+
} | null;
|
|
11421
11463
|
/**
|
|
11422
11464
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
11423
11465
|
*/
|
|
@@ -12214,6 +12256,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
12214
12256
|
*/
|
|
12215
12257
|
subscriptionTier?: string | null;
|
|
12216
12258
|
}
|
|
12259
|
+
/**
|
|
12260
|
+
* Stats about users' licenses.
|
|
12261
|
+
*/
|
|
12262
|
+
export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats {
|
|
12263
|
+
/**
|
|
12264
|
+
* Required. The LicenseConfig name.
|
|
12265
|
+
*/
|
|
12266
|
+
licenseConfig?: string | null;
|
|
12267
|
+
/**
|
|
12268
|
+
* Required. The number of licenses used.
|
|
12269
|
+
*/
|
|
12270
|
+
usedLicenseCount?: string | null;
|
|
12271
|
+
}
|
|
12217
12272
|
/**
|
|
12218
12273
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
12219
12274
|
*/
|
|
@@ -12323,6 +12378,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
12323
12378
|
*/
|
|
12324
12379
|
nextPageToken?: string | null;
|
|
12325
12380
|
}
|
|
12381
|
+
/**
|
|
12382
|
+
* Response message for UserLicenseService.ListLicenseConfigUsageStats method.
|
|
12383
|
+
*/
|
|
12384
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
|
|
12385
|
+
/**
|
|
12386
|
+
* All the customer's LicenseConfigUsageStats.
|
|
12387
|
+
*/
|
|
12388
|
+
licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats[];
|
|
12389
|
+
}
|
|
12326
12390
|
/**
|
|
12327
12391
|
* Response message for SchemaService.ListSchemas method.
|
|
12328
12392
|
*/
|
|
@@ -14686,6 +14750,481 @@ export declare namespace discoveryengine_v1 {
|
|
|
14686
14750
|
*/
|
|
14687
14751
|
name?: string | null;
|
|
14688
14752
|
}
|
|
14753
|
+
/**
|
|
14754
|
+
* WidgetConfig captures configs at the Widget level.
|
|
14755
|
+
*/
|
|
14756
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfig {
|
|
14757
|
+
/**
|
|
14758
|
+
* Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
|
|
14759
|
+
*/
|
|
14760
|
+
accessSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings;
|
|
14761
|
+
/**
|
|
14762
|
+
* Allowlisted domains that can load this widget.
|
|
14763
|
+
*/
|
|
14764
|
+
allowlistedDomains?: string[] | null;
|
|
14765
|
+
/**
|
|
14766
|
+
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
14767
|
+
*/
|
|
14768
|
+
allowPublicAccess?: boolean | null;
|
|
14769
|
+
/**
|
|
14770
|
+
* Optional. Output only. Describes the assistant settings of the widget.
|
|
14771
|
+
*/
|
|
14772
|
+
assistantSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings;
|
|
14773
|
+
/**
|
|
14774
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
|
|
14775
|
+
*/
|
|
14776
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent[];
|
|
14777
|
+
/**
|
|
14778
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
14779
|
+
*/
|
|
14780
|
+
configId?: string | null;
|
|
14781
|
+
/**
|
|
14782
|
+
* The content search spec that configs the desired behavior of content search.
|
|
14783
|
+
*/
|
|
14784
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
14785
|
+
/**
|
|
14786
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
14787
|
+
*/
|
|
14788
|
+
createTime?: string | null;
|
|
14789
|
+
/**
|
|
14790
|
+
* Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
|
|
14791
|
+
*/
|
|
14792
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig;
|
|
14793
|
+
/**
|
|
14794
|
+
* Output only. The type of the parent data store.
|
|
14795
|
+
*/
|
|
14796
|
+
dataStoreType?: string | null;
|
|
14797
|
+
/**
|
|
14798
|
+
* Configurable UI configurations per data store.
|
|
14799
|
+
*/
|
|
14800
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
14801
|
+
/**
|
|
14802
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
14803
|
+
*/
|
|
14804
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
14805
|
+
/**
|
|
14806
|
+
* Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
14807
|
+
*/
|
|
14808
|
+
displayName?: string | null;
|
|
14809
|
+
/**
|
|
14810
|
+
* Whether or not to enable autocomplete.
|
|
14811
|
+
*/
|
|
14812
|
+
enableAutocomplete?: boolean | null;
|
|
14813
|
+
/**
|
|
14814
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
14815
|
+
*/
|
|
14816
|
+
enableConversationalSearch?: boolean | null;
|
|
14817
|
+
/**
|
|
14818
|
+
* Optional. Output only. Whether to enable private knowledge graph.
|
|
14819
|
+
*/
|
|
14820
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
14821
|
+
/**
|
|
14822
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
14823
|
+
*/
|
|
14824
|
+
enableQualityFeedback?: boolean | null;
|
|
14825
|
+
/**
|
|
14826
|
+
* Whether to show the result score.
|
|
14827
|
+
*/
|
|
14828
|
+
enableResultScore?: boolean | null;
|
|
14829
|
+
/**
|
|
14830
|
+
* Whether to enable safe search.
|
|
14831
|
+
*/
|
|
14832
|
+
enableSafeSearch?: boolean | null;
|
|
14833
|
+
/**
|
|
14834
|
+
* Whether to enable search-as-you-type behavior for the search widget
|
|
14835
|
+
*/
|
|
14836
|
+
enableSearchAsYouType?: boolean | null;
|
|
14837
|
+
/**
|
|
14838
|
+
* Turn on or off summary for each snippets result.
|
|
14839
|
+
*/
|
|
14840
|
+
enableSnippetResultSummary?: boolean | null;
|
|
14841
|
+
/**
|
|
14842
|
+
* Turn on or off summarization for the search response.
|
|
14843
|
+
*/
|
|
14844
|
+
enableSummarization?: boolean | null;
|
|
14845
|
+
/**
|
|
14846
|
+
* Whether to enable standalone web app.
|
|
14847
|
+
*/
|
|
14848
|
+
enableWebApp?: boolean | null;
|
|
14849
|
+
/**
|
|
14850
|
+
* The configuration and appearance of facets in the end user view.
|
|
14851
|
+
*/
|
|
14852
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
14853
|
+
/**
|
|
14854
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
14855
|
+
*/
|
|
14856
|
+
fieldsUiComponentsMap?: {
|
|
14857
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
14858
|
+
} | null;
|
|
14859
|
+
/**
|
|
14860
|
+
* Output only. Whether the subscription is gemini bundle or not.
|
|
14861
|
+
*/
|
|
14862
|
+
geminiBundle?: boolean | null;
|
|
14863
|
+
/**
|
|
14864
|
+
* Optional. Describes the homepage settings of the widget.
|
|
14865
|
+
*/
|
|
14866
|
+
homepageSetting?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting;
|
|
14867
|
+
/**
|
|
14868
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
14869
|
+
*/
|
|
14870
|
+
industryVertical?: string | null;
|
|
14871
|
+
/**
|
|
14872
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
14873
|
+
*/
|
|
14874
|
+
llmEnabled?: boolean | null;
|
|
14875
|
+
/**
|
|
14876
|
+
* Output only. Whether the customer accepted data use terms.
|
|
14877
|
+
*/
|
|
14878
|
+
minimumDataTermAccepted?: boolean | null;
|
|
14879
|
+
/**
|
|
14880
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14881
|
+
*/
|
|
14882
|
+
name?: string | null;
|
|
14883
|
+
/**
|
|
14884
|
+
* The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
|
|
14885
|
+
*/
|
|
14886
|
+
resultDisplayType?: string | null;
|
|
14887
|
+
/**
|
|
14888
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
14889
|
+
*/
|
|
14890
|
+
solutionType?: string | null;
|
|
14891
|
+
/**
|
|
14892
|
+
* Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
|
|
14893
|
+
*/
|
|
14894
|
+
uiBranding?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings;
|
|
14895
|
+
/**
|
|
14896
|
+
* Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
|
|
14897
|
+
*/
|
|
14898
|
+
uiSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings;
|
|
14899
|
+
/**
|
|
14900
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
14901
|
+
*/
|
|
14902
|
+
updateTime?: string | null;
|
|
14903
|
+
}
|
|
14904
|
+
/**
|
|
14905
|
+
* Describes widget access settings.
|
|
14906
|
+
*/
|
|
14907
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings {
|
|
14908
|
+
/**
|
|
14909
|
+
* List of domains that are allowed to integrate the search widget.
|
|
14910
|
+
*/
|
|
14911
|
+
allowlistedDomains?: string[] | null;
|
|
14912
|
+
/**
|
|
14913
|
+
* Whether public unauthenticated access is allowed.
|
|
14914
|
+
*/
|
|
14915
|
+
allowPublicAccess?: boolean | null;
|
|
14916
|
+
/**
|
|
14917
|
+
* Whether web app access is enabled.
|
|
14918
|
+
*/
|
|
14919
|
+
enableWebApp?: boolean | null;
|
|
14920
|
+
/**
|
|
14921
|
+
* Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
|
|
14922
|
+
*/
|
|
14923
|
+
languageCode?: string | null;
|
|
14924
|
+
/**
|
|
14925
|
+
* Optional. The workforce identity pool provider used to access the widget.
|
|
14926
|
+
*/
|
|
14927
|
+
workforceIdentityPoolProvider?: string | null;
|
|
14928
|
+
}
|
|
14929
|
+
/**
|
|
14930
|
+
* Describes the assistant settings of the widget.
|
|
14931
|
+
*/
|
|
14932
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings {
|
|
14933
|
+
/**
|
|
14934
|
+
* Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
|
|
14935
|
+
*/
|
|
14936
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
14937
|
+
/**
|
|
14938
|
+
* Optional. Output only. Whether to disable user location context.
|
|
14939
|
+
*/
|
|
14940
|
+
disableLocationContext?: boolean | null;
|
|
14941
|
+
/**
|
|
14942
|
+
* Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
|
|
14943
|
+
*/
|
|
14944
|
+
googleSearchGroundingEnabled?: boolean | null;
|
|
14945
|
+
/**
|
|
14946
|
+
* Optional. The type of web grounding to use.
|
|
14947
|
+
*/
|
|
14948
|
+
webGroundingType?: string | null;
|
|
14949
|
+
}
|
|
14950
|
+
/**
|
|
14951
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
14952
|
+
*/
|
|
14953
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent {
|
|
14954
|
+
/**
|
|
14955
|
+
* Output only. The icon link of the connector source.
|
|
14956
|
+
*/
|
|
14957
|
+
connectorIconLink?: string | null;
|
|
14958
|
+
/**
|
|
14959
|
+
* The name of the data source, retrieved from `Collection.data_connector.data_source`.
|
|
14960
|
+
*/
|
|
14961
|
+
dataSource?: string | null;
|
|
14962
|
+
/**
|
|
14963
|
+
* Output only. The display name of the data source.
|
|
14964
|
+
*/
|
|
14965
|
+
dataSourceDisplayName?: string | null;
|
|
14966
|
+
/**
|
|
14967
|
+
* For the data store collection, list of the children data stores.
|
|
14968
|
+
*/
|
|
14969
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent[];
|
|
14970
|
+
/**
|
|
14971
|
+
* The display name of the collection.
|
|
14972
|
+
*/
|
|
14973
|
+
displayName?: string | null;
|
|
14974
|
+
/**
|
|
14975
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
14976
|
+
*/
|
|
14977
|
+
id?: string | null;
|
|
14978
|
+
/**
|
|
14979
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
14980
|
+
*/
|
|
14981
|
+
name?: string | null;
|
|
14982
|
+
}
|
|
14983
|
+
/**
|
|
14984
|
+
* Customer provided configurations.
|
|
14985
|
+
*/
|
|
14986
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig {
|
|
14987
|
+
/**
|
|
14988
|
+
* Customer type.
|
|
14989
|
+
*/
|
|
14990
|
+
customerType?: string | null;
|
|
14991
|
+
}
|
|
14992
|
+
/**
|
|
14993
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
14994
|
+
*/
|
|
14995
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent {
|
|
14996
|
+
/**
|
|
14997
|
+
* Output only. The type of the data store config.
|
|
14998
|
+
*/
|
|
14999
|
+
dataStoreConfigType?: string | null;
|
|
15000
|
+
/**
|
|
15001
|
+
* The display name of the data store.
|
|
15002
|
+
*/
|
|
15003
|
+
displayName?: string | null;
|
|
15004
|
+
/**
|
|
15005
|
+
* The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
|
|
15006
|
+
*/
|
|
15007
|
+
entityName?: string | null;
|
|
15008
|
+
/**
|
|
15009
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
15010
|
+
*/
|
|
15011
|
+
id?: string | null;
|
|
15012
|
+
/**
|
|
15013
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
15014
|
+
*/
|
|
15015
|
+
name?: string | null;
|
|
15016
|
+
}
|
|
15017
|
+
/**
|
|
15018
|
+
* UI component configuration for data store.
|
|
15019
|
+
*/
|
|
15020
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig {
|
|
15021
|
+
/**
|
|
15022
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
15023
|
+
*/
|
|
15024
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
15025
|
+
/**
|
|
15026
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
15027
|
+
*/
|
|
15028
|
+
fieldsUiComponentsMap?: {
|
|
15029
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
15030
|
+
} | null;
|
|
15031
|
+
/**
|
|
15032
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
15033
|
+
*/
|
|
15034
|
+
id?: string | null;
|
|
15035
|
+
/**
|
|
15036
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
15037
|
+
*/
|
|
15038
|
+
name?: string | null;
|
|
15039
|
+
}
|
|
15040
|
+
/**
|
|
15041
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
15042
|
+
*/
|
|
15043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField {
|
|
15044
|
+
/**
|
|
15045
|
+
* Optional. The field name that end users will see.
|
|
15046
|
+
*/
|
|
15047
|
+
displayName?: string | null;
|
|
15048
|
+
/**
|
|
15049
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
15050
|
+
*/
|
|
15051
|
+
field?: string | null;
|
|
15052
|
+
}
|
|
15053
|
+
/**
|
|
15054
|
+
* Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
|
|
15055
|
+
*/
|
|
15056
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting {
|
|
15057
|
+
/**
|
|
15058
|
+
* Optional. The shortcuts to display on the homepage.
|
|
15059
|
+
*/
|
|
15060
|
+
shortcuts?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut[];
|
|
15061
|
+
}
|
|
15062
|
+
/**
|
|
15063
|
+
* Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
|
|
15064
|
+
*/
|
|
15065
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut {
|
|
15066
|
+
/**
|
|
15067
|
+
* Optional. Destination URL of shortcut.
|
|
15068
|
+
*/
|
|
15069
|
+
destinationUri?: string | null;
|
|
15070
|
+
/**
|
|
15071
|
+
* Optional. Icon URL of shortcut.
|
|
15072
|
+
*/
|
|
15073
|
+
icon?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
15074
|
+
/**
|
|
15075
|
+
* Optional. Title of the shortcut.
|
|
15076
|
+
*/
|
|
15077
|
+
title?: string | null;
|
|
15078
|
+
}
|
|
15079
|
+
/**
|
|
15080
|
+
* Options to store an image.
|
|
15081
|
+
*/
|
|
15082
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage {
|
|
15083
|
+
/**
|
|
15084
|
+
* Image URL.
|
|
15085
|
+
*/
|
|
15086
|
+
url?: string | null;
|
|
15087
|
+
}
|
|
15088
|
+
/**
|
|
15089
|
+
* Describes widget UI branding settings.
|
|
15090
|
+
*/
|
|
15091
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings {
|
|
15092
|
+
/**
|
|
15093
|
+
* Logo image.
|
|
15094
|
+
*/
|
|
15095
|
+
logo?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
15096
|
+
}
|
|
15097
|
+
/**
|
|
15098
|
+
* Facet field that maps to a UI Component.
|
|
15099
|
+
*/
|
|
15100
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
|
|
15101
|
+
/**
|
|
15102
|
+
* The field visibility on different types of devices.
|
|
15103
|
+
*/
|
|
15104
|
+
deviceVisibility?: string[] | null;
|
|
15105
|
+
/**
|
|
15106
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
15107
|
+
*/
|
|
15108
|
+
displayTemplate?: string | null;
|
|
15109
|
+
/**
|
|
15110
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
15111
|
+
*/
|
|
15112
|
+
field?: string | null;
|
|
15113
|
+
}
|
|
15114
|
+
/**
|
|
15115
|
+
* Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
|
|
15116
|
+
*/
|
|
15117
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings {
|
|
15118
|
+
/**
|
|
15119
|
+
* Per data store configuration.
|
|
15120
|
+
*/
|
|
15121
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
15122
|
+
/**
|
|
15123
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
15124
|
+
*/
|
|
15125
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
15126
|
+
/**
|
|
15127
|
+
* If set to true, the widget will not collect user events.
|
|
15128
|
+
*/
|
|
15129
|
+
disableUserEventsCollection?: boolean | null;
|
|
15130
|
+
/**
|
|
15131
|
+
* Whether or not to enable autocomplete.
|
|
15132
|
+
*/
|
|
15133
|
+
enableAutocomplete?: boolean | null;
|
|
15134
|
+
/**
|
|
15135
|
+
* Optional. If set to true, the widget will enable the create agent button.
|
|
15136
|
+
*/
|
|
15137
|
+
enableCreateAgentButton?: boolean | null;
|
|
15138
|
+
/**
|
|
15139
|
+
* Optional. If set to true, the widget will enable people search.
|
|
15140
|
+
*/
|
|
15141
|
+
enablePeopleSearch?: boolean | null;
|
|
15142
|
+
/**
|
|
15143
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
15144
|
+
*/
|
|
15145
|
+
enableQualityFeedback?: boolean | null;
|
|
15146
|
+
/**
|
|
15147
|
+
* Whether to enable safe search.
|
|
15148
|
+
*/
|
|
15149
|
+
enableSafeSearch?: boolean | null;
|
|
15150
|
+
/**
|
|
15151
|
+
* Whether to enable search-as-you-type behavior for the search widget.
|
|
15152
|
+
*/
|
|
15153
|
+
enableSearchAsYouType?: boolean | null;
|
|
15154
|
+
/**
|
|
15155
|
+
* If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
|
|
15156
|
+
*/
|
|
15157
|
+
enableVisualContentSummary?: boolean | null;
|
|
15158
|
+
/**
|
|
15159
|
+
* Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
15160
|
+
*/
|
|
15161
|
+
features?: {
|
|
15162
|
+
[key: string]: string;
|
|
15163
|
+
} | null;
|
|
15164
|
+
/**
|
|
15165
|
+
* Describes generative answer configuration.
|
|
15166
|
+
*/
|
|
15167
|
+
generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
15168
|
+
/**
|
|
15169
|
+
* Describes widget (or web app) interaction type
|
|
15170
|
+
*/
|
|
15171
|
+
interactionType?: string | null;
|
|
15172
|
+
/**
|
|
15173
|
+
* Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
15174
|
+
*/
|
|
15175
|
+
modelConfigs?: {
|
|
15176
|
+
[key: string]: string;
|
|
15177
|
+
} | null;
|
|
15178
|
+
/**
|
|
15179
|
+
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
15180
|
+
*/
|
|
15181
|
+
resultDescriptionType?: string | null;
|
|
15182
|
+
}
|
|
15183
|
+
/**
|
|
15184
|
+
* Describes configuration for generative answer.
|
|
15185
|
+
*/
|
|
15186
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
|
|
15187
|
+
/**
|
|
15188
|
+
* Whether generated answer contains suggested related questions.
|
|
15189
|
+
*/
|
|
15190
|
+
disableRelatedQuestions?: boolean | null;
|
|
15191
|
+
/**
|
|
15192
|
+
* Optional. Specifies whether to filter out queries that are adversarial.
|
|
15193
|
+
*/
|
|
15194
|
+
ignoreAdversarialQuery?: boolean | null;
|
|
15195
|
+
/**
|
|
15196
|
+
* Optional. Specifies whether to filter out queries that are not relevant to the content.
|
|
15197
|
+
*/
|
|
15198
|
+
ignoreLowRelevantContent?: boolean | null;
|
|
15199
|
+
/**
|
|
15200
|
+
* Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
|
|
15201
|
+
*/
|
|
15202
|
+
ignoreNonAnswerSeekingQuery?: boolean | null;
|
|
15203
|
+
/**
|
|
15204
|
+
* Optional. Source of image returned in the answer.
|
|
15205
|
+
*/
|
|
15206
|
+
imageSource?: string | null;
|
|
15207
|
+
/**
|
|
15208
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
15209
|
+
*/
|
|
15210
|
+
languageCode?: string | null;
|
|
15211
|
+
/**
|
|
15212
|
+
* Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
|
|
15213
|
+
*/
|
|
15214
|
+
maxRephraseSteps?: number | null;
|
|
15215
|
+
/**
|
|
15216
|
+
* Text at the beginning of the prompt that instructs the model that generates the answer.
|
|
15217
|
+
*/
|
|
15218
|
+
modelPromptPreamble?: string | null;
|
|
15219
|
+
/**
|
|
15220
|
+
* The model version used to generate the answer.
|
|
15221
|
+
*/
|
|
15222
|
+
modelVersion?: string | null;
|
|
15223
|
+
/**
|
|
15224
|
+
* The number of top results to generate the answer from. Up to 10.
|
|
15225
|
+
*/
|
|
15226
|
+
resultCount?: number | null;
|
|
15227
|
+
}
|
|
14689
15228
|
/**
|
|
14690
15229
|
* Config to store data store type configuration for workspace data
|
|
14691
15230
|
*/
|
|
@@ -16589,6 +17128,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16589
17128
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
16590
17129
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
16591
17130
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
17131
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
|
|
16592
17132
|
constructor(context: APIRequestContext);
|
|
16593
17133
|
/**
|
|
16594
17134
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -24186,40 +24726,336 @@ export declare namespace discoveryengine_v1 {
|
|
|
24186
24726
|
*
|
|
24187
24727
|
* // Do the magic
|
|
24188
24728
|
* const res =
|
|
24189
|
-
* await discoveryengine.projects.locations.collections.dataStores.userEvents.write(
|
|
24729
|
+
* await discoveryengine.projects.locations.collections.dataStores.userEvents.write(
|
|
24730
|
+
* {
|
|
24731
|
+
* // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24732
|
+
* parent:
|
|
24733
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
24734
|
+
* // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
|
|
24735
|
+
* writeAsync: 'placeholder-value',
|
|
24736
|
+
*
|
|
24737
|
+
* // Request body metadata
|
|
24738
|
+
* requestBody: {
|
|
24739
|
+
* // request body parameters
|
|
24740
|
+
* // {
|
|
24741
|
+
* // "attributes": {},
|
|
24742
|
+
* // "attributionToken": "my_attributionToken",
|
|
24743
|
+
* // "completionInfo": {},
|
|
24744
|
+
* // "conversionType": "my_conversionType",
|
|
24745
|
+
* // "dataStore": "my_dataStore",
|
|
24746
|
+
* // "directUserRequest": false,
|
|
24747
|
+
* // "documents": [],
|
|
24748
|
+
* // "engine": "my_engine",
|
|
24749
|
+
* // "eventTime": "my_eventTime",
|
|
24750
|
+
* // "eventType": "my_eventType",
|
|
24751
|
+
* // "filter": "my_filter",
|
|
24752
|
+
* // "mediaInfo": {},
|
|
24753
|
+
* // "pageInfo": {},
|
|
24754
|
+
* // "panel": {},
|
|
24755
|
+
* // "panels": [],
|
|
24756
|
+
* // "promotionIds": [],
|
|
24757
|
+
* // "searchInfo": {},
|
|
24758
|
+
* // "sessionId": "my_sessionId",
|
|
24759
|
+
* // "tagIds": [],
|
|
24760
|
+
* // "transactionInfo": {},
|
|
24761
|
+
* // "userInfo": {},
|
|
24762
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
24763
|
+
* // }
|
|
24764
|
+
* },
|
|
24765
|
+
* },
|
|
24766
|
+
* );
|
|
24767
|
+
* console.log(res.data);
|
|
24768
|
+
*
|
|
24769
|
+
* // Example response
|
|
24770
|
+
* // {
|
|
24771
|
+
* // "attributes": {},
|
|
24772
|
+
* // "attributionToken": "my_attributionToken",
|
|
24773
|
+
* // "completionInfo": {},
|
|
24774
|
+
* // "conversionType": "my_conversionType",
|
|
24775
|
+
* // "dataStore": "my_dataStore",
|
|
24776
|
+
* // "directUserRequest": false,
|
|
24777
|
+
* // "documents": [],
|
|
24778
|
+
* // "engine": "my_engine",
|
|
24779
|
+
* // "eventTime": "my_eventTime",
|
|
24780
|
+
* // "eventType": "my_eventType",
|
|
24781
|
+
* // "filter": "my_filter",
|
|
24782
|
+
* // "mediaInfo": {},
|
|
24783
|
+
* // "pageInfo": {},
|
|
24784
|
+
* // "panel": {},
|
|
24785
|
+
* // "panels": [],
|
|
24786
|
+
* // "promotionIds": [],
|
|
24787
|
+
* // "searchInfo": {},
|
|
24788
|
+
* // "sessionId": "my_sessionId",
|
|
24789
|
+
* // "tagIds": [],
|
|
24790
|
+
* // "transactionInfo": {},
|
|
24791
|
+
* // "userInfo": {},
|
|
24792
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
24793
|
+
* // }
|
|
24794
|
+
* }
|
|
24795
|
+
*
|
|
24796
|
+
* main().catch(e => {
|
|
24797
|
+
* console.error(e);
|
|
24798
|
+
* throw e;
|
|
24799
|
+
* });
|
|
24800
|
+
*
|
|
24801
|
+
* ```
|
|
24802
|
+
*
|
|
24803
|
+
* @param params - Parameters for request
|
|
24804
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24805
|
+
* @param callback - Optional callback that handles the response.
|
|
24806
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24807
|
+
*/
|
|
24808
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24809
|
+
write(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>>;
|
|
24810
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24811
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24812
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24813
|
+
write(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24814
|
+
}
|
|
24815
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect extends StandardParameters {
|
|
24816
|
+
/**
|
|
24817
|
+
* The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
|
|
24818
|
+
*/
|
|
24819
|
+
ets?: string;
|
|
24820
|
+
/**
|
|
24821
|
+
* Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24822
|
+
*/
|
|
24823
|
+
parent?: string;
|
|
24824
|
+
/**
|
|
24825
|
+
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
|
|
24826
|
+
*/
|
|
24827
|
+
uri?: string;
|
|
24828
|
+
/**
|
|
24829
|
+
* Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
|
|
24830
|
+
*/
|
|
24831
|
+
userEvent?: string;
|
|
24832
|
+
}
|
|
24833
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import extends StandardParameters {
|
|
24834
|
+
/**
|
|
24835
|
+
* Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
24836
|
+
*/
|
|
24837
|
+
parent?: string;
|
|
24838
|
+
/**
|
|
24839
|
+
* Request body metadata
|
|
24840
|
+
*/
|
|
24841
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest;
|
|
24842
|
+
}
|
|
24843
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters {
|
|
24844
|
+
/**
|
|
24845
|
+
* Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`.
|
|
24846
|
+
*/
|
|
24847
|
+
parent?: string;
|
|
24848
|
+
/**
|
|
24849
|
+
* Request body metadata
|
|
24850
|
+
*/
|
|
24851
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
24852
|
+
}
|
|
24853
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
|
|
24854
|
+
/**
|
|
24855
|
+
* Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24856
|
+
*/
|
|
24857
|
+
parent?: string;
|
|
24858
|
+
/**
|
|
24859
|
+
* If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
|
|
24860
|
+
*/
|
|
24861
|
+
writeAsync?: boolean;
|
|
24862
|
+
/**
|
|
24863
|
+
* Request body metadata
|
|
24864
|
+
*/
|
|
24865
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
24866
|
+
}
|
|
24867
|
+
export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs {
|
|
24868
|
+
context: APIRequestContext;
|
|
24869
|
+
constructor(context: APIRequestContext);
|
|
24870
|
+
/**
|
|
24871
|
+
* Gets a WidgetConfig.
|
|
24872
|
+
* @example
|
|
24873
|
+
* ```js
|
|
24874
|
+
* // Before running the sample:
|
|
24875
|
+
* // - Enable the API at:
|
|
24876
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24877
|
+
* // - Login into gcloud by running:
|
|
24878
|
+
* // ```sh
|
|
24879
|
+
* // $ gcloud auth application-default login
|
|
24880
|
+
* // ```
|
|
24881
|
+
* // - Install the npm module by running:
|
|
24882
|
+
* // ```sh
|
|
24883
|
+
* // $ npm install googleapis
|
|
24884
|
+
* // ```
|
|
24885
|
+
*
|
|
24886
|
+
* const {google} = require('googleapis');
|
|
24887
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24888
|
+
*
|
|
24889
|
+
* async function main() {
|
|
24890
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24891
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24892
|
+
* scopes: [
|
|
24893
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24894
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
24895
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24896
|
+
* ],
|
|
24897
|
+
* });
|
|
24898
|
+
*
|
|
24899
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24900
|
+
* const authClient = await auth.getClient();
|
|
24901
|
+
* google.options({auth: authClient});
|
|
24902
|
+
*
|
|
24903
|
+
* // Do the magic
|
|
24904
|
+
* const res =
|
|
24905
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get(
|
|
24906
|
+
* {
|
|
24907
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
24908
|
+
* acceptCache: 'placeholder-value',
|
|
24909
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
24910
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
24911
|
+
* 'placeholder-value',
|
|
24912
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
24913
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
24914
|
+
* },
|
|
24915
|
+
* );
|
|
24916
|
+
* console.log(res.data);
|
|
24917
|
+
*
|
|
24918
|
+
* // Example response
|
|
24919
|
+
* // {
|
|
24920
|
+
* // "accessSettings": {},
|
|
24921
|
+
* // "allowPublicAccess": false,
|
|
24922
|
+
* // "allowlistedDomains": [],
|
|
24923
|
+
* // "assistantSettings": {},
|
|
24924
|
+
* // "collectionComponents": [],
|
|
24925
|
+
* // "configId": "my_configId",
|
|
24926
|
+
* // "contentSearchSpec": {},
|
|
24927
|
+
* // "createTime": "my_createTime",
|
|
24928
|
+
* // "customerProvidedConfig": {},
|
|
24929
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
24930
|
+
* // "dataStoreUiConfigs": [],
|
|
24931
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
24932
|
+
* // "displayName": "my_displayName",
|
|
24933
|
+
* // "enableAutocomplete": false,
|
|
24934
|
+
* // "enableConversationalSearch": false,
|
|
24935
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
24936
|
+
* // "enableQualityFeedback": false,
|
|
24937
|
+
* // "enableResultScore": false,
|
|
24938
|
+
* // "enableSafeSearch": false,
|
|
24939
|
+
* // "enableSearchAsYouType": false,
|
|
24940
|
+
* // "enableSnippetResultSummary": false,
|
|
24941
|
+
* // "enableSummarization": false,
|
|
24942
|
+
* // "enableWebApp": false,
|
|
24943
|
+
* // "facetField": [],
|
|
24944
|
+
* // "fieldsUiComponentsMap": {},
|
|
24945
|
+
* // "geminiBundle": false,
|
|
24946
|
+
* // "homepageSetting": {},
|
|
24947
|
+
* // "industryVertical": "my_industryVertical",
|
|
24948
|
+
* // "llmEnabled": false,
|
|
24949
|
+
* // "minimumDataTermAccepted": false,
|
|
24950
|
+
* // "name": "my_name",
|
|
24951
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
24952
|
+
* // "solutionType": "my_solutionType",
|
|
24953
|
+
* // "uiBranding": {},
|
|
24954
|
+
* // "uiSettings": {},
|
|
24955
|
+
* // "updateTime": "my_updateTime"
|
|
24956
|
+
* // }
|
|
24957
|
+
* }
|
|
24958
|
+
*
|
|
24959
|
+
* main().catch(e => {
|
|
24960
|
+
* console.error(e);
|
|
24961
|
+
* throw e;
|
|
24962
|
+
* });
|
|
24963
|
+
*
|
|
24964
|
+
* ```
|
|
24965
|
+
*
|
|
24966
|
+
* @param params - Parameters for request
|
|
24967
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24968
|
+
* @param callback - Optional callback that handles the response.
|
|
24969
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24970
|
+
*/
|
|
24971
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24972
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
24973
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24974
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24975
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24976
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24977
|
+
/**
|
|
24978
|
+
* Update a WidgetConfig.
|
|
24979
|
+
* @example
|
|
24980
|
+
* ```js
|
|
24981
|
+
* // Before running the sample:
|
|
24982
|
+
* // - Enable the API at:
|
|
24983
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24984
|
+
* // - Login into gcloud by running:
|
|
24985
|
+
* // ```sh
|
|
24986
|
+
* // $ gcloud auth application-default login
|
|
24987
|
+
* // ```
|
|
24988
|
+
* // - Install the npm module by running:
|
|
24989
|
+
* // ```sh
|
|
24990
|
+
* // $ npm install googleapis
|
|
24991
|
+
* // ```
|
|
24992
|
+
*
|
|
24993
|
+
* const {google} = require('googleapis');
|
|
24994
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24995
|
+
*
|
|
24996
|
+
* async function main() {
|
|
24997
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24998
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24999
|
+
* scopes: [
|
|
25000
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25001
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25002
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25003
|
+
* ],
|
|
25004
|
+
* });
|
|
25005
|
+
*
|
|
25006
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25007
|
+
* const authClient = await auth.getClient();
|
|
25008
|
+
* google.options({auth: authClient});
|
|
25009
|
+
*
|
|
25010
|
+
* // Do the magic
|
|
25011
|
+
* const res =
|
|
25012
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch(
|
|
24190
25013
|
* {
|
|
24191
|
-
* //
|
|
24192
|
-
*
|
|
24193
|
-
*
|
|
24194
|
-
*
|
|
24195
|
-
* writeAsync: 'placeholder-value',
|
|
25014
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
25015
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
25016
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
25017
|
+
* updateMask: 'placeholder-value',
|
|
24196
25018
|
*
|
|
24197
25019
|
* // Request body metadata
|
|
24198
25020
|
* requestBody: {
|
|
24199
25021
|
* // request body parameters
|
|
24200
25022
|
* // {
|
|
24201
|
-
* // "
|
|
24202
|
-
* // "
|
|
24203
|
-
* // "
|
|
24204
|
-
* // "
|
|
24205
|
-
* // "
|
|
24206
|
-
* // "
|
|
24207
|
-
* // "
|
|
24208
|
-
* // "
|
|
24209
|
-
* // "
|
|
24210
|
-
* // "
|
|
24211
|
-
* // "
|
|
24212
|
-
* // "
|
|
24213
|
-
* // "
|
|
24214
|
-
* // "
|
|
24215
|
-
* // "
|
|
24216
|
-
* // "
|
|
24217
|
-
* // "
|
|
24218
|
-
* // "
|
|
24219
|
-
* // "
|
|
24220
|
-
* // "
|
|
24221
|
-
* // "
|
|
24222
|
-
* // "
|
|
25023
|
+
* // "accessSettings": {},
|
|
25024
|
+
* // "allowPublicAccess": false,
|
|
25025
|
+
* // "allowlistedDomains": [],
|
|
25026
|
+
* // "assistantSettings": {},
|
|
25027
|
+
* // "collectionComponents": [],
|
|
25028
|
+
* // "configId": "my_configId",
|
|
25029
|
+
* // "contentSearchSpec": {},
|
|
25030
|
+
* // "createTime": "my_createTime",
|
|
25031
|
+
* // "customerProvidedConfig": {},
|
|
25032
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
25033
|
+
* // "dataStoreUiConfigs": [],
|
|
25034
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
25035
|
+
* // "displayName": "my_displayName",
|
|
25036
|
+
* // "enableAutocomplete": false,
|
|
25037
|
+
* // "enableConversationalSearch": false,
|
|
25038
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
25039
|
+
* // "enableQualityFeedback": false,
|
|
25040
|
+
* // "enableResultScore": false,
|
|
25041
|
+
* // "enableSafeSearch": false,
|
|
25042
|
+
* // "enableSearchAsYouType": false,
|
|
25043
|
+
* // "enableSnippetResultSummary": false,
|
|
25044
|
+
* // "enableSummarization": false,
|
|
25045
|
+
* // "enableWebApp": false,
|
|
25046
|
+
* // "facetField": [],
|
|
25047
|
+
* // "fieldsUiComponentsMap": {},
|
|
25048
|
+
* // "geminiBundle": false,
|
|
25049
|
+
* // "homepageSetting": {},
|
|
25050
|
+
* // "industryVertical": "my_industryVertical",
|
|
25051
|
+
* // "llmEnabled": false,
|
|
25052
|
+
* // "minimumDataTermAccepted": false,
|
|
25053
|
+
* // "name": "my_name",
|
|
25054
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
25055
|
+
* // "solutionType": "my_solutionType",
|
|
25056
|
+
* // "uiBranding": {},
|
|
25057
|
+
* // "uiSettings": {},
|
|
25058
|
+
* // "updateTime": "my_updateTime"
|
|
24223
25059
|
* // }
|
|
24224
25060
|
* },
|
|
24225
25061
|
* },
|
|
@@ -24228,28 +25064,42 @@ export declare namespace discoveryengine_v1 {
|
|
|
24228
25064
|
*
|
|
24229
25065
|
* // Example response
|
|
24230
25066
|
* // {
|
|
24231
|
-
* // "
|
|
24232
|
-
* // "
|
|
24233
|
-
* // "
|
|
24234
|
-
* // "
|
|
24235
|
-
* // "
|
|
24236
|
-
* // "
|
|
24237
|
-
* // "
|
|
24238
|
-
* // "
|
|
24239
|
-
* // "
|
|
24240
|
-
* // "
|
|
24241
|
-
* // "
|
|
24242
|
-
* // "
|
|
24243
|
-
* // "
|
|
24244
|
-
* // "
|
|
24245
|
-
* // "
|
|
24246
|
-
* // "
|
|
24247
|
-
* // "
|
|
24248
|
-
* // "
|
|
24249
|
-
* // "
|
|
24250
|
-
* // "
|
|
24251
|
-
* // "
|
|
24252
|
-
* // "
|
|
25067
|
+
* // "accessSettings": {},
|
|
25068
|
+
* // "allowPublicAccess": false,
|
|
25069
|
+
* // "allowlistedDomains": [],
|
|
25070
|
+
* // "assistantSettings": {},
|
|
25071
|
+
* // "collectionComponents": [],
|
|
25072
|
+
* // "configId": "my_configId",
|
|
25073
|
+
* // "contentSearchSpec": {},
|
|
25074
|
+
* // "createTime": "my_createTime",
|
|
25075
|
+
* // "customerProvidedConfig": {},
|
|
25076
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
25077
|
+
* // "dataStoreUiConfigs": [],
|
|
25078
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
25079
|
+
* // "displayName": "my_displayName",
|
|
25080
|
+
* // "enableAutocomplete": false,
|
|
25081
|
+
* // "enableConversationalSearch": false,
|
|
25082
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
25083
|
+
* // "enableQualityFeedback": false,
|
|
25084
|
+
* // "enableResultScore": false,
|
|
25085
|
+
* // "enableSafeSearch": false,
|
|
25086
|
+
* // "enableSearchAsYouType": false,
|
|
25087
|
+
* // "enableSnippetResultSummary": false,
|
|
25088
|
+
* // "enableSummarization": false,
|
|
25089
|
+
* // "enableWebApp": false,
|
|
25090
|
+
* // "facetField": [],
|
|
25091
|
+
* // "fieldsUiComponentsMap": {},
|
|
25092
|
+
* // "geminiBundle": false,
|
|
25093
|
+
* // "homepageSetting": {},
|
|
25094
|
+
* // "industryVertical": "my_industryVertical",
|
|
25095
|
+
* // "llmEnabled": false,
|
|
25096
|
+
* // "minimumDataTermAccepted": false,
|
|
25097
|
+
* // "name": "my_name",
|
|
25098
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
25099
|
+
* // "solutionType": "my_solutionType",
|
|
25100
|
+
* // "uiBranding": {},
|
|
25101
|
+
* // "uiSettings": {},
|
|
25102
|
+
* // "updateTime": "my_updateTime"
|
|
24253
25103
|
* // }
|
|
24254
25104
|
* }
|
|
24255
25105
|
*
|
|
@@ -24265,64 +25115,40 @@ export declare namespace discoveryengine_v1 {
|
|
|
24265
25115
|
* @param callback - Optional callback that handles the response.
|
|
24266
25116
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24267
25117
|
*/
|
|
24268
|
-
|
|
24269
|
-
|
|
24270
|
-
|
|
24271
|
-
|
|
24272
|
-
|
|
24273
|
-
|
|
24274
|
-
}
|
|
24275
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect extends StandardParameters {
|
|
24276
|
-
/**
|
|
24277
|
-
* The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
|
|
24278
|
-
*/
|
|
24279
|
-
ets?: string;
|
|
24280
|
-
/**
|
|
24281
|
-
* Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24282
|
-
*/
|
|
24283
|
-
parent?: string;
|
|
24284
|
-
/**
|
|
24285
|
-
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
|
|
24286
|
-
*/
|
|
24287
|
-
uri?: string;
|
|
24288
|
-
/**
|
|
24289
|
-
* Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
|
|
24290
|
-
*/
|
|
24291
|
-
userEvent?: string;
|
|
25118
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25119
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
25120
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25121
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
25122
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
25123
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24292
25124
|
}
|
|
24293
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
24294
|
-
/**
|
|
24295
|
-
* Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
24296
|
-
*/
|
|
24297
|
-
parent?: string;
|
|
25125
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
24298
25126
|
/**
|
|
24299
|
-
*
|
|
25127
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
24300
25128
|
*/
|
|
24301
|
-
|
|
24302
|
-
}
|
|
24303
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters {
|
|
25129
|
+
acceptCache?: boolean;
|
|
24304
25130
|
/**
|
|
24305
|
-
*
|
|
25131
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
24306
25132
|
*/
|
|
24307
|
-
|
|
25133
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
24308
25134
|
/**
|
|
24309
|
-
*
|
|
25135
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
24310
25136
|
*/
|
|
24311
|
-
|
|
25137
|
+
name?: string;
|
|
24312
25138
|
}
|
|
24313
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
25139
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
24314
25140
|
/**
|
|
24315
|
-
*
|
|
25141
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
24316
25142
|
*/
|
|
24317
|
-
|
|
25143
|
+
name?: string;
|
|
24318
25144
|
/**
|
|
24319
|
-
*
|
|
25145
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
24320
25146
|
*/
|
|
24321
|
-
|
|
25147
|
+
updateMask?: string;
|
|
24322
25148
|
/**
|
|
24323
25149
|
* Request body metadata
|
|
24324
25150
|
*/
|
|
24325
|
-
requestBody?: Schema$
|
|
25151
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
24326
25152
|
}
|
|
24327
25153
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
24328
25154
|
context: APIRequestContext;
|
|
@@ -24333,6 +25159,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24333
25159
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
24334
25160
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
24335
25161
|
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
25162
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs;
|
|
24336
25163
|
constructor(context: APIRequestContext);
|
|
24337
25164
|
/**
|
|
24338
25165
|
* Creates a Engine.
|
|
@@ -24382,6 +25209,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24382
25209
|
* // "appType": "my_appType",
|
|
24383
25210
|
* // "chatEngineConfig": {},
|
|
24384
25211
|
* // "chatEngineMetadata": {},
|
|
25212
|
+
* // "cmekConfig": {},
|
|
24385
25213
|
* // "commonConfig": {},
|
|
24386
25214
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24387
25215
|
* // "createTime": "my_createTime",
|
|
@@ -24391,6 +25219,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24391
25219
|
* // "features": {},
|
|
24392
25220
|
* // "industryVertical": "my_industryVertical",
|
|
24393
25221
|
* // "mediaRecommendationEngineConfig": {},
|
|
25222
|
+
* // "modelConfigs": {},
|
|
24394
25223
|
* // "name": "my_name",
|
|
24395
25224
|
* // "searchEngineConfig": {},
|
|
24396
25225
|
* // "solutionType": "my_solutionType",
|
|
@@ -24540,6 +25369,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24540
25369
|
* // "appType": "my_appType",
|
|
24541
25370
|
* // "chatEngineConfig": {},
|
|
24542
25371
|
* // "chatEngineMetadata": {},
|
|
25372
|
+
* // "cmekConfig": {},
|
|
24543
25373
|
* // "commonConfig": {},
|
|
24544
25374
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24545
25375
|
* // "createTime": "my_createTime",
|
|
@@ -24549,6 +25379,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24549
25379
|
* // "features": {},
|
|
24550
25380
|
* // "industryVertical": "my_industryVertical",
|
|
24551
25381
|
* // "mediaRecommendationEngineConfig": {},
|
|
25382
|
+
* // "modelConfigs": {},
|
|
24552
25383
|
* // "name": "my_name",
|
|
24553
25384
|
* // "searchEngineConfig": {},
|
|
24554
25385
|
* // "solutionType": "my_solutionType",
|
|
@@ -24694,6 +25525,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24694
25525
|
* // "appType": "my_appType",
|
|
24695
25526
|
* // "chatEngineConfig": {},
|
|
24696
25527
|
* // "chatEngineMetadata": {},
|
|
25528
|
+
* // "cmekConfig": {},
|
|
24697
25529
|
* // "commonConfig": {},
|
|
24698
25530
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24699
25531
|
* // "createTime": "my_createTime",
|
|
@@ -24703,6 +25535,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24703
25535
|
* // "features": {},
|
|
24704
25536
|
* // "industryVertical": "my_industryVertical",
|
|
24705
25537
|
* // "mediaRecommendationEngineConfig": {},
|
|
25538
|
+
* // "modelConfigs": {},
|
|
24706
25539
|
* // "name": "my_name",
|
|
24707
25540
|
* // "searchEngineConfig": {},
|
|
24708
25541
|
* // "solutionType": "my_solutionType",
|
|
@@ -24717,6 +25550,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24717
25550
|
* // "appType": "my_appType",
|
|
24718
25551
|
* // "chatEngineConfig": {},
|
|
24719
25552
|
* // "chatEngineMetadata": {},
|
|
25553
|
+
* // "cmekConfig": {},
|
|
24720
25554
|
* // "commonConfig": {},
|
|
24721
25555
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24722
25556
|
* // "createTime": "my_createTime",
|
|
@@ -24726,6 +25560,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24726
25560
|
* // "features": {},
|
|
24727
25561
|
* // "industryVertical": "my_industryVertical",
|
|
24728
25562
|
* // "mediaRecommendationEngineConfig": {},
|
|
25563
|
+
* // "modelConfigs": {},
|
|
24729
25564
|
* // "name": "my_name",
|
|
24730
25565
|
* // "searchEngineConfig": {},
|
|
24731
25566
|
* // "solutionType": "my_solutionType",
|
|
@@ -27798,30 +28633,294 @@ export declare namespace discoveryengine_v1 {
|
|
|
27798
28633
|
*
|
|
27799
28634
|
* // Do the magic
|
|
27800
28635
|
* const res =
|
|
27801
|
-
* await discoveryengine.projects.locations.collections.engines.sessions.answers.get(
|
|
28636
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.answers.get(
|
|
28637
|
+
* {
|
|
28638
|
+
* // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
28639
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/answers/my-answer',
|
|
28640
|
+
* },
|
|
28641
|
+
* );
|
|
28642
|
+
* console.log(res.data);
|
|
28643
|
+
*
|
|
28644
|
+
* // Example response
|
|
28645
|
+
* // {
|
|
28646
|
+
* // "answerSkippedReasons": [],
|
|
28647
|
+
* // "answerText": "my_answerText",
|
|
28648
|
+
* // "citations": [],
|
|
28649
|
+
* // "completeTime": "my_completeTime",
|
|
28650
|
+
* // "createTime": "my_createTime",
|
|
28651
|
+
* // "groundingScore": {},
|
|
28652
|
+
* // "groundingSupports": [],
|
|
28653
|
+
* // "name": "my_name",
|
|
28654
|
+
* // "queryUnderstandingInfo": {},
|
|
28655
|
+
* // "references": [],
|
|
28656
|
+
* // "relatedQuestions": [],
|
|
28657
|
+
* // "safetyRatings": [],
|
|
28658
|
+
* // "state": "my_state",
|
|
28659
|
+
* // "steps": []
|
|
28660
|
+
* // }
|
|
28661
|
+
* }
|
|
28662
|
+
*
|
|
28663
|
+
* main().catch(e => {
|
|
28664
|
+
* console.error(e);
|
|
28665
|
+
* throw e;
|
|
28666
|
+
* });
|
|
28667
|
+
*
|
|
28668
|
+
* ```
|
|
28669
|
+
*
|
|
28670
|
+
* @param params - Parameters for request
|
|
28671
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28672
|
+
* @param callback - Optional callback that handles the response.
|
|
28673
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28674
|
+
*/
|
|
28675
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28676
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Answer>>;
|
|
28677
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28678
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28679
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28680
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28681
|
+
}
|
|
28682
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
28683
|
+
/**
|
|
28684
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
28685
|
+
*/
|
|
28686
|
+
name?: string;
|
|
28687
|
+
}
|
|
28688
|
+
export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs {
|
|
28689
|
+
context: APIRequestContext;
|
|
28690
|
+
constructor(context: APIRequestContext);
|
|
28691
|
+
/**
|
|
28692
|
+
* Gets a WidgetConfig.
|
|
28693
|
+
* @example
|
|
28694
|
+
* ```js
|
|
28695
|
+
* // Before running the sample:
|
|
28696
|
+
* // - Enable the API at:
|
|
28697
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28698
|
+
* // - Login into gcloud by running:
|
|
28699
|
+
* // ```sh
|
|
28700
|
+
* // $ gcloud auth application-default login
|
|
28701
|
+
* // ```
|
|
28702
|
+
* // - Install the npm module by running:
|
|
28703
|
+
* // ```sh
|
|
28704
|
+
* // $ npm install googleapis
|
|
28705
|
+
* // ```
|
|
28706
|
+
*
|
|
28707
|
+
* const {google} = require('googleapis');
|
|
28708
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28709
|
+
*
|
|
28710
|
+
* async function main() {
|
|
28711
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28712
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28713
|
+
* scopes: [
|
|
28714
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28715
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28716
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28717
|
+
* ],
|
|
28718
|
+
* });
|
|
28719
|
+
*
|
|
28720
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28721
|
+
* const authClient = await auth.getClient();
|
|
28722
|
+
* google.options({auth: authClient});
|
|
28723
|
+
*
|
|
28724
|
+
* // Do the magic
|
|
28725
|
+
* const res =
|
|
28726
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.get(
|
|
28727
|
+
* {
|
|
28728
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28729
|
+
* acceptCache: 'placeholder-value',
|
|
28730
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
28731
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
28732
|
+
* 'placeholder-value',
|
|
28733
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
28734
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28735
|
+
* },
|
|
28736
|
+
* );
|
|
28737
|
+
* console.log(res.data);
|
|
28738
|
+
*
|
|
28739
|
+
* // Example response
|
|
28740
|
+
* // {
|
|
28741
|
+
* // "accessSettings": {},
|
|
28742
|
+
* // "allowPublicAccess": false,
|
|
28743
|
+
* // "allowlistedDomains": [],
|
|
28744
|
+
* // "assistantSettings": {},
|
|
28745
|
+
* // "collectionComponents": [],
|
|
28746
|
+
* // "configId": "my_configId",
|
|
28747
|
+
* // "contentSearchSpec": {},
|
|
28748
|
+
* // "createTime": "my_createTime",
|
|
28749
|
+
* // "customerProvidedConfig": {},
|
|
28750
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28751
|
+
* // "dataStoreUiConfigs": [],
|
|
28752
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28753
|
+
* // "displayName": "my_displayName",
|
|
28754
|
+
* // "enableAutocomplete": false,
|
|
28755
|
+
* // "enableConversationalSearch": false,
|
|
28756
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28757
|
+
* // "enableQualityFeedback": false,
|
|
28758
|
+
* // "enableResultScore": false,
|
|
28759
|
+
* // "enableSafeSearch": false,
|
|
28760
|
+
* // "enableSearchAsYouType": false,
|
|
28761
|
+
* // "enableSnippetResultSummary": false,
|
|
28762
|
+
* // "enableSummarization": false,
|
|
28763
|
+
* // "enableWebApp": false,
|
|
28764
|
+
* // "facetField": [],
|
|
28765
|
+
* // "fieldsUiComponentsMap": {},
|
|
28766
|
+
* // "geminiBundle": false,
|
|
28767
|
+
* // "homepageSetting": {},
|
|
28768
|
+
* // "industryVertical": "my_industryVertical",
|
|
28769
|
+
* // "llmEnabled": false,
|
|
28770
|
+
* // "minimumDataTermAccepted": false,
|
|
28771
|
+
* // "name": "my_name",
|
|
28772
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28773
|
+
* // "solutionType": "my_solutionType",
|
|
28774
|
+
* // "uiBranding": {},
|
|
28775
|
+
* // "uiSettings": {},
|
|
28776
|
+
* // "updateTime": "my_updateTime"
|
|
28777
|
+
* // }
|
|
28778
|
+
* }
|
|
28779
|
+
*
|
|
28780
|
+
* main().catch(e => {
|
|
28781
|
+
* console.error(e);
|
|
28782
|
+
* throw e;
|
|
28783
|
+
* });
|
|
28784
|
+
*
|
|
28785
|
+
* ```
|
|
28786
|
+
*
|
|
28787
|
+
* @param params - Parameters for request
|
|
28788
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28789
|
+
* @param callback - Optional callback that handles the response.
|
|
28790
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28791
|
+
*/
|
|
28792
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28793
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28794
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28795
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28796
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28797
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28798
|
+
/**
|
|
28799
|
+
* Update a WidgetConfig.
|
|
28800
|
+
* @example
|
|
28801
|
+
* ```js
|
|
28802
|
+
* // Before running the sample:
|
|
28803
|
+
* // - Enable the API at:
|
|
28804
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28805
|
+
* // - Login into gcloud by running:
|
|
28806
|
+
* // ```sh
|
|
28807
|
+
* // $ gcloud auth application-default login
|
|
28808
|
+
* // ```
|
|
28809
|
+
* // - Install the npm module by running:
|
|
28810
|
+
* // ```sh
|
|
28811
|
+
* // $ npm install googleapis
|
|
28812
|
+
* // ```
|
|
28813
|
+
*
|
|
28814
|
+
* const {google} = require('googleapis');
|
|
28815
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28816
|
+
*
|
|
28817
|
+
* async function main() {
|
|
28818
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28819
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28820
|
+
* scopes: [
|
|
28821
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28822
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28823
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28824
|
+
* ],
|
|
28825
|
+
* });
|
|
28826
|
+
*
|
|
28827
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28828
|
+
* const authClient = await auth.getClient();
|
|
28829
|
+
* google.options({auth: authClient});
|
|
28830
|
+
*
|
|
28831
|
+
* // Do the magic
|
|
28832
|
+
* const res =
|
|
28833
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch(
|
|
27802
28834
|
* {
|
|
27803
|
-
* //
|
|
27804
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/
|
|
28835
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
28836
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28837
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
28838
|
+
* updateMask: 'placeholder-value',
|
|
28839
|
+
*
|
|
28840
|
+
* // Request body metadata
|
|
28841
|
+
* requestBody: {
|
|
28842
|
+
* // request body parameters
|
|
28843
|
+
* // {
|
|
28844
|
+
* // "accessSettings": {},
|
|
28845
|
+
* // "allowPublicAccess": false,
|
|
28846
|
+
* // "allowlistedDomains": [],
|
|
28847
|
+
* // "assistantSettings": {},
|
|
28848
|
+
* // "collectionComponents": [],
|
|
28849
|
+
* // "configId": "my_configId",
|
|
28850
|
+
* // "contentSearchSpec": {},
|
|
28851
|
+
* // "createTime": "my_createTime",
|
|
28852
|
+
* // "customerProvidedConfig": {},
|
|
28853
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28854
|
+
* // "dataStoreUiConfigs": [],
|
|
28855
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28856
|
+
* // "displayName": "my_displayName",
|
|
28857
|
+
* // "enableAutocomplete": false,
|
|
28858
|
+
* // "enableConversationalSearch": false,
|
|
28859
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28860
|
+
* // "enableQualityFeedback": false,
|
|
28861
|
+
* // "enableResultScore": false,
|
|
28862
|
+
* // "enableSafeSearch": false,
|
|
28863
|
+
* // "enableSearchAsYouType": false,
|
|
28864
|
+
* // "enableSnippetResultSummary": false,
|
|
28865
|
+
* // "enableSummarization": false,
|
|
28866
|
+
* // "enableWebApp": false,
|
|
28867
|
+
* // "facetField": [],
|
|
28868
|
+
* // "fieldsUiComponentsMap": {},
|
|
28869
|
+
* // "geminiBundle": false,
|
|
28870
|
+
* // "homepageSetting": {},
|
|
28871
|
+
* // "industryVertical": "my_industryVertical",
|
|
28872
|
+
* // "llmEnabled": false,
|
|
28873
|
+
* // "minimumDataTermAccepted": false,
|
|
28874
|
+
* // "name": "my_name",
|
|
28875
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28876
|
+
* // "solutionType": "my_solutionType",
|
|
28877
|
+
* // "uiBranding": {},
|
|
28878
|
+
* // "uiSettings": {},
|
|
28879
|
+
* // "updateTime": "my_updateTime"
|
|
28880
|
+
* // }
|
|
28881
|
+
* },
|
|
27805
28882
|
* },
|
|
27806
28883
|
* );
|
|
27807
28884
|
* console.log(res.data);
|
|
27808
28885
|
*
|
|
27809
28886
|
* // Example response
|
|
27810
28887
|
* // {
|
|
27811
|
-
* // "
|
|
27812
|
-
* // "
|
|
27813
|
-
* // "
|
|
27814
|
-
* // "
|
|
28888
|
+
* // "accessSettings": {},
|
|
28889
|
+
* // "allowPublicAccess": false,
|
|
28890
|
+
* // "allowlistedDomains": [],
|
|
28891
|
+
* // "assistantSettings": {},
|
|
28892
|
+
* // "collectionComponents": [],
|
|
28893
|
+
* // "configId": "my_configId",
|
|
28894
|
+
* // "contentSearchSpec": {},
|
|
27815
28895
|
* // "createTime": "my_createTime",
|
|
27816
|
-
* // "
|
|
27817
|
-
* // "
|
|
28896
|
+
* // "customerProvidedConfig": {},
|
|
28897
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28898
|
+
* // "dataStoreUiConfigs": [],
|
|
28899
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28900
|
+
* // "displayName": "my_displayName",
|
|
28901
|
+
* // "enableAutocomplete": false,
|
|
28902
|
+
* // "enableConversationalSearch": false,
|
|
28903
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28904
|
+
* // "enableQualityFeedback": false,
|
|
28905
|
+
* // "enableResultScore": false,
|
|
28906
|
+
* // "enableSafeSearch": false,
|
|
28907
|
+
* // "enableSearchAsYouType": false,
|
|
28908
|
+
* // "enableSnippetResultSummary": false,
|
|
28909
|
+
* // "enableSummarization": false,
|
|
28910
|
+
* // "enableWebApp": false,
|
|
28911
|
+
* // "facetField": [],
|
|
28912
|
+
* // "fieldsUiComponentsMap": {},
|
|
28913
|
+
* // "geminiBundle": false,
|
|
28914
|
+
* // "homepageSetting": {},
|
|
28915
|
+
* // "industryVertical": "my_industryVertical",
|
|
28916
|
+
* // "llmEnabled": false,
|
|
28917
|
+
* // "minimumDataTermAccepted": false,
|
|
27818
28918
|
* // "name": "my_name",
|
|
27819
|
-
* // "
|
|
27820
|
-
* // "
|
|
27821
|
-
* // "
|
|
27822
|
-
* // "
|
|
27823
|
-
* // "
|
|
27824
|
-
* // "steps": []
|
|
28919
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28920
|
+
* // "solutionType": "my_solutionType",
|
|
28921
|
+
* // "uiBranding": {},
|
|
28922
|
+
* // "uiSettings": {},
|
|
28923
|
+
* // "updateTime": "my_updateTime"
|
|
27825
28924
|
* // }
|
|
27826
28925
|
* }
|
|
27827
28926
|
*
|
|
@@ -27837,19 +28936,41 @@ export declare namespace discoveryengine_v1 {
|
|
|
27837
28936
|
* @param callback - Optional callback that handles the response.
|
|
27838
28937
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27839
28938
|
*/
|
|
27840
|
-
|
|
27841
|
-
|
|
27842
|
-
|
|
27843
|
-
|
|
27844
|
-
|
|
27845
|
-
|
|
28939
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28940
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28941
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28942
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28943
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28944
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
27846
28945
|
}
|
|
27847
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
28946
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get extends StandardParameters {
|
|
27848
28947
|
/**
|
|
27849
|
-
*
|
|
28948
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28949
|
+
*/
|
|
28950
|
+
acceptCache?: boolean;
|
|
28951
|
+
/**
|
|
28952
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
28953
|
+
*/
|
|
28954
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
28955
|
+
/**
|
|
28956
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
27850
28957
|
*/
|
|
27851
28958
|
name?: string;
|
|
27852
28959
|
}
|
|
28960
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch extends StandardParameters {
|
|
28961
|
+
/**
|
|
28962
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
28963
|
+
*/
|
|
28964
|
+
name?: string;
|
|
28965
|
+
/**
|
|
28966
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
28967
|
+
*/
|
|
28968
|
+
updateMask?: string;
|
|
28969
|
+
/**
|
|
28970
|
+
* Request body metadata
|
|
28971
|
+
*/
|
|
28972
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
28973
|
+
}
|
|
27853
28974
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
27854
28975
|
context: APIRequestContext;
|
|
27855
28976
|
constructor(context: APIRequestContext);
|
|
@@ -28039,6 +29160,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28039
29160
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
28040
29161
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
28041
29162
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
29163
|
+
widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
|
|
28042
29164
|
constructor(context: APIRequestContext);
|
|
28043
29165
|
/**
|
|
28044
29166
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -34809,6 +35931,288 @@ export declare namespace discoveryengine_v1 {
|
|
|
34809
35931
|
*/
|
|
34810
35932
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
34811
35933
|
}
|
|
35934
|
+
export class Resource$Projects$Locations$Datastores$Widgetconfigs {
|
|
35935
|
+
context: APIRequestContext;
|
|
35936
|
+
constructor(context: APIRequestContext);
|
|
35937
|
+
/**
|
|
35938
|
+
* Gets a WidgetConfig.
|
|
35939
|
+
* @example
|
|
35940
|
+
* ```js
|
|
35941
|
+
* // Before running the sample:
|
|
35942
|
+
* // - Enable the API at:
|
|
35943
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35944
|
+
* // - Login into gcloud by running:
|
|
35945
|
+
* // ```sh
|
|
35946
|
+
* // $ gcloud auth application-default login
|
|
35947
|
+
* // ```
|
|
35948
|
+
* // - Install the npm module by running:
|
|
35949
|
+
* // ```sh
|
|
35950
|
+
* // $ npm install googleapis
|
|
35951
|
+
* // ```
|
|
35952
|
+
*
|
|
35953
|
+
* const {google} = require('googleapis');
|
|
35954
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
35955
|
+
*
|
|
35956
|
+
* async function main() {
|
|
35957
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35958
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35959
|
+
* scopes: [
|
|
35960
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
35961
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
35962
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
35963
|
+
* ],
|
|
35964
|
+
* });
|
|
35965
|
+
*
|
|
35966
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35967
|
+
* const authClient = await auth.getClient();
|
|
35968
|
+
* google.options({auth: authClient});
|
|
35969
|
+
*
|
|
35970
|
+
* // Do the magic
|
|
35971
|
+
* const res =
|
|
35972
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.get({
|
|
35973
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
35974
|
+
* acceptCache: 'placeholder-value',
|
|
35975
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
35976
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
35977
|
+
* 'placeholder-value',
|
|
35978
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
35979
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
35980
|
+
* });
|
|
35981
|
+
* console.log(res.data);
|
|
35982
|
+
*
|
|
35983
|
+
* // Example response
|
|
35984
|
+
* // {
|
|
35985
|
+
* // "accessSettings": {},
|
|
35986
|
+
* // "allowPublicAccess": false,
|
|
35987
|
+
* // "allowlistedDomains": [],
|
|
35988
|
+
* // "assistantSettings": {},
|
|
35989
|
+
* // "collectionComponents": [],
|
|
35990
|
+
* // "configId": "my_configId",
|
|
35991
|
+
* // "contentSearchSpec": {},
|
|
35992
|
+
* // "createTime": "my_createTime",
|
|
35993
|
+
* // "customerProvidedConfig": {},
|
|
35994
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
35995
|
+
* // "dataStoreUiConfigs": [],
|
|
35996
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
35997
|
+
* // "displayName": "my_displayName",
|
|
35998
|
+
* // "enableAutocomplete": false,
|
|
35999
|
+
* // "enableConversationalSearch": false,
|
|
36000
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36001
|
+
* // "enableQualityFeedback": false,
|
|
36002
|
+
* // "enableResultScore": false,
|
|
36003
|
+
* // "enableSafeSearch": false,
|
|
36004
|
+
* // "enableSearchAsYouType": false,
|
|
36005
|
+
* // "enableSnippetResultSummary": false,
|
|
36006
|
+
* // "enableSummarization": false,
|
|
36007
|
+
* // "enableWebApp": false,
|
|
36008
|
+
* // "facetField": [],
|
|
36009
|
+
* // "fieldsUiComponentsMap": {},
|
|
36010
|
+
* // "geminiBundle": false,
|
|
36011
|
+
* // "homepageSetting": {},
|
|
36012
|
+
* // "industryVertical": "my_industryVertical",
|
|
36013
|
+
* // "llmEnabled": false,
|
|
36014
|
+
* // "minimumDataTermAccepted": false,
|
|
36015
|
+
* // "name": "my_name",
|
|
36016
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36017
|
+
* // "solutionType": "my_solutionType",
|
|
36018
|
+
* // "uiBranding": {},
|
|
36019
|
+
* // "uiSettings": {},
|
|
36020
|
+
* // "updateTime": "my_updateTime"
|
|
36021
|
+
* // }
|
|
36022
|
+
* }
|
|
36023
|
+
*
|
|
36024
|
+
* main().catch(e => {
|
|
36025
|
+
* console.error(e);
|
|
36026
|
+
* throw e;
|
|
36027
|
+
* });
|
|
36028
|
+
*
|
|
36029
|
+
* ```
|
|
36030
|
+
*
|
|
36031
|
+
* @param params - Parameters for request
|
|
36032
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36033
|
+
* @param callback - Optional callback that handles the response.
|
|
36034
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36035
|
+
*/
|
|
36036
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36037
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36038
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36039
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36040
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36041
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36042
|
+
/**
|
|
36043
|
+
* Update a WidgetConfig.
|
|
36044
|
+
* @example
|
|
36045
|
+
* ```js
|
|
36046
|
+
* // Before running the sample:
|
|
36047
|
+
* // - Enable the API at:
|
|
36048
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
36049
|
+
* // - Login into gcloud by running:
|
|
36050
|
+
* // ```sh
|
|
36051
|
+
* // $ gcloud auth application-default login
|
|
36052
|
+
* // ```
|
|
36053
|
+
* // - Install the npm module by running:
|
|
36054
|
+
* // ```sh
|
|
36055
|
+
* // $ npm install googleapis
|
|
36056
|
+
* // ```
|
|
36057
|
+
*
|
|
36058
|
+
* const {google} = require('googleapis');
|
|
36059
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
36060
|
+
*
|
|
36061
|
+
* async function main() {
|
|
36062
|
+
* const auth = new google.auth.GoogleAuth({
|
|
36063
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
36064
|
+
* scopes: [
|
|
36065
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
36066
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
36067
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
36068
|
+
* ],
|
|
36069
|
+
* });
|
|
36070
|
+
*
|
|
36071
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
36072
|
+
* const authClient = await auth.getClient();
|
|
36073
|
+
* google.options({auth: authClient});
|
|
36074
|
+
*
|
|
36075
|
+
* // Do the magic
|
|
36076
|
+
* const res =
|
|
36077
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({
|
|
36078
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36079
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
36080
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36081
|
+
* updateMask: 'placeholder-value',
|
|
36082
|
+
*
|
|
36083
|
+
* // Request body metadata
|
|
36084
|
+
* requestBody: {
|
|
36085
|
+
* // request body parameters
|
|
36086
|
+
* // {
|
|
36087
|
+
* // "accessSettings": {},
|
|
36088
|
+
* // "allowPublicAccess": false,
|
|
36089
|
+
* // "allowlistedDomains": [],
|
|
36090
|
+
* // "assistantSettings": {},
|
|
36091
|
+
* // "collectionComponents": [],
|
|
36092
|
+
* // "configId": "my_configId",
|
|
36093
|
+
* // "contentSearchSpec": {},
|
|
36094
|
+
* // "createTime": "my_createTime",
|
|
36095
|
+
* // "customerProvidedConfig": {},
|
|
36096
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36097
|
+
* // "dataStoreUiConfigs": [],
|
|
36098
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36099
|
+
* // "displayName": "my_displayName",
|
|
36100
|
+
* // "enableAutocomplete": false,
|
|
36101
|
+
* // "enableConversationalSearch": false,
|
|
36102
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36103
|
+
* // "enableQualityFeedback": false,
|
|
36104
|
+
* // "enableResultScore": false,
|
|
36105
|
+
* // "enableSafeSearch": false,
|
|
36106
|
+
* // "enableSearchAsYouType": false,
|
|
36107
|
+
* // "enableSnippetResultSummary": false,
|
|
36108
|
+
* // "enableSummarization": false,
|
|
36109
|
+
* // "enableWebApp": false,
|
|
36110
|
+
* // "facetField": [],
|
|
36111
|
+
* // "fieldsUiComponentsMap": {},
|
|
36112
|
+
* // "geminiBundle": false,
|
|
36113
|
+
* // "homepageSetting": {},
|
|
36114
|
+
* // "industryVertical": "my_industryVertical",
|
|
36115
|
+
* // "llmEnabled": false,
|
|
36116
|
+
* // "minimumDataTermAccepted": false,
|
|
36117
|
+
* // "name": "my_name",
|
|
36118
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36119
|
+
* // "solutionType": "my_solutionType",
|
|
36120
|
+
* // "uiBranding": {},
|
|
36121
|
+
* // "uiSettings": {},
|
|
36122
|
+
* // "updateTime": "my_updateTime"
|
|
36123
|
+
* // }
|
|
36124
|
+
* },
|
|
36125
|
+
* });
|
|
36126
|
+
* console.log(res.data);
|
|
36127
|
+
*
|
|
36128
|
+
* // Example response
|
|
36129
|
+
* // {
|
|
36130
|
+
* // "accessSettings": {},
|
|
36131
|
+
* // "allowPublicAccess": false,
|
|
36132
|
+
* // "allowlistedDomains": [],
|
|
36133
|
+
* // "assistantSettings": {},
|
|
36134
|
+
* // "collectionComponents": [],
|
|
36135
|
+
* // "configId": "my_configId",
|
|
36136
|
+
* // "contentSearchSpec": {},
|
|
36137
|
+
* // "createTime": "my_createTime",
|
|
36138
|
+
* // "customerProvidedConfig": {},
|
|
36139
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36140
|
+
* // "dataStoreUiConfigs": [],
|
|
36141
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36142
|
+
* // "displayName": "my_displayName",
|
|
36143
|
+
* // "enableAutocomplete": false,
|
|
36144
|
+
* // "enableConversationalSearch": false,
|
|
36145
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36146
|
+
* // "enableQualityFeedback": false,
|
|
36147
|
+
* // "enableResultScore": false,
|
|
36148
|
+
* // "enableSafeSearch": false,
|
|
36149
|
+
* // "enableSearchAsYouType": false,
|
|
36150
|
+
* // "enableSnippetResultSummary": false,
|
|
36151
|
+
* // "enableSummarization": false,
|
|
36152
|
+
* // "enableWebApp": false,
|
|
36153
|
+
* // "facetField": [],
|
|
36154
|
+
* // "fieldsUiComponentsMap": {},
|
|
36155
|
+
* // "geminiBundle": false,
|
|
36156
|
+
* // "homepageSetting": {},
|
|
36157
|
+
* // "industryVertical": "my_industryVertical",
|
|
36158
|
+
* // "llmEnabled": false,
|
|
36159
|
+
* // "minimumDataTermAccepted": false,
|
|
36160
|
+
* // "name": "my_name",
|
|
36161
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36162
|
+
* // "solutionType": "my_solutionType",
|
|
36163
|
+
* // "uiBranding": {},
|
|
36164
|
+
* // "uiSettings": {},
|
|
36165
|
+
* // "updateTime": "my_updateTime"
|
|
36166
|
+
* // }
|
|
36167
|
+
* }
|
|
36168
|
+
*
|
|
36169
|
+
* main().catch(e => {
|
|
36170
|
+
* console.error(e);
|
|
36171
|
+
* throw e;
|
|
36172
|
+
* });
|
|
36173
|
+
*
|
|
36174
|
+
* ```
|
|
36175
|
+
*
|
|
36176
|
+
* @param params - Parameters for request
|
|
36177
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36178
|
+
* @param callback - Optional callback that handles the response.
|
|
36179
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36180
|
+
*/
|
|
36181
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36182
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36183
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36184
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36185
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36186
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36187
|
+
}
|
|
36188
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
36189
|
+
/**
|
|
36190
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
36191
|
+
*/
|
|
36192
|
+
acceptCache?: boolean;
|
|
36193
|
+
/**
|
|
36194
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
36195
|
+
*/
|
|
36196
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
36197
|
+
/**
|
|
36198
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
36199
|
+
*/
|
|
36200
|
+
name?: string;
|
|
36201
|
+
}
|
|
36202
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
36203
|
+
/**
|
|
36204
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36205
|
+
*/
|
|
36206
|
+
name?: string;
|
|
36207
|
+
/**
|
|
36208
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36209
|
+
*/
|
|
36210
|
+
updateMask?: string;
|
|
36211
|
+
/**
|
|
36212
|
+
* Request body metadata
|
|
36213
|
+
*/
|
|
36214
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
36215
|
+
}
|
|
34812
36216
|
export class Resource$Projects$Locations$Groundingconfigs {
|
|
34813
36217
|
context: APIRequestContext;
|
|
34814
36218
|
constructor(context: APIRequestContext);
|
|
@@ -36635,6 +38039,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36635
38039
|
}
|
|
36636
38040
|
export class Resource$Projects$Locations$Userstores {
|
|
36637
38041
|
context: APIRequestContext;
|
|
38042
|
+
licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
|
|
36638
38043
|
userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
|
|
36639
38044
|
constructor(context: APIRequestContext);
|
|
36640
38045
|
/**
|
|
@@ -37064,6 +38469,83 @@ export declare namespace discoveryengine_v1 {
|
|
|
37064
38469
|
*/
|
|
37065
38470
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore;
|
|
37066
38471
|
}
|
|
38472
|
+
export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
|
|
38473
|
+
context: APIRequestContext;
|
|
38474
|
+
constructor(context: APIRequestContext);
|
|
38475
|
+
/**
|
|
38476
|
+
* Lists all the LicenseConfigUsageStatss associated with the project.
|
|
38477
|
+
* @example
|
|
38478
|
+
* ```js
|
|
38479
|
+
* // Before running the sample:
|
|
38480
|
+
* // - Enable the API at:
|
|
38481
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38482
|
+
* // - Login into gcloud by running:
|
|
38483
|
+
* // ```sh
|
|
38484
|
+
* // $ gcloud auth application-default login
|
|
38485
|
+
* // ```
|
|
38486
|
+
* // - Install the npm module by running:
|
|
38487
|
+
* // ```sh
|
|
38488
|
+
* // $ npm install googleapis
|
|
38489
|
+
* // ```
|
|
38490
|
+
*
|
|
38491
|
+
* const {google} = require('googleapis');
|
|
38492
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38493
|
+
*
|
|
38494
|
+
* async function main() {
|
|
38495
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38496
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38497
|
+
* scopes: [
|
|
38498
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38499
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38500
|
+
* ],
|
|
38501
|
+
* });
|
|
38502
|
+
*
|
|
38503
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38504
|
+
* const authClient = await auth.getClient();
|
|
38505
|
+
* google.options({auth: authClient});
|
|
38506
|
+
*
|
|
38507
|
+
* // Do the magic
|
|
38508
|
+
* const res =
|
|
38509
|
+
* await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
|
|
38510
|
+
* {
|
|
38511
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38512
|
+
* parent:
|
|
38513
|
+
* 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38514
|
+
* },
|
|
38515
|
+
* );
|
|
38516
|
+
* console.log(res.data);
|
|
38517
|
+
*
|
|
38518
|
+
* // Example response
|
|
38519
|
+
* // {
|
|
38520
|
+
* // "licenseConfigUsageStats": []
|
|
38521
|
+
* // }
|
|
38522
|
+
* }
|
|
38523
|
+
*
|
|
38524
|
+
* main().catch(e => {
|
|
38525
|
+
* console.error(e);
|
|
38526
|
+
* throw e;
|
|
38527
|
+
* });
|
|
38528
|
+
*
|
|
38529
|
+
* ```
|
|
38530
|
+
*
|
|
38531
|
+
* @param params - Parameters for request
|
|
38532
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38533
|
+
* @param callback - Optional callback that handles the response.
|
|
38534
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38535
|
+
*/
|
|
38536
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38537
|
+
list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>>;
|
|
38538
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38539
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38540
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38541
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38542
|
+
}
|
|
38543
|
+
export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
|
|
38544
|
+
/**
|
|
38545
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38546
|
+
*/
|
|
38547
|
+
parent?: string;
|
|
38548
|
+
}
|
|
37067
38549
|
export class Resource$Projects$Locations$Userstores$Userlicenses {
|
|
37068
38550
|
context: APIRequestContext;
|
|
37069
38551
|
constructor(context: APIRequestContext);
|
|
@@ -37102,7 +38584,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37102
38584
|
* // Do the magic
|
|
37103
38585
|
* const res =
|
|
37104
38586
|
* await discoveryengine.projects.locations.userStores.userLicenses.list({
|
|
37105
|
-
* // Optional. Filter for the list request. Supported fields: * `
|
|
38587
|
+
* // Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
|
|
37106
38588
|
* filter: 'placeholder-value',
|
|
37107
38589
|
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
37108
38590
|
* pageSize: 'placeholder-value',
|
|
@@ -37142,7 +38624,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37142
38624
|
}
|
|
37143
38625
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
37144
38626
|
/**
|
|
37145
|
-
* Optional. Filter for the list request. Supported fields: * `
|
|
38627
|
+
* Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
|
|
37146
38628
|
*/
|
|
37147
38629
|
filter?: string;
|
|
37148
38630
|
/**
|