dialogflow
Version:
Dialogflow API client for Node.js
404 lines (368 loc) • 14.3 kB
JavaScript
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
;
const gapicConfig = require('./sessions_client_config.json');
const gax = require('google-gax');
const path = require('path');
const VERSION = require('../../package.json').version;
/**
* A session represents an interaction with a user. You retrieve user input
* and pass it to the DetectIntent (or
* StreamingDetectIntent) method to determine
* user intent and respond.
*
* @class
* @memberof v2
*/
class SessionsClient {
/**
* Construct an instance of SessionsClient.
*
* @param {object} [options] - The configuration object. See the subsequent
* parameters for more details.
* @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://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {function} [options.promise] - Custom promise module to use instead
* of native Promises.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
*/
constructor(opts) {
opts = opts || {};
this._descriptors = {};
if (global.isBrowser) {
// If we're in browser, we use gRPC fallback.
opts.fallback = true;
}
// If we are in browser, we are already using fallback because of the
// "browser" field in package.json.
// But if we were explicitly requested to use fallback, let's do it now.
const gaxModule = !global.isBrowser && opts.fallback ? gax.fallback : gax;
const servicePath =
opts.servicePath || opts.apiEndpoint || this.constructor.servicePath;
// Ensure that options include the service address and port.
opts = Object.assign(
{
clientConfig: {},
port: this.constructor.port,
servicePath,
},
opts
);
// Create a `gaxGrpc` object, with any grpc-specific options
// sent to the client.
opts.scopes = this.constructor.scopes;
const gaxGrpc = new gaxModule.GrpcClient(opts);
// Save the auth object to the client, for use by other methods.
this.auth = gaxGrpc.auth;
// Determine the client header string.
const clientHeader = [];
if (typeof process !== 'undefined' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
clientHeader.push(`gax/${gaxModule.version}`);
if (opts.fallback) {
clientHeader.push(`gl-web/${gaxModule.version}`);
} else {
clientHeader.push(`grpc/${gaxGrpc.grpcVersion}`);
}
clientHeader.push(`gapic/${VERSION}`);
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
// For Node.js, pass the path to JSON proto file.
// For browsers, pass the JSON content.
const nodejsProtoPath = path.join(
__dirname,
'..',
'..',
'protos',
'protos.json'
);
const protos = gaxGrpc.loadProto(
opts.fallback ? require('../../protos/protos.json') : nodejsProtoPath
);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this._pathTemplates = {
sessionPathTemplate: new gaxModule.PathTemplate(
'projects/{project}/agent/sessions/{session}'
),
};
// Some of the methods on this service provide streaming responses.
// Provide descriptors for these.
this._descriptors.stream = {
streamingDetectIntent: new gaxModule.StreamDescriptor(
gax.StreamType.BIDI_STREAMING
),
};
// Put together the default options sent with requests.
const defaults = gaxGrpc.constructSettings(
'google.cloud.dialogflow.v2.Sessions',
gapicConfig,
opts.clientConfig,
{'x-goog-api-client': clientHeader.join(' ')}
);
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this._innerApiCalls = {};
// Put together the "service stub" for
// google.cloud.dialogflow.v2.Sessions.
const sessionsStub = gaxGrpc.createStub(
opts.fallback
? protos.lookupService('google.cloud.dialogflow.v2.Sessions')
: protos.google.cloud.dialogflow.v2.Sessions,
opts
);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const sessionsStubMethods = ['detectIntent', 'streamingDetectIntent'];
for (const methodName of sessionsStubMethods) {
const innerCallPromise = sessionsStub.then(
stub => (...args) => {
return stub[methodName].apply(stub, args);
},
err => () => {
throw err;
}
);
this._innerApiCalls[methodName] = gaxModule.createApiCall(
innerCallPromise,
defaults[methodName],
this._descriptors.stream[methodName]
);
}
}
/**
* The DNS address for this API service.
*/
static get servicePath() {
return 'dialogflow.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath(),
* exists for compatibility reasons.
*/
static get apiEndpoint() {
return 'dialogflow.googleapis.com';
}
/**
* The port for this API service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/cloud-platform',
'https://www.googleapis.com/auth/dialogflow',
];
}
/**
* Return the project ID used by this class.
* @param {function(Error, string)} callback - the callback to
* be called with the current project Id.
*/
getProjectId(callback) {
return this.auth.getProjectId(callback);
}
// -------------------
// -- Service calls --
// -------------------
/**
* Processes a natural language query and returns structured, actionable data
* as a result. This method is not idempotent, because it may cause contexts
* and session entity types to be updated, which in turn might affect
* results of future queries.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.session
* Required. The name of the session this query is sent to. Format:
* `projects/<Project ID>/agent/sessions/<Session ID>`. It's up to the API
* caller to choose an appropriate session ID. It can be a random number or
* some type of user identifier (preferably hashed). The length of the session
* ID must not exceed 36 bytes.
* @param {Object} request.queryInput
* Required. The input specification. It can be set to:
*
* 1. an audio config
* which instructs the speech recognizer how to process the speech audio,
*
* 2. a conversational query in the form of text, or
*
* 3. an event that specifies which intent to trigger.
*
* This object should have the same structure as [QueryInput]{@link google.cloud.dialogflow.v2.QueryInput}
* @param {Object} [request.queryParams]
* Optional. The parameters of this query.
*
* This object should have the same structure as [QueryParameters]{@link google.cloud.dialogflow.v2.QueryParameters}
* @param {Object} [request.outputAudioConfig]
* Optional. Instructs the speech synthesizer how to generate the output
* audio. If this field is not set and agent-level speech synthesizer is not
* configured, no output audio is generated.
*
* This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2.OutputAudioConfig}
* @param {Buffer} [request.inputAudio]
* Optional. The natural language speech audio to be processed. This field
* should be populated iff `query_input` is set to an input audio config.
* A single request can contain up to 1 minute of speech audio data.
* @param {Object} [options]
* Optional parameters. You can override the default settings for this call, e.g, timeout,
* retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details.
* @param {function(?Error, ?Object)} [callback]
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing [DetectIntentResponse]{@link google.cloud.dialogflow.v2.DetectIntentResponse}.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [DetectIntentResponse]{@link google.cloud.dialogflow.v2.DetectIntentResponse}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
*
* const dialogflow = require('dialogflow');
*
* const client = new dialogflow.v2.SessionsClient({
* // optional auth parameters.
* });
*
* const formattedSession = client.sessionPath('[PROJECT]', '[SESSION]');
* const queryInput = {};
* const request = {
* session: formattedSession,
* queryInput: queryInput,
* };
* client.detectIntent(request)
* .then(responses => {
* const response = responses[0];
* // doThingsWith(response)
* })
* .catch(err => {
* console.error(err);
* });
*/
detectIntent(request, options, callback) {
if (options instanceof Function && callback === undefined) {
callback = options;
options = {};
}
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers[
'x-goog-request-params'
] = gax.routingHeader.fromParams({
session: request.session,
});
return this._innerApiCalls.detectIntent(request, options, callback);
}
/**
* 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).
*
* @param {Object} [options]
* Optional parameters. You can override the default settings for this call, e.g, timeout,
* retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details.
* @returns {Stream}
* An object stream which is both readable and writable. It accepts objects
* representing [StreamingDetectIntentRequest]{@link google.cloud.dialogflow.v2.StreamingDetectIntentRequest} for write() method, and
* will emit objects representing [StreamingDetectIntentResponse]{@link google.cloud.dialogflow.v2.StreamingDetectIntentResponse} on 'data' event asynchronously.
*
* @example
*
* const dialogflow = require('dialogflow');
*
* const client = new dialogflow.v2.SessionsClient({
* // optional auth parameters.
* });
*
* const stream = client.streamingDetectIntent().on('data', response => {
* // doThingsWith(response)
* });
* const session = '';
* const queryInput = {};
* const request = {
* session: session,
* queryInput: queryInput,
* };
* // Write request objects.
* stream.write(request);
*/
streamingDetectIntent(options) {
options = options || {};
return this._innerApiCalls.streamingDetectIntent(options);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified session resource name string.
*
* @param {String} project
* @param {String} session
* @returns {String}
*/
sessionPath(project, session) {
return this._pathTemplates.sessionPathTemplate.render({
project: project,
session: session,
});
}
/**
* Parse the sessionName from a session resource.
*
* @param {String} sessionName
* A fully-qualified path representing a session resources.
* @returns {String} - A string representing the project.
*/
matchProjectFromSessionName(sessionName) {
return this._pathTemplates.sessionPathTemplate.match(sessionName).project;
}
/**
* Parse the sessionName from a session resource.
*
* @param {String} sessionName
* A fully-qualified path representing a session resources.
* @returns {String} - A string representing the session.
*/
matchSessionFromSessionName(sessionName) {
return this._pathTemplates.sessionPathTemplate.match(sessionName).session;
}
}
module.exports = SessionsClient;