UNPKG

@google-cloud/dialogflow

Version:
949 lines 91.2 kB
import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Generator Service for LLM powered Agent Assist. This service manages the * configurations of user owned Generators, such as description, context and * instruction, input/output format, etc. The generator resources will be used * inside a conversation and will be triggered by TriggerEvent to query LLM for * answers. * @class * @memberof v2 */ export declare class GeneratorsClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; generatorsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of GeneratorsClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: 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 GeneratorsClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Creates a generator. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project/location to create generator for. Format: * `projects/<Project ID>/locations/<Location ID>` * @param {google.cloud.dialogflow.v2.Generator} request.generator * Required. The generator to create. * @param {string} [request.generatorId] * Optional. The ID to use for the generator, which will become the final * component of the generator's resource name. * * The generator ID must be compliant with the regression formula * `{@link protos.a-zA-Z0-9_-|a-zA-Z}*` with the characters length in range of [3,64]. * If the field is not provided, an Id will be auto-generated. * If the field is provided, the caller is responsible for * 1. the uniqueness of the ID, otherwise the request will be rejected. * 2. the consistency for whether to use custom ID or not under a project to * better ensure uniqueness. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2.Generator|Generator}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v2/generators.create_generator.js</caption> * region_tag:dialogflow_v2_generated_Generators_CreateGenerator_async */ createGenerator(request?: protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest | undefined, {} | undefined ]>; createGenerator(request: protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest | null | undefined, {} | null | undefined>): void; createGenerator(request: protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.ICreateGeneratorRequest | null | undefined, {} | null | undefined>): void; /** * Retrieves a generator. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The generator resource name to retrieve. Format: * `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2.Generator|Generator}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v2/generators.get_generator.js</caption> * region_tag:dialogflow_v2_generated_Generators_GetGenerator_async */ getGenerator(request?: protos.google.cloud.dialogflow.v2.IGetGeneratorRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IGetGeneratorRequest | undefined, {} | undefined ]>; getGenerator(request: protos.google.cloud.dialogflow.v2.IGetGeneratorRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IGetGeneratorRequest | null | undefined, {} | null | undefined>): void; getGenerator(request: protos.google.cloud.dialogflow.v2.IGetGeneratorRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IGetGeneratorRequest | null | undefined, {} | null | undefined>): void; /** * Deletes a generator. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The generator resource name to delete. Format: * `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v2/generators.delete_generator.js</caption> * region_tag:dialogflow_v2_generated_Generators_DeleteGenerator_async */ deleteGenerator(request?: protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest | undefined, {} | undefined ]>; deleteGenerator(request: protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest | null | undefined, {} | null | undefined>): void; deleteGenerator(request: protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteGeneratorRequest | null | undefined, {} | null | undefined>): void; /** * Updates a generator. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.dialogflow.v2.Generator} request.generator * Required. The generator to update. * The name field of generator is to identify the generator to update. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. The list of fields to update. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2.Generator|Generator}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v2/generators.update_generator.js</caption> * region_tag:dialogflow_v2_generated_Generators_UpdateGenerator_async */ updateGenerator(request?: protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest | undefined, {} | undefined ]>; updateGenerator(request: protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest | null | undefined, {} | null | undefined>): void; updateGenerator(request: protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IGenerator, protos.google.cloud.dialogflow.v2.IUpdateGeneratorRequest | null | undefined, {} | null | undefined>): void; /** * Lists generators. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project/location to list generators for. Format: * `projects/<Project ID>/locations/<Location ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single page. * Default to 10. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.dialogflow.v2.Generator|Generator}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listGeneratorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listGenerators(request?: protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IGenerator[], protos.google.cloud.dialogflow.v2.IListGeneratorsRequest | null, protos.google.cloud.dialogflow.v2.IListGeneratorsResponse ]>; listGenerators(request: protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, protos.google.cloud.dialogflow.v2.IListGeneratorsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IGenerator>): void; listGenerators(request: protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, protos.google.cloud.dialogflow.v2.IListGeneratorsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IGenerator>): void; /** * Equivalent to `listGenerators`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project/location to list generators for. Format: * `projects/<Project ID>/locations/<Location ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single page. * Default to 10. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.dialogflow.v2.Generator|Generator} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listGeneratorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listGeneratorsStream(request?: protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, options?: CallOptions): Transform; /** * Equivalent to `listGenerators`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project/location to list generators for. Format: * `projects/<Project ID>/locations/<Location ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single page. * Default to 10. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.dialogflow.v2.Generator|Generator}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example <caption>include:samples/generated/v2/generators.list_generators.js</caption> * region_tag:dialogflow_v2_generated_Generators_ListGenerators_async */ listGeneratorsAsync(request?: protos.google.cloud.dialogflow.v2.IListGeneratorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IGenerator>; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ 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>; /** * 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. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>; /** * Return a fully-qualified conversationDataset resource name string. * * @param {string} project * @param {string} location * @param {string} conversation_dataset * @returns {string} Resource name string. */ conversationDatasetPath(project: string, location: string, conversationDataset: string): string; /** * Parse the project from ConversationDataset resource. * * @param {string} conversationDatasetName * A fully-qualified path representing ConversationDataset resource. * @returns {string} A string representing the project. */ matchProjectFromConversationDatasetName(conversationDatasetName: string): string | number; /** * Parse the location from ConversationDataset resource. * * @param {string} conversationDatasetName * A fully-qualified path representing ConversationDataset resource. * @returns {string} A string representing the location. */ matchLocationFromConversationDatasetName(conversationDatasetName: string): string | number; /** * Parse the conversation_dataset from ConversationDataset resource. * * @param {string} conversationDatasetName * A fully-qualified path representing ConversationDataset resource. * @returns {string} A string representing the conversation_dataset. */ matchConversationDatasetFromConversationDatasetName(conversationDatasetName: string): string | number; /** * Return a fully-qualified encryptionSpec resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ encryptionSpecPath(project: string, location: string): string; /** * Parse the project from EncryptionSpec resource. * * @param {string} encryptionSpecName * A fully-qualified path representing EncryptionSpec resource. * @returns {string} A string representing the project. */ matchProjectFromEncryptionSpecName(encryptionSpecName: string): string | number; /** * Parse the location from EncryptionSpec resource. * * @param {string} encryptionSpecName * A fully-qualified path representing EncryptionSpec resource. * @returns {string} A string representing the location. */ matchLocationFromEncryptionSpecName(encryptionSpecName: string): string | number; /** * Return a fully-qualified generator resource name string. * * @param {string} project * @param {string} location * @param {string} generator * @returns {string} Resource name string. */ generatorPath(project: string, location: string, generator: string): string; /** * Parse the project from Generator resource. * * @param {string} generatorName * A fully-qualified path representing Generator resource. * @returns {string} A string representing the project. */ matchProjectFromGeneratorName(generatorName: string): string | number; /** * Parse the location from Generator resource. * * @param {string} generatorName * A fully-qualified path representing Generator resource. * @returns {string} A string representing the location. */ matchLocationFromGeneratorName(generatorName: string): string | number; /** * Parse the generator from Generator resource. * * @param {string} generatorName * A fully-qualified path representing Generator resource. * @returns {string} A string representing the generator. */ matchGeneratorFromGeneratorName(generatorName: string): string | number; /** * Return a fully-qualified project resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectPath(project: string): string; /** * Parse the project from Project resource. * * @param {string} projectName * A fully-qualified path representing Project resource. * @returns {string} A string representing the project. */ matchProjectFromProjectName(projectName: string): string | number; /** * Return a fully-qualified projectAgent resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectAgentPath(project: string): string; /** * Parse the project from ProjectAgent resource. * * @param {string} projectAgentName * A fully-qualified path representing project_agent resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentName(projectAgentName: string): string | number; /** * Return a fully-qualified projectAgentEntityType resource name string. * * @param {string} project * @param {string} entity_type * @returns {string} Resource name string. */ projectAgentEntityTypePath(project: string, entityType: string): string; /** * Parse the project from ProjectAgentEntityType resource. * * @param {string} projectAgentEntityTypeName * A fully-qualified path representing project_agent_entity_type resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number; /** * Parse the entity_type from ProjectAgentEntityType resource. * * @param {string} projectAgentEntityTypeName * A fully-qualified path representing project_agent_entity_type resource. * @returns {string} A string representing the entity_type. */ matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number; /** * Return a fully-qualified projectAgentEnvironment resource name string. * * @param {string} project * @param {string} environment * @returns {string} Resource name string. */ projectAgentEnvironmentPath(project: string, environment: string): string; /** * Parse the project from ProjectAgentEnvironment resource. * * @param {string} projectAgentEnvironmentName * A fully-qualified path representing project_agent_environment resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number; /** * Parse the environment from ProjectAgentEnvironment resource. * * @param {string} projectAgentEnvironmentName * A fully-qualified path representing project_agent_environment resource. * @returns {string} A string representing the environment. */ matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number; /** * Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string. * * @param {string} project * @param {string} environment * @param {string} user * @param {string} session * @param {string} context * @returns {string} Resource name string. */ projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string; /** * Parse the project from ProjectAgentEnvironmentUserSessionContext resource. * * @param {string} projectAgentEnvironmentUserSessionContextName * A fully-qualified path representing project_agent_environment_user_session_context resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number; /** * Parse the environment from ProjectAgentEnvironmentUserSessionContext resource. * * @param {string} projectAgentEnvironmentUserSessionContextName * A fully-qualified path representing project_agent_environment_user_session_context resource. * @returns {string} A string representing the environment. */ matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number; /** * Parse the user from ProjectAgentEnvironmentUserSessionContext resource. * * @param {string} projectAgentEnvironmentUserSessionContextName * A fully-qualified path representing project_agent_environment_user_session_context resource. * @returns {string} A string representing the user. */ matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number; /** * Parse the session from ProjectAgentEnvironmentUserSessionContext resource. * * @param {string} projectAgentEnvironmentUserSessionContextName * A fully-qualified path representing project_agent_environment_user_session_context resource. * @returns {string} A string representing the session. */ matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number; /** * Parse the context from ProjectAgentEnvironmentUserSessionContext resource. * * @param {string} projectAgentEnvironmentUserSessionContextName * A fully-qualified path representing project_agent_environment_user_session_context resource. * @returns {string} A string representing the context. */ matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number; /** * Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string. * * @param {string} project * @param {string} environment * @param {string} user * @param {string} session * @param {string} entity_type * @returns {string} Resource name string. */ projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string; /** * Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource. * * @param {string} projectAgentEnvironmentUserSessionEntityTypeName * A fully-qualified path representing project_agent_environment_user_session_entity_type resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number; /** * Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource. * * @param {string} projectAgentEnvironmentUserSessionEntityTypeName * A fully-qualified path representing project_agent_environment_user_session_entity_type resource. * @returns {string} A string representing the environment. */ matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number; /** * Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource. * * @param {string} projectAgentEnvironmentUserSessionEntityTypeName * A fully-qualified path representing project_agent_environment_user_session_entity_type resource. * @returns {string} A string representing the user. */ matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number; /** * Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource. * * @param {string} projectAgentEnvironmentUserSessionEntityTypeName * A fully-qualified path representing project_agent_environment_user_session_entity_type resource. * @returns {string} A string representing the session. */ matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number; /** * Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource. * * @param {string} projectAgentEnvironmentUserSessionEntityTypeName * A fully-qualified path representing project_agent_environment_user_session_entity_type resource. * @returns {string} A string representing the entity_type. */ matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number; /** * Return a fully-qualified projectAgentFulfillment resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectAgentFulfillmentPath(project: string): string; /** * Parse the project from ProjectAgentFulfillment resource. * * @param {string} projectAgentFulfillmentName * A fully-qualified path representing project_agent_fulfillment resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName: string): string | number; /** * Return a fully-qualified projectAgentIntent resource name string. * * @param {string} project * @param {string} intent * @returns {string} Resource name string. */ projectAgentIntentPath(project: string, intent: string): string; /** * Parse the project from ProjectAgentIntent resource. * * @param {string} projectAgentIntentName * A fully-qualified path representing project_agent_intent resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number; /** * Parse the intent from ProjectAgentIntent resource. * * @param {string} projectAgentIntentName * A fully-qualified path representing project_agent_intent resource. * @returns {string} A string representing the intent. */ matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number; /** * Return a fully-qualified projectAgentSessionContext resource name string. * * @param {string} project * @param {string} session * @param {string} context * @returns {string} Resource name string. */ projectAgentSessionContextPath(project: string, session: string, context: string): string; /** * Parse the project from ProjectAgentSessionContext resource. * * @param {string} projectAgentSessionContextName * A fully-qualified path representing project_agent_session_context resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number; /** * Parse the session from ProjectAgentSessionContext resource. * * @param {string} projectAgentSessionContextName * A fully-qualified path representing project_agent_session_context resource. * @returns {string} A string representing the session. */ matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number; /** * Parse the context from ProjectAgentSessionContext resource. * * @param {string} projectAgentSessionContextName * A fully-qualified path representing project_agent_session_context resource. * @returns {string} A string representing the context. */ matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number; /** * Return a fully-qualified projectAgentSessionEntityType resource name string. * * @param {string} project * @param {string} session * @param {string} entity_type * @returns {string} Resource name string. */ projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string; /** * Parse the project from ProjectAgentSessionEntityType resource. * * @param {string} projectAgentSessionEntityTypeName * A fully-qualified path representing project_agent_session_entity_type resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number; /** * Parse the session from ProjectAgentSessionEntityType resource. * * @param {string} projectAgentSessionEntityTypeName * A fully-qualified path representing project_agent_session_entity_type resource. * @returns {string} A string representing the session. */ matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number; /** * Parse the entity_type from ProjectAgentSessionEntityType resource. * * @param {string} projectAgentSessionEntityTypeName * A fully-qualified path representing project_agent_session_entity_type resource. * @returns {string} A string representing the entity_type. */ matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number; /** * Return a fully-qualified projectAgentVersion resource name string. * * @param {string} project * @param {string} version * @returns {string} Resource name string. */ projectAgentVersionPath(project: string, version: string): string; /** * Parse the project from ProjectAgentVersion resource. * * @param {string} projectAgentVersionName * A fully-qualified path representing project_agent_version resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAgentVersionName(projectAgentVersionName: string): string | number; /** * Parse the version from ProjectAgentVersion resource. * * @param {string} projectAgentVersionName * A fully-qualified path representing project_agent_version resource. * @returns {string} A string representing the version. */ matchVersionFromProjectAgentVersionName(projectAgentVersionName: string): string | number; /** * Return a fully-qualified projectAnswerRecord resource name string. * * @param {string} project * @param {string} answer_record * @returns {string} Resource name string. */ projectAnswerRecordPath(project: string, answerRecord: string): string; /** * Parse the project from ProjectAnswerRecord resource. * * @param {string} projectAnswerRecordName * A fully-qualified path representing project_answer_record resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number; /** * Parse the answer_record from ProjectAnswerRecord resource. * * @param {string} projectAnswerRecordName * A fully-qualified path representing project_answer_record resource. * @returns {string} A string representing the answer_record. */ matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number; /** * Return a fully-qualified projectConversationMessage resource name string. * * @param {string} project * @param {string} conversation * @param {string} message * @returns {string} Resource name string. */ projectConversationMessagePath(project: string, conversation: string, message: string): string; /** * Parse the project from ProjectConversationMessage resource. * * @param {string} projectConversationMessageName * A fully-qualified path representing project_conversation_message resource. * @returns {string} A string representing the project. */ matchProjectFromProjectConversationMessageName(projectConversationMessageName: string): string | number; /** * Parse the conversation from ProjectConversationMessage resource. * * @param {string} projectConversationMessageName * A fully-qualified path representing project_conversation_message resource. * @returns {string} A string representing the conversation. */ matchConversationFromProjectConversationMessageName(projectConversationMessageName: string): string | number; /** * Parse the message from ProjectConversationMessage resource. * * @param {string} projectConversationMessageName * A fully-qualified path representing project_conversation_message resource. * @returns {string} A string representing the message. */ matchMessageFromProjectConversationMessageName(projectConversationMessageName: string): string | number; /** * Return a fully-qualified projectConversationModel resource name string. * * @param {string} project * @param {string} conversation_model * @returns {string} Resource name string. */ projectConversationModelPath(project: string, conversationModel: string): string; /** * Parse the project from ProjectConversationModel resource. * * @param {string} projectConversationModelName * A fully-qualified path representing project_conversation_model resource. * @returns {string} A string representing the project. */ matchProjectFromProjectConversationModelName(projectConversationModelName: string): string | number; /** * Parse the conversation_model from ProjectConversationModel resource. * * @param {string} projectConversationModelName * A fully-qualified path representing project_conversation_model resource. * @returns {string} A string representing the conversation_model. */ matchConversationModelFromProjectConversationModelName(projectConversationModelName: string): string | number; /** * Return a fully-qualified projectConversationModelEvaluation resource name string. * * @param {string} project * @param {string} conversation_model * @param {string} evaluation * @returns {string} Resource name string. */ projectConversationModelEvaluationPath(project: string, conversationModel: string, evaluation: string): string; /** * Parse the project from ProjectConversationModelEvaluation resource. * * @param {string} projectConversationModelEvaluationName * A fully-qualified path representing project_conversation_model_evaluation resource. * @returns {string} A string representing the project. */ matchProjectFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number; /** * Parse the conversation_model from ProjectConversationModelEvaluation resource. * * @param {string} projectConversationModelEvaluationName * A fully-qualified path representing project_conversation_model_evaluation resource. * @returns {string} A string representing the conversation_model. */ matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number; /** * Parse the evaluation from ProjectConversationModelEvaluation resource. * * @param {string} projectConversationModelEvaluationName * A fully-qualified path representing project_conversation_model_evaluation resource. * @returns {string} A string representing the evaluation. */ matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number; /** * Return a fully-qualified projectConversationParticipant resource name string. * * @param {string} project * @param {string} conversation * @param {string} participant * @returns {string} Resource name string. */ projectConversationParticipantPath(project: string, conversation: string, participant: string): string; /** * Parse the project from ProjectConversationParticipant resource. * * @param {string} projectConversationParticipantName * A fully-qualified path representing project_conversation_participant resource. * @returns {string} A string representing the project. */ matchProjectFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number; /** * Parse the conversation from ProjectConversationParticipant resource. * * @param {string} projectConversationParticipantName * A fully-qualified path representing project_conversation_participant resource. * @returns {string} A string representing the conversation. */ matchConversationFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number; /** * Parse the participant from ProjectConversationParticipant resource. * * @param {string} projectConversationParticipantName * A fully-qualified path representing project_conversation_participant resource. * @returns {string} A string representing the participant. */ matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number; /** * Return a fully-qualified projectConversationProfile resource name string. * * @param {string} project * @param {string} conversation_profile * @returns {string} Resource name string. */ projectConversationProfilePath(project: string, conversationProfile: string): string; /** * Parse the project from ProjectConversationProfile resource. * * @param {string} projectConversationProfileName * A fully-qualified path representing project_conversation_profile resource. * @returns {string} A string representing the project. */ matchProjectFromProjectConversationProfileName(projectConversationProfileName: string): string | number; /** * Parse the conversation_profile from ProjectConversationProfile resource. * * @param {string} projectConversationProfileName * A fully-qualified path representing project_conversation_profile resource. * @returns {string} A string representing the conversation_profile. */ matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName: string): string | number; /** * Return a fully-qualified projectConversations resource name string. * * @param {string} project * @param {string} conversation * @returns {string} Resource name string. */ projectConversationsPath(project: string, conversation: string): string; /** * Parse the project from ProjectConversations resource. * * @param {string} proje