A service used for session interactions.
For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). v2beta1
Package
@google-cloud/dialogflow!Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);Construct an instance of SessionsClient.
| Name | Description |
| opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
| Type | Description |
| string |
auth
auth: gax.GoogleAuth;| Type | Description |
| gax.GoogleAuth |
descriptors
descriptors: Descriptors;| Type | Description |
| Descriptors |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};| Type | Description |
| { [name: string]: Function; } |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};| Type | Description |
| { [name: string]: gax.PathTemplate; } |
port
static get port(): number;The port for this API service.
| Type | Description |
| number |
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
| Type | Description |
| string[] |
servicePath
static get servicePath(): string;The DNS address for this API service.
| Type | Description |
| string |
sessionsStub
sessionsStub?: Promise<{
[name: string]: Function;
}>;| Type | Description |
| Promise<{ [name: string]: Function; }> |
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.
| Type | Description |
| Promise<void> | {Promise} A promise that resolves when the client is closed. |
detectIntent(request, options)
detectIntent(request: protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | undefined, {} | undefined]>;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest
|
| options |
CallOptions
|
| Type | Description |
| Promise<[protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | undefined, {} | undefined]> |
detectIntent(request, options, callback)
detectIntent(request: protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest
|
| options |
CallOptions
|
| callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | null | undefined, {} | null | undefined>
|
| Type | Description |
| void |
detectIntent(request, callback)
detectIntent(request: protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest
|
| callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IDetectIntentResponse, protos.google.cloud.dialogflow.v2beta1.IDetectIntentRequest | null | undefined, {} | null | undefined>
|
| Type | Description |
| void |
getProjectId()
getProjectId(): Promise<string>;| Type | Description |
| Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;| Name | Description |
| callback |
Callback<string, undefined, undefined>
|
| 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.
| Type | Description |
| Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the context. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the context from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the context. |
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;Parse the context from ProjectLocationAgentSessionContext resource.
| Name | Description |
| projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the context. |
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;Parse the document from ProjectKnowledgeBaseDocument resource.
| Name | Description |
| projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the document. |
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;Parse the document from ProjectLocationKnowledgeBaseDocument resource.
| Name | Description |
| projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the document. |
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;Parse the entity_type from ProjectAgentEntityType resource.
| Name | Description |
| projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the entity_type from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;Parse the entity_type from ProjectLocationAgentEntityType resource.
| Name | Description |
| projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;Parse the entity_type from ProjectLocationAgentSessionEntityType resource.
| Name | Description |
| projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;Parse the environment from ProjectAgentEnvironment resource.
| Name | Description |
| projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;Parse the environment from ProjectAgentEnvironmentUserSession resource.
| Name | Description |
| projectAgentEnvironmentUserSessionName |
string
A fully-qualified path representing project_agent_environment_user_session resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;Parse the environment from ProjectLocationAgentEnvironment resource.
| Name | Description |
| projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchIntentFromProjectAgentIntentName(projectAgentIntentName)
matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number;Parse the intent from ProjectAgentIntent resource.
| Name | Description |
| projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
| Type | Description |
| string | number | {string} A string representing the intent. |
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;Parse the intent from ProjectLocationAgentIntent resource.
| Name | Description |
| projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
| Type | Description |
| string | number | {string} A string representing the intent. |
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.
| Name | Description |
| projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName)
matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;Parse the knowledge_base from ProjectKnowledgeBase resource.
| Name | Description |
| projectKnowledgeBaseName |
string
A fully-qualified path representing project_knowledge_base resource. |
| Type | Description |
| string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.
| Name | Description |
| projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;Parse the knowledge_base from ProjectLocationKnowledgeBase resource.
| Name | Description |
| projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
| Type | Description |
| string | number | {string} A string representing the knowledge_base. |
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;Parse the location from ProjectLocationAgentEntityType resource.
| Name | Description |
| projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;Parse the location from ProjectLocationAgentEnvironment resource.
| Name | Description |
| projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;Parse the location from ProjectLocationAgentIntent resource.
| Name | Description |
| projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentName(projectLocationAgentName)
matchLocationFromProjectLocationAgentName(projectLocationAgentName: string): string | number;Parse the location from ProjectLocationAgent resource.
| Name | Description |
| projectLocationAgentName |
string
A fully-qualified path representing project_location_agent resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;Parse the location from ProjectLocationAgentSessionContext resource.
| Name | Description |
| projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;Parse the location from ProjectLocationAgentSessionEntityType resource.
| Name | Description |
| projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;Parse the location from ProjectLocationAgentSession resource.
| Name | Description |
| projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;Parse the location from ProjectLocationKnowledgeBaseDocument resource.
| Name | Description |
| projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;Parse the location from ProjectLocationKnowledgeBase resource.
| Name | Description |
| projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;Parse the project from ProjectAgentEntityType resource.
| Name | Description |
| projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;Parse the project from ProjectAgentEnvironment resource.
| Name | Description |
| projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)
matchProjectFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;Parse the project from ProjectAgentEnvironmentUserSession resource.
| Name | Description |
| projectAgentEnvironmentUserSessionName |
string
A fully-qualified path representing project_agent_environment_user_session resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentIntentName(projectAgentIntentName)
matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number;Parse the project from ProjectAgentIntent resource.
| Name | Description |
| projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentName(projectAgentName)
matchProjectFromProjectAgentName(projectAgentName: string): string | number;Parse the project from ProjectAgent resource.
| Name | Description |
| projectAgentName |
string
A fully-qualified path representing project_agent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the project from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the project from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionName(projectAgentSessionName)
matchProjectFromProjectAgentSessionName(projectAgentSessionName: string): string | number;Parse the project from ProjectAgentSession resource.
| Name | Description |
| projectAgentSessionName |
string
A fully-qualified path representing project_agent_session resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;Parse the project from ProjectKnowledgeBaseDocument resource.
| Name | Description |
| projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName)
matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;Parse the project from ProjectKnowledgeBase resource.
| Name | Description |
| projectKnowledgeBaseName |
string
A fully-qualified path representing project_knowledge_base resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;Parse the project from ProjectLocationAgentEntityType resource.
| Name | Description |
| projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;Parse the project from ProjectLocationAgentEnvironment resource.
| Name | Description |
| projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;Parse the project from ProjectLocationAgentIntent resource.
| Name | Description |
| projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentName(projectLocationAgentName)
matchProjectFromProjectLocationAgentName(projectLocationAgentName: string): string | number;Parse the project from ProjectLocationAgent resource.
| Name | Description |
| projectLocationAgentName |
string
A fully-qualified path representing project_location_agent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;Parse the project from ProjectLocationAgentSessionContext resource.
| Name | Description |
| projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;Parse the project from ProjectLocationAgentSessionEntityType resource.
| Name | Description |
| projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;Parse the project from ProjectLocationAgentSession resource.
| Name | Description |
| projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;Parse the project from ProjectLocationKnowledgeBaseDocument resource.
| Name | Description |
| projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;Parse the project from ProjectLocationKnowledgeBase resource.
| Name | Description |
| projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)
matchSessionFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;Parse the session from ProjectAgentEnvironmentUserSession resource.
| Name | Description |
| projectAgentEnvironmentUserSessionName |
string
A fully-qualified path representing project_agent_environment_user_session resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the session from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the session from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionName(projectAgentSessionName)
matchSessionFromProjectAgentSessionName(projectAgentSessionName: string): string | number;Parse the session from ProjectAgentSession resource.
| Name | Description |
| projectAgentSessionName |
string
A fully-qualified path representing project_agent_session resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;Parse the session from ProjectLocationAgentSessionContext resource.
| Name | Description |
| projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;Parse the session from ProjectLocationAgentSessionEntityType resource.
| Name | Description |
| projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;Parse the session from ProjectLocationAgentSession resource.
| Name | Description |
| projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the user. |
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the user. |
matchUserFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)
matchUserFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;Parse the user from ProjectAgentEnvironmentUserSession resource.
| Name | Description |
| projectAgentEnvironmentUserSessionName |
string
A fully-qualified path representing project_agent_environment_user_session resource. |
| Type | Description |
| string | number | {string} A string representing the user. |
projectAgentEntityTypePath(project, entityType)
projectAgentEntityTypePath(project: string, entityType: string): string;Return a fully-qualified projectAgentEntityType resource name string.
| Name | Description |
| project |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentEnvironmentPath(project, environment)
projectAgentEnvironmentPath(project: string, environment: string): string;Return a fully-qualified projectAgentEnvironment resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)
projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| user |
string
|
| session |
string
|
| context |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)
projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string;Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| user |
string
|
| session |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentEnvironmentUserSessionPath(project, environment, user, session)
projectAgentEnvironmentUserSessionPath(project: string, environment: string, user: string, session: string): string;Return a fully-qualified projectAgentEnvironmentUserSession resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| user |
string
|
| session |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentIntentPath(project, intent)
projectAgentIntentPath(project: string, intent: string): string;Return a fully-qualified projectAgentIntent resource name string.
| Name | Description |
| project |
string
|
| intent |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentPath(project)
projectAgentPath(project: string): string;Return a fully-qualified projectAgent resource name string.
| Name | Description |
| project |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentSessionContextPath(project, session, context)
projectAgentSessionContextPath(project: string, session: string, context: string): string;Return a fully-qualified projectAgentSessionContext resource name string.
| Name | Description |
| project |
string
|
| session |
string
|
| context |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentSessionEntityTypePath(project, session, entityType)
projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string;Return a fully-qualified projectAgentSessionEntityType resource name string.
| Name | Description |
| project |
string
|
| session |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentSessionPath(project, session)
projectAgentSessionPath(project: string, session: string): string;Return a fully-qualified projectAgentSession resource name string.
| Name | Description |
| project |
string
|
| session |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectKnowledgeBaseDocumentPath(project, knowledgeBase, document)
projectKnowledgeBaseDocumentPath(project: string, knowledgeBase: string, document: string): string;Return a fully-qualified projectKnowledgeBaseDocument resource name string.
| Name | Description |
| project |
string
|
| knowledgeBase |
string
|
| document |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectKnowledgeBasePath(project, knowledgeBase)
projectKnowledgeBasePath(project: string, knowledgeBase: string): string;Return a fully-qualified projectKnowledgeBase resource name string.
| Name | Description |
| project |
string
|
| knowledgeBase |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentEntityTypePath(project, location, entityType)
projectLocationAgentEntityTypePath(project: string, location: string, entityType: string): string;Return a fully-qualified projectLocationAgentEntityType resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentEnvironmentPath(project, location, environment)
projectLocationAgentEnvironmentPath(project: string, location: string, environment: string): string;Return a fully-qualified projectLocationAgentEnvironment resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| environment |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentIntentPath(project, location, intent)
projectLocationAgentIntentPath(project: string, location: string, intent: string): string;Return a fully-qualified projectLocationAgentIntent resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| intent |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentPath(project, location)
projectLocationAgentPath(project: string, location: string): string;Return a fully-qualified projectLocationAgent resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentSessionContextPath(project, location, session, context)
projectLocationAgentSessionContextPath(project: string, location: string, session: string, context: string): string;Return a fully-qualified projectLocationAgentSessionContext resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| session |
string
|
| context |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentSessionEntityTypePath(project, location, session, entityType)
projectLocationAgentSessionEntityTypePath(project: string, location: string, session: string, entityType: string): string;Return a fully-qualified projectLocationAgentSessionEntityType resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| session |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationAgentSessionPath(project, location, session)
projectLocationAgentSessionPath(project: string, location: string, session: string): string;Return a fully-qualified projectLocationAgentSession resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| session |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationKnowledgeBaseDocumentPath(project, location, knowledgeBase, document)
projectLocationKnowledgeBaseDocumentPath(project: string, location: string, knowledgeBase: string, document: string): string;Return a fully-qualified projectLocationKnowledgeBaseDocument resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| knowledgeBase |
string
|
| document |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectLocationKnowledgeBasePath(project, location, knowledgeBase)
projectLocationKnowledgeBasePath(project: string, location: string, knowledgeBase: string): string;Return a fully-qualified projectLocationKnowledgeBase resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| knowledgeBase |
string
|
| Type | Description |
| string | {string} Resource name string. |
streamingDetectIntent(options)
streamingDetectIntent(options?: CallOptions): gax.CancellableStream;Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
| Name | Description |
| options |
CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| gax.CancellableStream | {Stream} An object stream which is both readable and writable. It accepts objects representing [StreamingDetectIntentRequest] for write() method, and will emit objects representing [StreamingDetectIntentResponse] on 'data' event asynchronously. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) for more details and examples. |