Service for managing LLM generated questions in search serving. v2beta
Package
@google-cloud/retailConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of GenerativeQuestionServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
generativeQuestionServiceStub
generativeQuestionServiceStub?: Promise<{
[name: string]: Function;
}>;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
alertConfigPath(project)
alertConfigPath(project: string): string;
Return a fully-qualified alertConfig resource name string.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
attributesConfigPath(project, location, catalog)
attributesConfigPath(project: string, location: string, catalog: string): string;
Return a fully-qualified attributesConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
batchUpdateGenerativeQuestionConfigs(request, options)
batchUpdateGenerativeQuestionConfigs(request?: protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse,
(protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | undefined),
{} | undefined
]>;
Allows management of multiple questions.
Parameters | |
---|---|
Name | Description |
request |
IBatchUpdateGenerativeQuestionConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse,
(protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchUpdateGenerativeQuestionConfigsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. Resource name of the parent catalog.
* Format: projects/{project}/locations/{location}/catalogs/{catalog}
*/
// const parent = 'abc123'
/**
* Required. The updates question configs.
*/
// const requests = [1,2,3,4]
// Imports the Retail library
const {GenerativeQuestionServiceClient} = require('@google-cloud/retail').v2beta;
// Instantiates a client
const retailClient = new GenerativeQuestionServiceClient();
async function callBatchUpdateGenerativeQuestionConfigs() {
// Construct request
const request = {
requests,
};
// Run request
const response = await retailClient.batchUpdateGenerativeQuestionConfigs(request);
console.log(response);
}
callBatchUpdateGenerativeQuestionConfigs();
batchUpdateGenerativeQuestionConfigs(request, options, callback)
batchUpdateGenerativeQuestionConfigs(request: protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchUpdateGenerativeQuestionConfigsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
batchUpdateGenerativeQuestionConfigs(request, callback)
batchUpdateGenerativeQuestionConfigs(request: protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest, callback: Callback<protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchUpdateGenerativeQuestionConfigsRequest
|
callback |
Callback<protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IBatchUpdateGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
catalogPath(project, location, catalog)
catalogPath(project: string, location: string, catalog: string): string;
Return a fully-qualified catalog resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed. |
completionConfigPath(project, location, catalog)
completionConfigPath(project: string, location: string, catalog: string): string;
Return a fully-qualified completionConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
controlPath(project, location, catalog, control)
controlPath(project: string, location: string, catalog: string, control: string): string;
Return a fully-qualified control resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
control |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
getGenerativeQuestionsFeatureConfig(request, options)
getGenerativeQuestionsFeatureConfig(request?: protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig,
(protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | undefined),
{} | undefined
]>;
Manages overal generative question feature state -- enables toggling feature on and off.
Parameters | |
---|---|
Name | Description |
request |
IGetGenerativeQuestionsFeatureConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig,
(protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerativeQuestionsFeatureConfig. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the parent catalog.
* Format: projects/{project}/locations/{location}/catalogs/{catalog}
*/
// const catalog = 'abc123'
// Imports the Retail library
const {GenerativeQuestionServiceClient} = require('@google-cloud/retail').v2beta;
// Instantiates a client
const retailClient = new GenerativeQuestionServiceClient();
async function callGetGenerativeQuestionsFeatureConfig() {
// Construct request
const request = {
catalog,
};
// Run request
const response = await retailClient.getGenerativeQuestionsFeatureConfig(request);
console.log(response);
}
callGetGenerativeQuestionsFeatureConfig();
getGenerativeQuestionsFeatureConfig(request, options, callback)
getGenerativeQuestionsFeatureConfig(request: protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetGenerativeQuestionsFeatureConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getGenerativeQuestionsFeatureConfig(request, callback)
getGenerativeQuestionsFeatureConfig(request: protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetGenerativeQuestionsFeatureConfigRequest
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IGetGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
Promise<google.cloud.location.ILocation> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub. |
listGenerativeQuestionConfigs(request, options)
listGenerativeQuestionConfigs(request?: protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse,
(protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | undefined),
{} | undefined
]>;
Returns all questions for a given catalog.
Parameters | |
---|---|
Name | Description |
request |
IListGenerativeQuestionConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse,
(protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ListGenerativeQuestionConfigsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the parent catalog.
* Format: projects/{project}/locations/{location}/catalogs/{catalog}
*/
// const parent = 'abc123'
// Imports the Retail library
const {GenerativeQuestionServiceClient} = require('@google-cloud/retail').v2beta;
// Instantiates a client
const retailClient = new GenerativeQuestionServiceClient();
async function callListGenerativeQuestionConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const response = await retailClient.listGenerativeQuestionConfigs(request);
console.log(response);
}
callListGenerativeQuestionConfigs();
listGenerativeQuestionConfigs(request, options, callback)
listGenerativeQuestionConfigs(request: protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IListGenerativeQuestionConfigsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
listGenerativeQuestionConfigs(request, callback)
listGenerativeQuestionConfigs(request: protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest, callback: Callback<protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IListGenerativeQuestionConfigsRequest
|
callback |
Callback<protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsResponse, protos.google.cloud.retail.v2beta.IListGenerativeQuestionConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> |
{Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
matchBranchFromProductName(productName)
matchBranchFromProductName(productName: string): string | number;
Parse the branch from Product resource.
Parameter | |
---|---|
Name | Description |
productName |
string
A fully-qualified path representing Product resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the branch. |
matchCatalogFromAttributesConfigName(attributesConfigName)
matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number;
Parse the catalog from AttributesConfig resource.
Parameter | |
---|---|
Name | Description |
attributesConfigName |
string
A fully-qualified path representing AttributesConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromCatalogName(catalogName)
matchCatalogFromCatalogName(catalogName: string): string | number;
Parse the catalog from Catalog resource.
Parameter | |
---|---|
Name | Description |
catalogName |
string
A fully-qualified path representing Catalog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromCompletionConfigName(completionConfigName)
matchCatalogFromCompletionConfigName(completionConfigName: string): string | number;
Parse the catalog from CompletionConfig resource.
Parameter | |
---|---|
Name | Description |
completionConfigName |
string
A fully-qualified path representing CompletionConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromControlName(controlName)
matchCatalogFromControlName(controlName: string): string | number;
Parse the catalog from Control resource.
Parameter | |
---|---|
Name | Description |
controlName |
string
A fully-qualified path representing Control resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromModelName(modelName)
matchCatalogFromModelName(modelName: string): string | number;
Parse the catalog from Model resource.
Parameter | |
---|---|
Name | Description |
modelName |
string
A fully-qualified path representing Model resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromProductName(productName)
matchCatalogFromProductName(productName: string): string | number;
Parse the catalog from Product resource.
Parameter | |
---|---|
Name | Description |
productName |
string
A fully-qualified path representing Product resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchCatalogFromServingConfigName(servingConfigName)
matchCatalogFromServingConfigName(servingConfigName: string): string | number;
Parse the catalog from ServingConfig resource.
Parameter | |
---|---|
Name | Description |
servingConfigName |
string
A fully-qualified path representing ServingConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the catalog. |
matchControlFromControlName(controlName)
matchControlFromControlName(controlName: string): string | number;
Parse the control from Control resource.
Parameter | |
---|---|
Name | Description |
controlName |
string
A fully-qualified path representing Control resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the control. |
matchLocationFromAttributesConfigName(attributesConfigName)
matchLocationFromAttributesConfigName(attributesConfigName: string): string | number;
Parse the location from AttributesConfig resource.
Parameter | |
---|---|
Name | Description |
attributesConfigName |
string
A fully-qualified path representing AttributesConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromCatalogName(catalogName)
matchLocationFromCatalogName(catalogName: string): string | number;
Parse the location from Catalog resource.
Parameter | |
---|---|
Name | Description |
catalogName |
string
A fully-qualified path representing Catalog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromCompletionConfigName(completionConfigName)
matchLocationFromCompletionConfigName(completionConfigName: string): string | number;
Parse the location from CompletionConfig resource.
Parameter | |
---|---|
Name | Description |
completionConfigName |
string
A fully-qualified path representing CompletionConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromControlName(controlName)
matchLocationFromControlName(controlName: string): string | number;
Parse the location from Control resource.
Parameter | |
---|---|
Name | Description |
controlName |
string
A fully-qualified path representing Control resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromModelName(modelName)
matchLocationFromModelName(modelName: string): string | number;
Parse the location from Model resource.
Parameter | |
---|---|
Name | Description |
modelName |
string
A fully-qualified path representing Model resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProductName(productName)
matchLocationFromProductName(productName: string): string | number;
Parse the location from Product resource.
Parameter | |
---|---|
Name | Description |
productName |
string
A fully-qualified path representing Product resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromServingConfigName(servingConfigName)
matchLocationFromServingConfigName(servingConfigName: string): string | number;
Parse the location from ServingConfig resource.
Parameter | |
---|---|
Name | Description |
servingConfigName |
string
A fully-qualified path representing ServingConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchModelFromModelName(modelName)
matchModelFromModelName(modelName: string): string | number;
Parse the model from Model resource.
Parameter | |
---|---|
Name | Description |
modelName |
string
A fully-qualified path representing Model resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the model. |
matchProductFromProductName(productName)
matchProductFromProductName(productName: string): string | number;
Parse the product from Product resource.
Parameter | |
---|---|
Name | Description |
productName |
string
A fully-qualified path representing Product resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the product. |
matchProjectFromAlertConfigName(alertConfigName)
matchProjectFromAlertConfigName(alertConfigName: string): string | number;
Parse the project from AlertConfig resource.
Parameter | |
---|---|
Name | Description |
alertConfigName |
string
A fully-qualified path representing AlertConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAttributesConfigName(attributesConfigName)
matchProjectFromAttributesConfigName(attributesConfigName: string): string | number;
Parse the project from AttributesConfig resource.
Parameter | |
---|---|
Name | Description |
attributesConfigName |
string
A fully-qualified path representing AttributesConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromCatalogName(catalogName)
matchProjectFromCatalogName(catalogName: string): string | number;
Parse the project from Catalog resource.
Parameter | |
---|---|
Name | Description |
catalogName |
string
A fully-qualified path representing Catalog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromCompletionConfigName(completionConfigName)
matchProjectFromCompletionConfigName(completionConfigName: string): string | number;
Parse the project from CompletionConfig resource.
Parameter | |
---|---|
Name | Description |
completionConfigName |
string
A fully-qualified path representing CompletionConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromControlName(controlName)
matchProjectFromControlName(controlName: string): string | number;
Parse the project from Control resource.
Parameter | |
---|---|
Name | Description |
controlName |
string
A fully-qualified path representing Control resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromModelName(modelName)
matchProjectFromModelName(modelName: string): string | number;
Parse the project from Model resource.
Parameter | |
---|---|
Name | Description |
modelName |
string
A fully-qualified path representing Model resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProductName(productName)
matchProjectFromProductName(productName: string): string | number;
Parse the project from Product resource.
Parameter | |
---|---|
Name | Description |
productName |
string
A fully-qualified path representing Product resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromServingConfigName(servingConfigName)
matchProjectFromServingConfigName(servingConfigName: string): string | number;
Parse the project from ServingConfig resource.
Parameter | |
---|---|
Name | Description |
servingConfigName |
string
A fully-qualified path representing ServingConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchServingConfigFromServingConfigName(servingConfigName)
matchServingConfigFromServingConfigName(servingConfigName: string): string | number;
Parse the serving_config from ServingConfig resource.
Parameter | |
---|---|
Name | Description |
servingConfigName |
string
A fully-qualified path representing ServingConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the serving_config. |
modelPath(project, location, catalog, model)
modelPath(project: string, location: string, catalog: string, model: string): string;
Return a fully-qualified model resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
model |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
productPath(project, location, catalog, branch, product)
productPath(project: string, location: string, catalog: string, branch: string, product: string): string;
Return a fully-qualified product resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
branch |
string
|
product |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
servingConfigPath(project, location, catalog, servingConfig)
servingConfigPath(project: string, location: string, catalog: string, servingConfig: string): string;
Return a fully-qualified servingConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
servingConfig |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
updateGenerativeQuestionConfig(request, options)
updateGenerativeQuestionConfig(request?: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig,
(protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | undefined),
{} | undefined
]>;
Allows management of individual questions.
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig,
(protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerativeQuestionConfig. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The question to update.
*/
// const generativeQuestionConfig = {}
/**
* Optional. Indicates which fields in the provided
* GenerativeQuestionConfig google.cloud.retail.v2beta.GenerativeQuestionConfig
* to update. The following are NOT supported:
* * GenerativeQuestionConfig.frequency google.cloud.retail.v2beta.GenerativeQuestionConfig.frequency
* If not set or empty, all supported fields are updated.
*/
// const updateMask = {}
// Imports the Retail library
const {GenerativeQuestionServiceClient} = require('@google-cloud/retail').v2beta;
// Instantiates a client
const retailClient = new GenerativeQuestionServiceClient();
async function callUpdateGenerativeQuestionConfig() {
// Construct request
const request = {
generativeQuestionConfig,
};
// Run request
const response = await retailClient.updateGenerativeQuestionConfig(request);
console.log(response);
}
callUpdateGenerativeQuestionConfig();
updateGenerativeQuestionConfig(request, options, callback)
updateGenerativeQuestionConfig(request: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateGenerativeQuestionConfig(request, callback)
updateGenerativeQuestionConfig(request: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionConfigRequest
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateGenerativeQuestionsFeatureConfig(request, options)
updateGenerativeQuestionsFeatureConfig(request?: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig,
(protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | undefined),
{} | undefined
]>;
Manages overal generative question feature state -- enables toggling feature on and off.
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionsFeatureConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig,
(protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerativeQuestionsFeatureConfig. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The configuration managing the feature state.
*/
// const generativeQuestionsFeatureConfig = {}
/**
* Optional. Indicates which fields in the provided
* GenerativeQuestionsFeatureConfig google.cloud.retail.v2beta.GenerativeQuestionsFeatureConfig
* to update. If not set or empty, all supported fields are updated.
*/
// const updateMask = {}
// Imports the Retail library
const {GenerativeQuestionServiceClient} = require('@google-cloud/retail').v2beta;
// Instantiates a client
const retailClient = new GenerativeQuestionServiceClient();
async function callUpdateGenerativeQuestionsFeatureConfig() {
// Construct request
const request = {
generativeQuestionsFeatureConfig,
};
// Run request
const response = await retailClient.updateGenerativeQuestionsFeatureConfig(request);
console.log(response);
}
callUpdateGenerativeQuestionsFeatureConfig();
updateGenerativeQuestionsFeatureConfig(request, options, callback)
updateGenerativeQuestionsFeatureConfig(request: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionsFeatureConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateGenerativeQuestionsFeatureConfig(request, callback)
updateGenerativeQuestionsFeatureConfig(request: protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateGenerativeQuestionsFeatureConfigRequest
|
callback |
Callback<protos.google.cloud.retail.v2beta.IGenerativeQuestionsFeatureConfig, protos.google.cloud.retail.v2beta.IUpdateGenerativeQuestionsFeatureConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |