/**
* Copyright 2014 IBM Corp. All Rights Reserved.
*
* 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
*
* http://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.
*/
'use strict';
const requestFactory = require('../lib/requestwrapper');
const isStream = require('isstream');
const omit = require('object.omit');
const util = require('util');
const BaseService = require('../lib/base_service');
/**
* Document Conversion service
* @param options
* @constructor
*/
function DocumentConversionV1(options) {
BaseService.call(this, options);
// Warn if not specifying version date
if (!this._options.version_date && !this._options.silent) {
// eslint-disable-next-line no-console
console.warn(
'[DocumentConversion] WARNING: No version_date specified. Using a (possibly old) default. ' +
'e.g. watson.document_conversion({ version_date: "2015-12-15" })'
);
}
}
util.inherits(DocumentConversionV1, BaseService);
DocumentConversionV1.prototype.name = 'document_conversion';
DocumentConversionV1.prototype.version = 'v1';
DocumentConversionV1.URL = 'https://gateway.watsonplatform.net/document-conversion/api';
DocumentConversionV1.prototype.serviceDefaults = {
qs: { version: '2015-12-15' }
};
DocumentConversionV1.prototype.conversion_target = {
ANSWER_UNITS: 'answer_units',
NORMALIZED_HTML: 'normalized_html',
NORMALIZED_TEXT: 'normalized_text'
};
// this sets up the content type "headers" in the form/multipart body (not in the actual headers)
function fixupContentType(params) {
if (params.content_type) {
params.file = {
value: params.file,
options: {
contentType: params.content_type
}
};
}
}
/**
* One-off convert an attached document OR convert a previously uploaded document by ID
*
* To convert a previously uploaded document, set params.document_id
*
* @param {Object} params
* @param {Object} params.conversion_target Must be set to one of ['answer_units', 'normalized_html', 'normalized_text']
* @param {ReadableStream} [params.file] The document file to convert. May be a ReadableStream or Buffer
* @param {String} [params.content_type] Set this when the content type cannot be determined from the filename (params.file.path)
* @param {Object} [params.config] Optional configuration option. Recommended way to set configuration.
* @param {Function} callback
*/
DocumentConversionV1.prototype.convert = function(params, callback) {
params = params || {};
if (typeof params.conversion_target === 'string') {
params.conversion_target = params.conversion_target.toLowerCase();
}
const keys = Object.keys(DocumentConversionV1.prototype.conversion_target);
const values = keys.map(function(v) {
return DocumentConversionV1.prototype.conversion_target[v];
});
if (values.indexOf(params.conversion_target) === -1) {
callback(new Error('Missing required parameters: conversion_target. Possible values are: ' + values.join(', ')));
return;
}
if (!params.file && !params.document_id) {
callback(new Error('Missing required parameters: either params.file or params.document_id must be specified'));
return;
}
if (params.file && !isStream(params.file) && !Buffer.isBuffer(params.file) && !params.file.value) {
callback(new Error('Missing required parameters: file is not a standard Node.js Stream or Buffer'));
return;
}
const parameters = {
options: {
method: 'POST',
url: '/v1/convert_document',
json: true
},
defaultOptions: this._options
};
// send the parameters in the body or as formData depending on the request
if (params.file) {
fixupContentType(params);
parameters.options.formData = {
file: params.file,
config: {
value: JSON.stringify(params.config || omit(params, ['file', 'content_type'])),
options: {
contentType: 'application/json; charset=utf-8'
}
}
};
} else {
parameters.options.body = params;
}
return requestFactory(parameters, callback);
};
/**
* One-off convert and index a document via index_document API
*
* NOTE: A SOLR cluster and search collection will have to be created through the Retrieve and Rank
* service prior to using this API if actual indexing is performed (dry_run=false).
*
* @param {Object} params
* @param {ReadableStream} [params.file] The document file to convert. May be a ReadableStream or Buffer
* @param {Object} params.metadata Metadata array of Object's where each object contains 'name' and 'value'
* @param {Object} params.config Configuration for the conversion and indexing. The conversion config needs
to be in a 'convert_document' object. This can include configuration for 'pdf', 'word'
and 'normalized_html' phases of the conversion process. The indexing config needs to be
in a 'retrieve_and_rank' object. The 'retrieve_and_rank' object has the following fields:
'dry_run' - boolean value, true if a dry run is to be performed, false to actually index,
'service_instance_id' - The serviceGuid of your instance of the retrieve and rank
service (required if dry_run=false), 'cluster_id' - The Solr cluster id for your retrieve
and rank service instance (required if dry_run=false), 'search_collection' - The name of
your Solr search collection from your retrieve and rank service instance (required if
dry_run=false), and 'fields' - Configuration information for field 'mappings', fields
to 'include', and fields to 'exclude' during indexing (exclude takes precedence over include)
* @param {Function} callback
*/
DocumentConversionV1.prototype.index = function(params, callback) {
params = params || {};
if (!params.file && !params.metadata) {
callback(new Error('Missing required parameters: file or metadata. At least one of those is required.'));
return;
}
if (params.file && !isStream(params.file) && !Buffer.isBuffer(params.file) && !params.file.value) {
callback(new Error('Missing required parameters: file is not a standard Node.js Stream or Buffer'));
return;
}
if (!params.config) {
callback(new Error('Missing required parameters: file or metadata. At least one of those is required.'));
return;
}
const parameters = {
options: {
method: 'POST',
url: '/v1/index_document',
json: true
},
defaultOptions: this._options
};
// send the parameters as formData
if (params.file && params.metadata) {
fixupContentType(params);
parameters.options.formData = {
file: params.file,
config: {
value: JSON.stringify(params.config),
options: {
contentType: 'application/json; charset=utf-8'
}
},
metadata: {
value: JSON.stringify(params.metadata),
options: {
contentType: 'application/json; charset=utf-8'
}
}
};
} else if (params.file) {
fixupContentType(params);
parameters.options.formData = {
file: params.file,
config: {
value: JSON.stringify(params.config),
options: {
contentType: 'application/json; charset=utf-8'
}
}
};
} else if (params.metadata) {
parameters.options.formData = {
config: {
value: JSON.stringify(params.config),
options: {
contentType: 'application/json; charset=utf-8'
}
},
metadata: {
value: JSON.stringify(params.metadata),
options: {
contentType: 'application/json; charset=utf-8'
}
}
};
} else {
callback(new Error('Missing required parameters: file or metadata. At least one of those is required.'));
return;
}
return requestFactory(parameters, callback);
};
// give a clear error message for the deprecated methods
[
'getOutput',
'getOutputs',
'getJobLog',
'getJobs',
'getJob',
'createJob',
'getBatchDocument',
'getBatchDocuments',
'addDocumentToBatch',
'getDocument',
'getDocuments',
'uploadDocument',
'getBatchDocuments',
'updateBatch',
'getBatch',
'createBatch',
'getBatches'
].forEach(function(name) {
DocumentConversionV1.prototype[name] = function deprecated() {
throw new Error('The DocumentConversion.' + name + '() method was deprecated and is no longer available, please use convert() instead.');
};
});
module.exports = DocumentConversionV1;