Class v1beta.RankServiceClient (1.10.0)

Service for ranking text records. v1beta

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of RankServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new RankServiceClient({fallback: true}, gax); ```

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;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

rankServiceStub

rankServiceStub?: Promise<{
        [name: string]: Function;
    }>;

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

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.

enginePath(project, location, collection, engine)

enginePath(project: string, location: string, collection: string, engine: string): string;

Return a fully-qualified engine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

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.

Example


const [response] = await client.getLocation(request);

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.

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.

Example


const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the answer.

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the answer.

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the answer.

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the branch.

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the branch.

matchCollectionFromEngineName(engineName)

matchCollectionFromEngineName(engineName: string): string | number;

Parse the collection from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreControlName`	`string` A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
`projectLocationCollectionEngineControlName`	`string` A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the control from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreControlName`	`string` A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the control.

matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the control from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
`projectLocationCollectionEngineControlName`	`string` A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the control.

matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the control from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
`projectLocationDataStoreControlName`	`string` A fully-qualified path representing project_location_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the control.

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the conversation.

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the conversation.

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the conversation.

matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the custom_tuning_model.

matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the custom_tuning_model.

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreControlName`	`string` A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the data_store from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
`projectLocationDataStoreControlName`	`string` A fully-qualified path representing project_location_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the data_store from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchEngineFromEngineName(engineName)

matchEngineFromEngineName(engineName: string): string | number;

Parse the engine from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
`projectLocationCollectionEngineControlName`	`string` A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the engine.

matchLocationFromEngineName(engineName)

matchLocationFromEngineName(engineName: string): string | number;

Parse the location from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreControlName`	`string` A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the location from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the location from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
`projectLocationCollectionEngineControlName`	`string` A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the location from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the location from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
`projectLocationDataStoreControlName`	`string` A fully-qualified path representing project_location_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the location from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the location from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromRankingConfigName(rankingConfigName)

matchLocationFromRankingConfigName(rankingConfigName: string): string | number;

Parse the location from RankingConfig resource.

Parameter
Name	Description
`rankingConfigName`	`string` A fully-qualified path representing RankingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchProjectFromEngineName(engineName)

matchProjectFromEngineName(engineName: string): string | number;

Parse the project from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreControlName`	`string` A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the project from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the project from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
`projectLocationCollectionEngineControlName`	`string` A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the project from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the project from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
`projectLocationDataStoreControlName`	`string` A fully-qualified path representing project_location_data_store_control resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the project from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name	Description
`projectLocationDataStoreCustomTuningModelName`	`string` A fully-qualified path representing project_location_data_store_custom_tuning_model resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the project from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromRankingConfigName(rankingConfigName)

matchProjectFromRankingConfigName(rankingConfigName: string): string | number;

Parse the project from RankingConfig resource.

Parameter
Name	Description
`rankingConfigName`	`string` A fully-qualified path representing RankingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchRankingConfigFromRankingConfigName(rankingConfigName)

matchRankingConfigFromRankingConfigName(rankingConfigName: string): string | number;

Parse the ranking_config from RankingConfig resource.

Parameter
Name	Description
`rankingConfigName`	`string` A fully-qualified path representing RankingConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the ranking_config.

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the schema.

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the schema.

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the serving_config.

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the serving_config.

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

Returns
Type	Description
`string \| number`	{string} A string representing the serving_config.

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the target_site.

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

Returns
Type	Description
`string \| number`	{string} A string representing the target_site.

projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document)

projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreControlPath(project, location, collection, dataStore, control)

projectLocationCollectionDataStoreControlPath(project: string, location: string, collection: string, dataStore: string, control: string): string;

Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`control`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation)

projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel)

projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;

Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`customTuningModel`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project, location, collection, dataStore)

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStorePath(project, location, collection, dataStore)

projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStore resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema)

projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`schema`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreServingConfigPath(project, location, collection, dataStore, servingConfig)

projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;

Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreSessionAnswerPath(project, location, collection, dataStore, session, answer)

projectLocationCollectionDataStoreSessionAnswerPath(project: string, location: string, collection: string, dataStore: string, session: string, answer: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`session`	`string`
`answer`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreSessionPath(project, location, collection, dataStore, session)

projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`session`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore)

projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite)

projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`targetSite`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionEngineControlPath(project, location, collection, engine, control)

projectLocationCollectionEngineControlPath(project: string, location: string, collection: string, engine: string, control: string): string;

Return a fully-qualified projectLocationCollectionEngineControl resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`control`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation)

projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;

Return a fully-qualified projectLocationCollectionEngineConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig)

projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;

Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionEngineSessionAnswerPath(project, location, collection, engine, session, answer)

