@googleapis/discoveryengine 6.0.0 → 6.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 +7 -0
- package/build/v1alpha.d.ts +397 -1
- package/build/v1alpha.js +288 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +363 -1
- package/build/v1beta.js +288 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1279 -133
- package/v1beta.ts +1256 -144
package/build/v1beta.d.ts
CHANGED
|
@@ -1674,6 +1674,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1674
1674
|
*/
|
|
1675
1675
|
values?: number[] | null;
|
|
1676
1676
|
}
|
|
1677
|
+
/**
|
|
1678
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
1679
|
+
*/
|
|
1680
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig {
|
|
1681
|
+
/**
|
|
1682
|
+
* Full field path in the schema mapped as embedding field.
|
|
1683
|
+
*/
|
|
1684
|
+
fieldPath?: string | null;
|
|
1685
|
+
}
|
|
1677
1686
|
/**
|
|
1678
1687
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1679
1688
|
*/
|
|
@@ -2136,6 +2145,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2136
2145
|
*/
|
|
2137
2146
|
schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[];
|
|
2138
2147
|
}
|
|
2148
|
+
/**
|
|
2149
|
+
* Response for ListServingConfigs method.
|
|
2150
|
+
*/
|
|
2151
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse {
|
|
2152
|
+
/**
|
|
2153
|
+
* Pagination token, if not returned indicates the last page.
|
|
2154
|
+
*/
|
|
2155
|
+
nextPageToken?: string | null;
|
|
2156
|
+
/**
|
|
2157
|
+
* All the ServingConfigs for a given dataStore.
|
|
2158
|
+
*/
|
|
2159
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
2160
|
+
}
|
|
2139
2161
|
/**
|
|
2140
2162
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2141
2163
|
*/
|
|
@@ -2659,7 +2681,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2659
2681
|
*/
|
|
2660
2682
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2661
2683
|
/**
|
|
2662
|
-
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
|
|
2684
|
+
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)
|
|
2663
2685
|
*/
|
|
2664
2686
|
version?: string | null;
|
|
2665
2687
|
}
|
|
@@ -3025,6 +3047,118 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3025
3047
|
*/
|
|
3026
3048
|
summary?: string | null;
|
|
3027
3049
|
}
|
|
3050
|
+
/**
|
|
3051
|
+
* Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
|
|
3052
|
+
*/
|
|
3053
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig {
|
|
3054
|
+
/**
|
|
3055
|
+
* Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
|
|
3056
|
+
*/
|
|
3057
|
+
boostControlIds?: string[] | null;
|
|
3058
|
+
/**
|
|
3059
|
+
* Output only. ServingConfig created timestamp.
|
|
3060
|
+
*/
|
|
3061
|
+
createTime?: string | null;
|
|
3062
|
+
/**
|
|
3063
|
+
* Required. The human readable serving 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.
|
|
3064
|
+
*/
|
|
3065
|
+
displayName?: string | null;
|
|
3066
|
+
/**
|
|
3067
|
+
* Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3068
|
+
*/
|
|
3069
|
+
dissociateControlIds?: string[] | null;
|
|
3070
|
+
/**
|
|
3071
|
+
* How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3072
|
+
*/
|
|
3073
|
+
diversityLevel?: string | null;
|
|
3074
|
+
/**
|
|
3075
|
+
* Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
|
|
3076
|
+
*/
|
|
3077
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig;
|
|
3078
|
+
/**
|
|
3079
|
+
* Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
|
|
3080
|
+
*/
|
|
3081
|
+
filterControlIds?: string[] | null;
|
|
3082
|
+
/**
|
|
3083
|
+
* The GenericConfig of the serving configuration.
|
|
3084
|
+
*/
|
|
3085
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig;
|
|
3086
|
+
/**
|
|
3087
|
+
* Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
|
|
3088
|
+
*/
|
|
3089
|
+
ignoreControlIds?: string[] | null;
|
|
3090
|
+
/**
|
|
3091
|
+
* The MediaConfig of the serving configuration.
|
|
3092
|
+
*/
|
|
3093
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
|
|
3094
|
+
/**
|
|
3095
|
+
* The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3096
|
+
*/
|
|
3097
|
+
modelId?: string | null;
|
|
3098
|
+
/**
|
|
3099
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
3100
|
+
*/
|
|
3101
|
+
name?: string | null;
|
|
3102
|
+
/**
|
|
3103
|
+
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3104
|
+
*/
|
|
3105
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
3106
|
+
rankingExpression?: string | null;
|
|
3107
|
+
/**
|
|
3108
|
+
* IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3109
|
+
*/
|
|
3110
|
+
redirectControlIds?: string[] | null;
|
|
3111
|
+
/**
|
|
3112
|
+
* Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3113
|
+
*/
|
|
3114
|
+
replacementControlIds?: string[] | null;
|
|
3115
|
+
/**
|
|
3116
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
3117
|
+
*/
|
|
3118
|
+
solutionType?: string | null;
|
|
3119
|
+
/**
|
|
3120
|
+
* Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3121
|
+
*/
|
|
3122
|
+
synonymsControlIds?: string[] | null;
|
|
3123
|
+
/**
|
|
3124
|
+
* Output only. ServingConfig updated timestamp.
|
|
3125
|
+
*/
|
|
3126
|
+
updateTime?: string | null;
|
|
3127
|
+
}
|
|
3128
|
+
/**
|
|
3129
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
3130
|
+
*/
|
|
3131
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
|
|
3132
|
+
/**
|
|
3133
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
3134
|
+
*/
|
|
3135
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
3136
|
+
}
|
|
3137
|
+
/**
|
|
3138
|
+
* Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3139
|
+
*/
|
|
3140
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
|
|
3141
|
+
/**
|
|
3142
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
3143
|
+
*/
|
|
3144
|
+
contentFreshnessCutoffDays?: number | null;
|
|
3145
|
+
/**
|
|
3146
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3147
|
+
*/
|
|
3148
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
3149
|
+
/**
|
|
3150
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
3151
|
+
*/
|
|
3152
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
3153
|
+
/**
|
|
3154
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3155
|
+
*/
|
|
3156
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
3157
|
+
/**
|
|
3158
|
+
* Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
|
|
3159
|
+
*/
|
|
3160
|
+
demotionEventType?: string | null;
|
|
3161
|
+
}
|
|
3028
3162
|
/**
|
|
3029
3163
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
3030
3164
|
*/
|
|
@@ -4917,6 +5051,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4917
5051
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
4918
5052
|
context: APIRequestContext;
|
|
4919
5053
|
constructor(context: APIRequestContext);
|
|
5054
|
+
/**
|
|
5055
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5056
|
+
*
|
|
5057
|
+
* @param params - Parameters for request
|
|
5058
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5059
|
+
* @param callback - Optional callback that handles the response.
|
|
5060
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5061
|
+
*/
|
|
5062
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5063
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5064
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5065
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5066
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5067
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5068
|
+
/**
|
|
5069
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
5070
|
+
*
|
|
5071
|
+
* @param params - Parameters for request
|
|
5072
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5073
|
+
* @param callback - Optional callback that handles the response.
|
|
5074
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5075
|
+
*/
|
|
5076
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5077
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
5078
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5079
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5080
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5081
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5082
|
+
/**
|
|
5083
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
5084
|
+
*
|
|
5085
|
+
* @param params - Parameters for request
|
|
5086
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5087
|
+
* @param callback - Optional callback that handles the response.
|
|
5088
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5089
|
+
*/
|
|
5090
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5091
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5092
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5093
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5094
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5095
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
4920
5096
|
/**
|
|
4921
5097
|
* Makes a recommendation, which requires a contextual user event.
|
|
4922
5098
|
*
|
|
@@ -4946,6 +5122,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4946
5122
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4947
5123
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4948
5124
|
}
|
|
5125
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
5126
|
+
/**
|
|
5127
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
5128
|
+
*/
|
|
5129
|
+
name?: string;
|
|
5130
|
+
}
|
|
5131
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
5132
|
+
/**
|
|
5133
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
5134
|
+
*/
|
|
5135
|
+
pageSize?: number;
|
|
5136
|
+
/**
|
|
5137
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
5138
|
+
*/
|
|
5139
|
+
pageToken?: string;
|
|
5140
|
+
/**
|
|
5141
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
5142
|
+
*/
|
|
5143
|
+
parent?: string;
|
|
5144
|
+
}
|
|
5145
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
5146
|
+
/**
|
|
5147
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
5148
|
+
*/
|
|
5149
|
+
name?: string;
|
|
5150
|
+
/**
|
|
5151
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
5152
|
+
*/
|
|
5153
|
+
updateMask?: string;
|
|
5154
|
+
/**
|
|
5155
|
+
* Request body metadata
|
|
5156
|
+
*/
|
|
5157
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
5158
|
+
}
|
|
4949
5159
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4950
5160
|
/**
|
|
4951
5161
|
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
@@ -5839,6 +6049,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5839
6049
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
5840
6050
|
context: APIRequestContext;
|
|
5841
6051
|
constructor(context: APIRequestContext);
|
|
6052
|
+
/**
|
|
6053
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6054
|
+
*
|
|
6055
|
+
* @param params - Parameters for request
|
|
6056
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6057
|
+
* @param callback - Optional callback that handles the response.
|
|
6058
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6059
|
+
*/
|
|
6060
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6061
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6062
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6063
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6064
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6065
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6066
|
+
/**
|
|
6067
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
6068
|
+
*
|
|
6069
|
+
* @param params - Parameters for request
|
|
6070
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6071
|
+
* @param callback - Optional callback that handles the response.
|
|
6072
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6073
|
+
*/
|
|
6074
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6075
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
6076
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6077
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6078
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6079
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6080
|
+
/**
|
|
6081
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6082
|
+
*
|
|
6083
|
+
* @param params - Parameters for request
|
|
6084
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6085
|
+
* @param callback - Optional callback that handles the response.
|
|
6086
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6087
|
+
*/
|
|
6088
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6089
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6090
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6091
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6092
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6093
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5842
6094
|
/**
|
|
5843
6095
|
* Makes a recommendation, which requires a contextual user event.
|
|
5844
6096
|
*
|
|
@@ -5868,6 +6120,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5868
6120
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
5869
6121
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
5870
6122
|
}
|
|
6123
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
6124
|
+
/**
|
|
6125
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
6126
|
+
*/
|
|
6127
|
+
name?: string;
|
|
6128
|
+
}
|
|
6129
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
6130
|
+
/**
|
|
6131
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
6132
|
+
*/
|
|
6133
|
+
pageSize?: number;
|
|
6134
|
+
/**
|
|
6135
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6136
|
+
*/
|
|
6137
|
+
pageToken?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
6140
|
+
*/
|
|
6141
|
+
parent?: string;
|
|
6142
|
+
}
|
|
6143
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
6144
|
+
/**
|
|
6145
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
6146
|
+
*/
|
|
6147
|
+
name?: string;
|
|
6148
|
+
/**
|
|
6149
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
6150
|
+
*/
|
|
6151
|
+
updateMask?: string;
|
|
6152
|
+
/**
|
|
6153
|
+
* Request body metadata
|
|
6154
|
+
*/
|
|
6155
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
6156
|
+
}
|
|
5871
6157
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
5872
6158
|
/**
|
|
5873
6159
|
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
@@ -6787,6 +7073,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6787
7073
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
6788
7074
|
context: APIRequestContext;
|
|
6789
7075
|
constructor(context: APIRequestContext);
|
|
7076
|
+
/**
|
|
7077
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7078
|
+
*
|
|
7079
|
+
* @param params - Parameters for request
|
|
7080
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7081
|
+
* @param callback - Optional callback that handles the response.
|
|
7082
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7083
|
+
*/
|
|
7084
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7085
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7086
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7087
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7088
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7089
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7090
|
+
/**
|
|
7091
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
7092
|
+
*
|
|
7093
|
+
* @param params - Parameters for request
|
|
7094
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7095
|
+
* @param callback - Optional callback that handles the response.
|
|
7096
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7097
|
+
*/
|
|
7098
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7099
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
7100
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7101
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7102
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7103
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7104
|
+
/**
|
|
7105
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
7106
|
+
*
|
|
7107
|
+
* @param params - Parameters for request
|
|
7108
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7109
|
+
* @param callback - Optional callback that handles the response.
|
|
7110
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7111
|
+
*/
|
|
7112
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7113
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7114
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7115
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7116
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7117
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6790
7118
|
/**
|
|
6791
7119
|
* Makes a recommendation, which requires a contextual user event.
|
|
6792
7120
|
*
|
|
@@ -6816,6 +7144,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6816
7144
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6817
7145
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6818
7146
|
}
|
|
7147
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7148
|
+
/**
|
|
7149
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
7150
|
+
*/
|
|
7151
|
+
name?: string;
|
|
7152
|
+
}
|
|
7153
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
7154
|
+
/**
|
|
7155
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
7156
|
+
*/
|
|
7157
|
+
pageSize?: number;
|
|
7158
|
+
/**
|
|
7159
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
7160
|
+
*/
|
|
7161
|
+
pageToken?: string;
|
|
7162
|
+
/**
|
|
7163
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
7164
|
+
*/
|
|
7165
|
+
parent?: string;
|
|
7166
|
+
}
|
|
7167
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7168
|
+
/**
|
|
7169
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
7170
|
+
*/
|
|
7171
|
+
name?: string;
|
|
7172
|
+
/**
|
|
7173
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7174
|
+
*/
|
|
7175
|
+
updateMask?: string;
|
|
7176
|
+
/**
|
|
7177
|
+
* Request body metadata
|
|
7178
|
+
*/
|
|
7179
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
7180
|
+
}
|
|
6819
7181
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
6820
7182
|
/**
|
|
6821
7183
|
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|