Merge pull request #19 from modzy/feat/docs_update

feat: docs review

Author: sonejah21

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modzy/modzy-sdk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Javascript SDK for Modzy",
   "license": "Booz Allen Public License v1.0",
   "main": "dist/main.js",

samples/job_with_file_input_sample.js

@@ -71,7 +71,7 @@ async function createJobWithFileInput(){
 		// If you send a correct input key, but some wrong values, the model fails to process the input.
 		sources["wrong-value"] = {"input": configPath, "config.json":imagePath}
 		// When you have all your inputs ready, you can use our helper method to submit the job as follows:        
-        let job = await modzyClient.submitJobFiles(model.modelId,modelVersion.version, sources);
+        let job = await modzyClient.submitJobFile(model.modelId,modelVersion.version, sources);
         // Modzy creates the job and queue for processing. The job object contains all the info that you need to keep track
         // of the process, the most important being the job identifier and the job status.
         logger.info("job: "+job.jobIdentifier+" "+job.status);

src/job-client.js

@@ -123,16 +123,18 @@ class JobClient{
      * @param {string} modelId - the model id string
      * @param {versionId} versionId - version id string
      * @param {Object[]} textSources - The source(s) of the model
+     * @param {boolean} explain - Explainability flag
      * @return {Object} the updated instance of the Job returned by Modzy API
      * @throws {ApiError} If there is something wrong with the service or the call
      */
-    submitJobText(modelId, versionId, textSources) {
+    submitJobText(modelId, versionId, textSources, explain=false) { 
         return this.submitJob(
             {
                 "model": {
                     "identifier": modelId,
                     "version": versionId
                 },
+                "explain": explain,
                 "input": {
                     "type": "text",
                     "sources": textSources
@@ -148,18 +150,20 @@ class JobClient{
      * @param {string} modelId - the model id string
      * @param {string} versionId - version id string
      * @param {Object[]} fileSources the source(s) of the model
+     * @param {boolean} explain - Explainability flag
      * @return {Object} the updated instance of the Job returned by Modzy API
      * @throws {ApiError} if there is something wrong with the service or the call
      */
-    submitJobFiles(modelId, versionId, fileSources) {
+    submitJobFile(modelId, versionId, fileSources, explain=false) {
         let job = {};
         let chunkSize = 1024*1024;
         return this.submitJob(
             {
                 "model": {
                     "identifier": modelId,
                     "version": versionId
-                }
+                },
+                "explain": explain
             }
         ).then(
             (openJob)=>{
@@ -211,10 +215,11 @@ class JobClient{
      * @param {string} versionId - version id string
      * @param {string} mediaType - the media type of the embedded source
      * @param {Object[]} embeddedSources the source(s) of the model
+     * @param {boolean} explain - Explainability flag
      * @return {Object} the updated instance of the Job returned by Modzy API
      * @throws {ApiError} if there is something wrong with the service or the call
      */
-    submitJobEmbedded(modelId, versionId, mediaType, embeddedSources) {
+    submitJobEmbedded(modelId, versionId, mediaType, embeddedSources, explain=false) {
         let encodedSources = {};
         Object.keys(embeddedSources).forEach(
             sourceKey => {
@@ -237,6 +242,7 @@ class JobClient{
                     "identifier": modelId,
                     "version": versionId
                 },
+                "explain": explain,
                 "input": {
                     "type": "embedded",
                     "sources": encodedSources
@@ -251,20 +257,22 @@ class JobClient{
      *
      * @param {string} modelId - the model id string
      * @param {string} versionId - version id string
-     * @param {string} accessKeyID - access key of aws-s3
+     * @param {string} accessKeyId - access key of aws-s3
      * @param {string} secretAccessKey - secret access key of aws-s3
      * @param {string} region - aws-s3 region
      * @param {Object[]} awss3Sources - the source(s) of the model
+     * @param {boolean} explain - Explainability flag
      * @return {Object} the updated instance of the Job returned by Modzy API
      * @throws {ApiError} if there is something wrong with the service or the call
      */
-    submitJobAWSS3(modelId, versionId, accessKeyID, secretAccessKey, region, awss3Sources) {
+    submitJobAWSS3(modelId, versionId, accessKeyId, secretAccessKey, region, awss3Sources, explain=false) {
         return this.submitJob(
             {
                 "model": {
                     "identifier": modelId,
                     "version": versionId
                 },
+                "explain": explain,
                 "input": {
                     "type": "aws-s3",
                     "accessKeyID": accessKeyID,
@@ -291,16 +299,18 @@ class JobClient{
      * @param {string} password - database password
      * @param {string} driver - fully qualified name of the driver class for jdbc
      * @param {string} query - the query to get the inputs of the model
+     * @param {boolean} explain - Explainability flag
      * @return {Object} the updated instance of the Job returned by Modzy API
      * @throws {ApiError} if there is something wrong with the service or the call
      */
-    submitJobJDBC(modelId, versionId, url, username, password, driver, query) {
+    submitJobJDBC(modelId, versionId, url, username, password, driver, query, explain=false) {
         return this.submitJob(
             {
                 "model": {
                     "identifier": modelId,
                     "version": versionId
                 },
+                "explain": explain,
                 "input": {
                     "type": "jdbc",
                     "url": url,

src/modzy-client.js

@@ -149,36 +149,36 @@ class ModzyClient {
 	/**
 	 * @see {@link JobClient#submitJobText}
 	 */
-	submitJobText(modelId, versionId, textSources) {
-		return this.jobClient.submitJobText(modelId, versionId, textSources);
+	submitJobText(modelId, versionId, textSources, explain=false) {
+		return this.jobClient.submitJobText(modelId, versionId, textSources, explain);
 	}
 
 	/**
 	 * @see {@link JobClient#submitJobEmbedded}
 	 */
-	submitJobEmbedded(modelId, versionId, mediaType, embeddedSources) {
-		return this.jobClient.submitJobEmbedded(modelId, versionId, mediaType, embeddedSources);
+	submitJobEmbedded(modelId, versionId, mediaType, embeddedSources, explain=false) {
+		return this.jobClient.submitJobEmbedded(modelId, versionId, mediaType, embeddedSources, explain);
 	}
 
 	/**
-	 * @see {@link JobClient#submitJobEmbedded}
+	 * @see {@link JobClient#submitJobFile}
 	 */
-	submitJobFiles(modelId, versionId, fileSources) {
-		return this.jobClient.submitJobFiles(modelId, versionId, fileSources);
+	submitJobFile(modelId, versionId, fileSources, explain=false) {
+		return this.jobClient.submitJobFile(modelId, versionId, fileSources, explain);
 	}
 
 	/**
 	 * @see {@link JobClient#submitJobAWSS3}
 	 */
-	submitJobAWSS3(modelId, versionId, accessKeyID, secretAccessKey, region, awss3Sources) {
-		return this.jobClient.submitJobAWSS3(modelId, versionId, accessKeyID, secretAccessKey, region, awss3Sources);
+	submitJobAWSS3(modelId, versionId, accessKeyId, secretAccessKey, region, awss3Sources, explain=false) {
+		return this.jobClient.submitJobAWSS3(modelId, versionId, accessKeyId, secretAccessKey, region, awss3Sources, explain);
 	}
 
 	/**
 	 * @see {@link JobClient#submitJobJDBC}
 	 */
-	submitJobJDBC(modelId, versionId, url, username, password, driver, query) {
-		return this.jobClient.submitJobJDBC(modelId, versionId, url, username, password, driver, query);
+	submitJobJDBC(modelId, versionId, url, username, password, driver, query, explain=false) {
+		return this.jobClient.submitJobJDBC(modelId, versionId, url, username, password, driver, query, explain);
 	}
 
 	/**