projectLocationCollectionEngineSessionAnswerPath(project: string, location: string, collection: string, engine: string, session: string, answer: string): string;

Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`session`	`string`
`answer`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationCollectionEngineSessionPath(project, location, collection, engine, session)

projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;

Return a fully-qualified projectLocationCollectionEngineSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`session`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document)

projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreControlPath(project, location, dataStore, control)

projectLocationDataStoreControlPath(project: string, location: string, dataStore: string, control: string): string;

Return a fully-qualified projectLocationDataStoreControl resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`control`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreConversationPath(project, location, dataStore, conversation)

projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel)

projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;

Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`customTuningModel`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreDocumentProcessingConfigPath(project, location, dataStore)

projectLocationDataStoreDocumentProcessingConfigPath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStorePath(project, location, dataStore)

projectLocationDataStorePath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStore resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreSchemaPath(project, location, dataStore, schema)

projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`schema`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig)

projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;

Return a fully-qualified projectLocationDataStoreServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreSessionAnswerPath(project, location, dataStore, session, answer)

projectLocationDataStoreSessionAnswerPath(project: string, location: string, dataStore: string, session: string, answer: string): string;

Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`session`	`string`
`answer`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreSessionPath(project, location, dataStore, session)

projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;

Return a fully-qualified projectLocationDataStoreSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`session`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore)

projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite)

projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;

Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`targetSite`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

rank(request, options)

rank(request?: protos.google.cloud.discoveryengine.v1beta.IRankRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.IRankResponse,
        protos.google.cloud.discoveryengine.v1beta.IRankRequest | undefined,
        {} | undefined
    ]>;

Ranks a list of text records based on the given input query.

Parameters
Name	Description
`request`	`IRankRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1beta.IRankResponse, protos.google.cloud.discoveryengine.v1beta.IRankRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing RankResponse. Please see the documentation for more details and examples.

Example


  /**
   * 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 resource name of the rank service config, such as
   *  `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
   */
  // const rankingConfig = 'abc123'
  /**
   *  The identifier of the model to use. It is one of:
   *  * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
   *  token size 512.
   *  It is set to `semantic-ranker-512@latest` by default if unspecified.
   */
  // const model = 'abc123'
  /**
   *  The number of results to return. If this is unset or no bigger than zero,
   *  returns all results.
   */
  // const topN = 1234
  /**
   *  The query to use.
   */
  // const query = 'abc123'
  /**
   *  Required. A list of records to rank. At most 200 records to rank.
   */
  // const records = [1,2,3,4]
  /**
   *  If true, the response will contain only record ID and score. By default, it
   *  is false, the response will contain record details.
   */
  // const ignoreRecordDetailsInResponse = true
  /**
   *  The user labels applied to a resource must meet the following requirements:
   *  * Each resource can have multiple labels, up to a maximum of 64.
   *  * Each label must be a key-value pair.
   *  * Keys have a minimum length of 1 character and a maximum length of 63
   *    characters and cannot be empty. Values can be empty and have a maximum
   *    length of 63 characters.
   *  * Keys and values can contain only lowercase letters, numeric characters,
   *    underscores, and dashes. All characters must use UTF-8 encoding, and
   *    international characters are allowed.
   *  * The key portion of a label must be unique. However, you can use the same
   *    key with multiple resources.
   *  * Keys must start with a lowercase letter or international character.
   *  See Google Cloud
   *  Document (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
   *  for more details.
   */
  // const userLabels = [1,2,3,4]

  // Imports the Discoveryengine library
  const {RankServiceClient} = require('@google-cloud/discoveryengine').v1beta;

  // Instantiates a client
  const discoveryengineClient = new RankServiceClient();

  async function callRank() {
    // Construct request
    const request = {
      rankingConfig,
      records,
    };

    // Run request
    const response = await discoveryengineClient.rank(request);
    console.log(response);
  }

  callRank();

rank(request, options, callback)

rank(request: protos.google.cloud.discoveryengine.v1beta.IRankRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRankResponse, protos.google.cloud.discoveryengine.v1beta.IRankRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRankRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.IRankResponse, protos.google.cloud.discoveryengine.v1beta.IRankRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

rank(request, callback)

rank(request: protos.google.cloud.discoveryengine.v1beta.IRankRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRankResponse, protos.google.cloud.discoveryengine.v1beta.IRankRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRankRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.IRankResponse, protos.google.cloud.discoveryengine.v1beta.IRankRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

rankingConfigPath(project, location, rankingConfig)

rankingConfigPath(project: string, location: string, rankingConfig: string): string;

Return a fully-qualified rankingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`rankingConfig`	`string`

Returns
Type	Description
`string`	{string} Resource name string.