Class v1beta.WidgetServiceClient (0.2.0)

Provides APIs for widgets to interact with CES APIs. v1beta

Package

@google-cloud/ces

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of WidgetServiceClient.

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 WidgetServiceClient({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.

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;

widgetServiceStub

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

Methods

agentPath(project, location, app, agent)

agentPath(project: string, location: string, app: string, agent: string): string;

Return a fully-qualified agent resource name string.

Parameters
Name	Description
project	string
location	string
app	string
agent	string

Returns
Type	Description
string	{string} Resource name string.

appPath(project, location, app)

appPath(project: string, location: string, app: string): string;

Return a fully-qualified app resource name string.

Parameters
Name	Description
project	string
location	string
app	string

Returns
Type	Description
string	{string} Resource name string.

appVersionPath(project, location, app, version)

appVersionPath(project: string, location: string, app: string, version: string): string;

Return a fully-qualified appVersion resource name string.

Parameters
Name	Description
project	string
location	string
app	string
version	string

Returns
Type	Description
string	{string} Resource name string.

changelogPath(project, location, app, changelog)

changelogPath(project: string, location: string, app: string, changelog: string): string;

Return a fully-qualified changelog resource name string.

Parameters
Name	Description
project	string
location	string
app	string
changelog	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

conversationPath(project, location, app, conversation)

conversationPath(project: string, location: string, app: string, conversation: string): string;

Return a fully-qualified conversation resource name string.

Parameters
Name	Description
project	string
location	string
app	string
conversation	string

Returns
Type	Description
string	{string} Resource name string.

deploymentPath(project, location, app, deployment)

deploymentPath(project: string, location: string, app: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters
Name	Description
project	string
location	string
app	string
deployment	string

Returns
Type	Description
string	{string} Resource name string.

evaluationDatasetPath(project, location, app, evaluationDataset)

evaluationDatasetPath(project: string, location: string, app: string, evaluationDataset: string): string;

Return a fully-qualified evaluationDataset resource name string.

Parameters
Name	Description
project	string
location	string
app	string
evaluationDataset	string

Returns
Type	Description
string	{string} Resource name string.

evaluationExpectationPath(project, location, app, evaluationExpectation)

evaluationExpectationPath(project: string, location: string, app: string, evaluationExpectation: string): string;

Return a fully-qualified evaluationExpectation resource name string.

Parameters
Name	Description
project	string
location	string
app	string
evaluationExpectation	string

Returns
Type	Description
string	{string} Resource name string.

evaluationPath(project, location, app, evaluation)

evaluationPath(project: string, location: string, app: string, evaluation: string): string;

Return a fully-qualified evaluation resource name string.

Parameters
Name	Description
project	string
location	string
app	string
evaluation	string

Returns
Type	Description
string	{string} Resource name string.

evaluationResultPath(project, location, app, evaluation, evaluationResult)

evaluationResultPath(project: string, location: string, app: string, evaluation: string, evaluationResult: string): string;

Return a fully-qualified evaluationResult resource name string.

Parameters
Name	Description
project	string
location	string
app	string
evaluation	string
evaluationResult	string

Returns
Type	Description
string	{string} Resource name string.

evaluationRunPath(project, location, app, evaluationRun)

evaluationRunPath(project: string, location: string, app: string, evaluationRun: string): string;

Return a fully-qualified evaluationRun resource name string.

Parameters
Name	Description
project	string
location	string
app	string
evaluationRun	string

Returns
Type	Description
string	{string} Resource name string.

examplePath(project, location, app, example)

examplePath(project: string, location: string, app: string, example: string): string;

Return a fully-qualified example resource name string.

Parameters
Name	Description
project	string
location	string
app	string
example	string

Returns
Type	Description
string	{string} Resource name string.

generateChatToken(request, options)

generateChatToken(request?: protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest, options?: CallOptions): Promise<[
        protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse,
        protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | undefined,
        {} | undefined
    ]>;

Generates a session scoped token for chat widget to authenticate with Session APIs.

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

Returns
Type	Description
Promise<[ protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse, protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateChatTokenResponse. 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 session name to generate the chat token for.
   *  Format:
   *  projects/{project}/locations/{location}/apps/{app}/sessions/{session}
   */
  // const name = 'abc123'
  /**
   *  Required. The deployment of the app to use for the session.
   *  Format:
   *  projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
   */
  // const deployment = 'abc123'
  /**
   *  Optional. The reCAPTCHA token generated by the client-side chat widget.
   */
  // const recaptchaToken = 'abc123'

  // Imports the Ces library
  const {WidgetServiceClient} = require('@google-cloud/ces').v1beta;

  // Instantiates a client
  const cesClient = new WidgetServiceClient();

  async function callGenerateChatToken() {
    // Construct request
    const request = {
      name,
      deployment,
    };

    // Run request
    const response = await cesClient.generateChatToken(request);
    console.log(response);
  }

  callGenerateChatToken();

generateChatToken(request, options, callback)

generateChatToken(request: protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse, protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateChatTokenRequest
options	CallOptions
callback	Callback<protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse, protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

generateChatToken(request, callback)

generateChatToken(request: protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest, callback: Callback<protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse, protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateChatTokenRequest
callback	Callback<protos.google.cloud.ces.v1beta.IGenerateChatTokenResponse, protos.google.cloud.ces.v1beta.IGenerateChatTokenRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

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

guardrailPath(project, location, app, guardrail)

guardrailPath(project: string, location: string, app: string, guardrail: string): string;

Return a fully-qualified guardrail resource name string.

Parameters
Name	Description
project	string
location	string
app	string
guardrail	string

Returns
Type	Description
string	{string} Resource name string.

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
}

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter
Name	Description
agentName	string A fully-qualified path representing Agent resource.

Returns
Type	Description
string | number	{string} A string representing the agent.

matchAppFromAgentName(agentName)

matchAppFromAgentName(agentName: string): string | number;

Parse the app from Agent resource.

Parameter
Name	Description
agentName	string A fully-qualified path representing Agent resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromAppName(appName)

matchAppFromAppName(appName: string): string | number;

Parse the app from App resource.

Parameter
Name	Description
appName	string A fully-qualified path representing App resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromAppVersionName(appVersionName)

matchAppFromAppVersionName(appVersionName: string): string | number;

Parse the app from AppVersion resource.

Parameter
Name	Description
appVersionName	string A fully-qualified path representing AppVersion resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromChangelogName(changelogName)

matchAppFromChangelogName(changelogName: string): string | number;

Parse the app from Changelog resource.

Parameter
Name	Description
changelogName	string A fully-qualified path representing Changelog resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromConversationName(conversationName)

matchAppFromConversationName(conversationName: string): string | number;

Parse the app from Conversation resource.

Parameter
Name	Description
conversationName	string A fully-qualified path representing Conversation resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromDeploymentName(deploymentName)

matchAppFromDeploymentName(deploymentName: string): string | number;

Parse the app from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromEvaluationDatasetName(evaluationDatasetName)

matchAppFromEvaluationDatasetName(evaluationDatasetName: string): string | number;

Parse the app from EvaluationDataset resource.

Parameter
Name	Description
evaluationDatasetName	string A fully-qualified path representing EvaluationDataset resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromEvaluationExpectationName(evaluationExpectationName)

matchAppFromEvaluationExpectationName(evaluationExpectationName: string): string | number;

Parse the app from EvaluationExpectation resource.

Parameter
Name	Description
evaluationExpectationName	string A fully-qualified path representing EvaluationExpectation resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromEvaluationName(evaluationName)

matchAppFromEvaluationName(evaluationName: string): string | number;

Parse the app from Evaluation resource.

Parameter
Name	Description
evaluationName	string A fully-qualified path representing Evaluation resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromEvaluationResultName(evaluationResultName)

matchAppFromEvaluationResultName(evaluationResultName: string): string | number;

Parse the app from EvaluationResult resource.

Parameter
Name	Description
evaluationResultName	string A fully-qualified path representing EvaluationResult resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromEvaluationRunName(evaluationRunName)

matchAppFromEvaluationRunName(evaluationRunName: string): string | number;

Parse the app from EvaluationRun resource.

Parameter
Name	Description
evaluationRunName	string A fully-qualified path representing EvaluationRun resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromExampleName(exampleName)

matchAppFromExampleName(exampleName: string): string | number;

Parse the app from Example resource.

Parameter
Name	Description
exampleName	string A fully-qualified path representing Example resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromGuardrailName(guardrailName)

matchAppFromGuardrailName(guardrailName: string): string | number;

Parse the app from Guardrail resource.

Parameter
Name	Description
guardrailName	string A fully-qualified path representing Guardrail resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromScheduledEvaluationRunName(scheduledEvaluationRunName)

matchAppFromScheduledEvaluationRunName(scheduledEvaluationRunName: string): string | number;

Parse the app from ScheduledEvaluationRun resource.

Parameter
Name	Description
scheduledEvaluationRunName	string A fully-qualified path representing ScheduledEvaluationRun resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromSessionName(sessionName)

matchAppFromSessionName(sessionName: string): string | number;

Parse the app from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromToolName(toolName)

matchAppFromToolName(toolName: string): string | number;

Parse the app from Tool resource.

Parameter
Name	Description
toolName	string A fully-qualified path representing Tool resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchAppFromToolsetName(toolsetName)

matchAppFromToolsetName(toolsetName: string): string | number;

Parse the app from Toolset resource.

Parameter
Name	Description
toolsetName	string A fully-qualified path representing Toolset resource.

Returns
Type	Description
string | number	{string} A string representing the app.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter
Name	Description
changelogName	string A fully-qualified path representing Changelog resource.

Returns
Type	Description
string | number	{string} A string representing the changelog.

matchConversationFromConversationName(conversationName)

matchConversationFromConversationName(conversationName: string): string | number;

Parse the conversation from Conversation resource.

Parameter
Name	Description
conversationName	string A fully-qualified path representing Conversation resource.

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

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment resource.

Returns
Type	Description
string | number	{string} A string representing the deployment.

matchEvaluationDatasetFromEvaluationDatasetName(evaluationDatasetName)

matchEvaluationDatasetFromEvaluationDatasetName(evaluationDatasetName: string): string | number;

Parse the evaluation_dataset from EvaluationDataset resource.

Parameter
Name	Description
evaluationDatasetName	string A fully-qualified path representing EvaluationDataset resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation_dataset.

matchEvaluationExpectationFromEvaluationExpectationName(evaluationExpectationName)

matchEvaluationExpectationFromEvaluationExpectationName(evaluationExpectationName: string): string | number;

Parse the evaluation_expectation from EvaluationExpectation resource.

Parameter
Name	Description
evaluationExpectationName	string A fully-qualified path representing EvaluationExpectation resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation_expectation.

matchEvaluationFromEvaluationName(evaluationName)

matchEvaluationFromEvaluationName(evaluationName: string): string | number;

Parse the evaluation from Evaluation resource.

Parameter
Name	Description
evaluationName	string A fully-qualified path representing Evaluation resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation.

matchEvaluationFromEvaluationResultName(evaluationResultName)

matchEvaluationFromEvaluationResultName(evaluationResultName: string): string | number;

Parse the evaluation from EvaluationResult resource.

Parameter
Name	Description
evaluationResultName	string A fully-qualified path representing EvaluationResult resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation.

matchEvaluationResultFromEvaluationResultName(evaluationResultName)

matchEvaluationResultFromEvaluationResultName(evaluationResultName: string): string | number;

Parse the evaluation_result from EvaluationResult resource.

Parameter
Name	Description
evaluationResultName	string A fully-qualified path representing EvaluationResult resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation_result.

matchEvaluationRunFromEvaluationRunName(evaluationRunName)

matchEvaluationRunFromEvaluationRunName(evaluationRunName: string): string | number;

Parse the evaluation_run from EvaluationRun resource.

Parameter
Name	Description
evaluationRunName	string A fully-qualified path representing EvaluationRun resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation_run.

matchExampleFromExampleName(exampleName)

matchExampleFromExampleName(exampleName: string): string | number;

Parse the example from Example resource.

Parameter
Name	Description
exampleName	string A fully-qualified path representing Example resource.

Returns
Type	Description
string | number	{string} A string representing the example.

matchGuardrailFromGuardrailName(guardrailName)

matchGuardrailFromGuardrailName(guardrailName: string): string | number;

Parse the guardrail from Guardrail resource.

Parameter
Name	Description
guardrailName	string A fully-qualified path representing Guardrail resource.

Returns
Type	Description
string | number	{string} A string representing the guardrail.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter
Name	Description
agentName	string A fully-qualified path representing Agent resource.

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

matchLocationFromAppName(appName)

matchLocationFromAppName(appName: string): string | number;

Parse the location from App resource.

Parameter
Name	Description
appName	string A fully-qualified path representing App resource.

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

matchLocationFromAppVersionName(appVersionName)

matchLocationFromAppVersionName(appVersionName: string): string | number;

Parse the location from AppVersion resource.

Parameter
Name	Description
appVersionName	string A fully-qualified path representing AppVersion resource.

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

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter
Name	Description
changelogName	string A fully-qualified path representing Changelog resource.

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

matchLocationFromConversationName(conversationName)

matchLocationFromConversationName(conversationName: string): string | number;

Parse the location from Conversation resource.

Parameter
Name	Description
conversationName	string A fully-qualified path representing Conversation resource.

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

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment resource.

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

matchLocationFromEvaluationDatasetName(evaluationDatasetName)

matchLocationFromEvaluationDatasetName(evaluationDatasetName: string): string | number;

Parse the location from EvaluationDataset resource.

Parameter
Name	Description
evaluationDatasetName	string A fully-qualified path representing EvaluationDataset resource.

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

matchLocationFromEvaluationExpectationName(evaluationExpectationName)

matchLocationFromEvaluationExpectationName(evaluationExpectationName: string): string | number;

Parse the location from EvaluationExpectation resource.

Parameter
Name	Description
evaluationExpectationName	string A fully-qualified path representing EvaluationExpectation resource.

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

matchLocationFromEvaluationName(evaluationName)

matchLocationFromEvaluationName(evaluationName: string): string | number;

Parse the location from Evaluation resource.

Parameter
Name	Description
evaluationName	string A fully-qualified path representing Evaluation resource.

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

matchLocationFromEvaluationResultName(evaluationResultName)

matchLocationFromEvaluationResultName(evaluationResultName: string): string | number;

Parse the location from EvaluationResult resource.

Parameter
Name	Description
evaluationResultName	string A fully-qualified path representing EvaluationResult resource.

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

matchLocationFromEvaluationRunName(evaluationRunName)

matchLocationFromEvaluationRunName(evaluationRunName: string): string | number;

Parse the location from EvaluationRun resource.

Parameter
Name	Description
evaluationRunName	string A fully-qualified path representing EvaluationRun resource.

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

matchLocationFromExampleName(exampleName)

matchLocationFromExampleName(exampleName: string): string | number;

Parse the location from Example resource.

Parameter
Name	Description
exampleName	string A fully-qualified path representing Example resource.

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

matchLocationFromGuardrailName(guardrailName)

matchLocationFromGuardrailName(guardrailName: string): string | number;

Parse the location from Guardrail resource.

Parameter
Name	Description
guardrailName	string A fully-qualified path representing Guardrail resource.

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

matchLocationFromOmnichannelName(omnichannelName)

matchLocationFromOmnichannelName(omnichannelName: string): string | number;

Parse the location from Omnichannel resource.

Parameter
Name	Description
omnichannelName	string A fully-qualified path representing Omnichannel resource.

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

matchLocationFromScheduledEvaluationRunName(scheduledEvaluationRunName)

matchLocationFromScheduledEvaluationRunName(scheduledEvaluationRunName: string): string | number;

Parse the location from ScheduledEvaluationRun resource.

Parameter
Name	Description
scheduledEvaluationRunName	string A fully-qualified path representing ScheduledEvaluationRun resource.

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

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter
Name	Description
securitySettingsName	string A fully-qualified path representing SecuritySettings resource.

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

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

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

matchLocationFromToolName(toolName)

matchLocationFromToolName(toolName: string): string | number;

Parse the location from Tool resource.

Parameter
Name	Description
toolName	string A fully-qualified path representing Tool resource.

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

matchLocationFromToolsetName(toolsetName)

matchLocationFromToolsetName(toolsetName: string): string | number;

Parse the location from Toolset resource.

Parameter
Name	Description
toolsetName	string A fully-qualified path representing Toolset resource.

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

matchOmnichannelFromOmnichannelName(omnichannelName)

matchOmnichannelFromOmnichannelName(omnichannelName: string): string | number;

Parse the omnichannel from Omnichannel resource.

Parameter
Name	Description
omnichannelName	string A fully-qualified path representing Omnichannel resource.

Returns
Type	Description
string | number	{string} A string representing the omnichannel.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter
Name	Description
agentName	string A fully-qualified path representing Agent resource.

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

matchProjectFromAppName(appName)

matchProjectFromAppName(appName: string): string | number;

Parse the project from App resource.

Parameter
Name	Description
appName	string A fully-qualified path representing App resource.

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

matchProjectFromAppVersionName(appVersionName)

matchProjectFromAppVersionName(appVersionName: string): string | number;

Parse the project from AppVersion resource.

Parameter
Name	Description
appVersionName	string A fully-qualified path representing AppVersion resource.

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

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter
Name	Description
changelogName	string A fully-qualified path representing Changelog resource.

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

matchProjectFromConversationName(conversationName)

matchProjectFromConversationName(conversationName: string): string | number;

Parse the project from Conversation resource.

Parameter
Name	Description
conversationName	string A fully-qualified path representing Conversation resource.

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

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment resource.

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

matchProjectFromEvaluationDatasetName(evaluationDatasetName)

matchProjectFromEvaluationDatasetName(evaluationDatasetName: string): string | number;

Parse the project from EvaluationDataset resource.

Parameter
Name	Description
evaluationDatasetName	string A fully-qualified path representing EvaluationDataset resource.

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

matchProjectFromEvaluationExpectationName(evaluationExpectationName)

matchProjectFromEvaluationExpectationName(evaluationExpectationName: string): string | number;

Parse the project from EvaluationExpectation resource.

Parameter
Name	Description
evaluationExpectationName	string A fully-qualified path representing EvaluationExpectation resource.

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

matchProjectFromEvaluationName(evaluationName)

matchProjectFromEvaluationName(evaluationName: string): string | number;

Parse the project from Evaluation resource.

Parameter
Name	Description
evaluationName	string A fully-qualified path representing Evaluation resource.

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

matchProjectFromEvaluationResultName(evaluationResultName)

matchProjectFromEvaluationResultName(evaluationResultName: string): string | number;

Parse the project from EvaluationResult resource.

Parameter
Name	Description
evaluationResultName	string A fully-qualified path representing EvaluationResult resource.

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

matchProjectFromEvaluationRunName(evaluationRunName)

matchProjectFromEvaluationRunName(evaluationRunName: string): string | number;

Parse the project from EvaluationRun resource.

Parameter
Name	Description
evaluationRunName	string A fully-qualified path representing EvaluationRun resource.

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

matchProjectFromExampleName(exampleName)

matchProjectFromExampleName(exampleName: string): string | number;

Parse the project from Example resource.

Parameter
Name	Description
exampleName	string A fully-qualified path representing Example resource.

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

matchProjectFromGuardrailName(guardrailName)

matchProjectFromGuardrailName(guardrailName: string): string | number;

Parse the project from Guardrail resource.

Parameter
Name	Description
guardrailName	string A fully-qualified path representing Guardrail resource.

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

matchProjectFromOmnichannelName(omnichannelName)

matchProjectFromOmnichannelName(omnichannelName: string): string | number;

Parse the project from Omnichannel resource.

Parameter
Name	Description
omnichannelName	string A fully-qualified path representing Omnichannel resource.

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

matchProjectFromScheduledEvaluationRunName(scheduledEvaluationRunName)

matchProjectFromScheduledEvaluationRunName(scheduledEvaluationRunName: string): string | number;

Parse the project from ScheduledEvaluationRun resource.

Parameter
Name	Description
scheduledEvaluationRunName	string A fully-qualified path representing ScheduledEvaluationRun resource.

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

matchProjectFromSecuritySettingsName(securitySettingsName)

matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the project from SecuritySettings resource.

Parameter
Name	Description
securitySettingsName	string A fully-qualified path representing SecuritySettings resource.

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

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

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

matchProjectFromToolName(toolName)

matchProjectFromToolName(toolName: string): string | number;

Parse the project from Tool resource.

Parameter
Name	Description
toolName	string A fully-qualified path representing Tool resource.

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

matchProjectFromToolsetName(toolsetName)

matchProjectFromToolsetName(toolsetName: string): string | number;

Parse the project from Toolset resource.

Parameter
Name	Description
toolsetName	string A fully-qualified path representing Toolset resource.

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

matchScheduledEvaluationRunFromScheduledEvaluationRunName(scheduledEvaluationRunName)

matchScheduledEvaluationRunFromScheduledEvaluationRunName(scheduledEvaluationRunName: string): string | number;

Parse the scheduled_evaluation_run from ScheduledEvaluationRun resource.

Parameter
Name	Description
scheduledEvaluationRunName	string A fully-qualified path representing ScheduledEvaluationRun resource.

Returns
Type	Description
string | number	{string} A string representing the scheduled_evaluation_run.

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

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

matchToolFromToolName(toolName)

matchToolFromToolName(toolName: string): string | number;

Parse the tool from Tool resource.

Parameter
Name	Description
toolName	string A fully-qualified path representing Tool resource.

Returns
Type	Description
string | number	{string} A string representing the tool.

matchToolsetFromToolsetName(toolsetName)

matchToolsetFromToolsetName(toolsetName: string): string | number;

Parse the toolset from Toolset resource.

Parameter
Name	Description
toolsetName	string A fully-qualified path representing Toolset resource.

Returns
Type	Description
string | number	{string} A string representing the toolset.

matchVersionFromAppVersionName(appVersionName)

matchVersionFromAppVersionName(appVersionName: string): string | number;

Parse the version from AppVersion resource.

Parameter
Name	Description
appVersionName	string A fully-qualified path representing AppVersion resource.

Returns
Type	Description
string | number	{string} A string representing the version.

omnichannelPath(project, location, omnichannel)

omnichannelPath(project: string, location: string, omnichannel: string): string;

Return a fully-qualified omnichannel resource name string.

Parameters
Name	Description
project	string
location	string
omnichannel	string

Returns
Type	Description
string	{string} Resource name string.

scheduledEvaluationRunPath(project, location, app, scheduledEvaluationRun)

scheduledEvaluationRunPath(project: string, location: string, app: string, scheduledEvaluationRun: string): string;

Return a fully-qualified scheduledEvaluationRun resource name string.

Parameters
Name	Description
project	string
location	string
app	string
scheduledEvaluationRun	string

Returns
Type	Description
string	{string} Resource name string.

securitySettingsPath(project, location)

securitySettingsPath(project: string, location: string): string;

Return a fully-qualified securitySettings resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

sessionPath(project, location, app, session)

sessionPath(project: string, location: string, app: string, session: string): string;

Return a fully-qualified session resource name string.

Parameters
Name	Description
project	string
location	string
app	string
session	string

Returns
Type	Description
string	{string} Resource name string.

toolPath(project, location, app, tool)

toolPath(project: string, location: string, app: string, tool: string): string;

Return a fully-qualified tool resource name string.

Parameters
Name	Description
project	string
location	string
app	string
tool	string

Returns
Type	Description
string	{string} Resource name string.

toolsetPath(project, location, app, toolset)

toolsetPath(project: string, location: string, app: string, toolset: string): string;

Return a fully-qualified toolset resource name string.

Parameters
Name	Description
project	string
location	string
app	string
toolset	string

Returns
Type	Description
string	{string} Resource name string.