jai-sdk v0.60.0

JAI Javascript SDK

Our REST API

https://documenter.getpostman.com/view/11432617/UVJcmxB1#0053601f-0014-4754-b917-347783ec4866

Our Docs (For Python Developers)

https://jai-sdk.readthedocs.io/en/latest/

CLI (Command Line Interface)

Getting Started

npm i jai-sdk

Getting your auth Key

npx jai-sdk get-auth-key \
    --first-name "YOUR_FIRST_NAME" \
    --last-name "YOUR_LAST_NAME" \
    --email "YOUR_BEST_EMAIL_HERE" \
    [--company-name "YOUR_COMPANY_NAME_HERE"]

Environment Management

Listing Environments

Get the names of all environments in the namespace.

npx jai-sdk get-environments \
    --key YOUR_JAI_API_KEY

Collection Management

Insert Data

npx jai-sdk insert-data \
   --databaseName YOUR_COLLECTION_NAME_HERE \
   --data "$(cat ./data-file-body.json)" \
   [--filter-name | -f] 'your filter here' \
   [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
   [--verbose | -v] \
   --key YOUR_JAI_API_KEY 

Check Inserted Data

npx jai-sdk check-inserted-data \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--mode | -m] complete | summarized | simple \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    [--verbose | -v] \
    --key YOUR_JAI_API_KEY

Setup Inserted Data

npx jai-sdk setup-inserted-data \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --settings "$(cat ./your-settings-file.json)" \
    [--quick-test | t] [true | false] \
    [--overwrite | o] [true | false] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    [--verbose | -v] \
    --key YOUR_JAI_API_KEY

Interrupt Data Setup

npx jai-sdk interrupt-data-setup \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --key YOUR_JAI_API_KEY \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \

Delete Raw Inserted Data

npx jai-sdk delete-inserted-data \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --key YOUR_JAI_API_KEY

Get Filters

npx jai-sdk get-filters \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --key YOUR_JAI_API_KEY \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \

Add Data Patch

npx jai-sdk add-data \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [callback-url | -u] 'http://my-calback-url.com' \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Database Description

npx jai-sdk get-database-description\
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Database Info

npx jai-sdk get-database-info \
    [--mode | -m] [complete | complete | names] \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Ids

npx jai-sdk get-ids \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--mode | -m] complete | summarized | simple \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Report

npx jai-sdk get-report \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Vector By Id

npx jai-sdk get-vector-by-id \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --arrayOfIds IDS_COMMA_SEPARETED \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Download Key (Url to Download Vector)

npx jai-sdk get-download-key \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Fields

npx jai-sdk get-fields \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Is Database Name Valid

npx jai-sdk is-database-name-valid \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Get Status

npx jai-sdk get-status \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Delete Status

npx jai-sdk delete-status \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Delete Entity (Vectors) By Id

npx jai-sdk delete-entity \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --arrayOfIds IDS_COMMA_SEPARETED \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Delete Database

npx jai-sdk delete-database \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Similarity Methods

Search By ID

npx jai-sdk similarity-search-by-id \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --arrayOfIds IDS_COMMA_SEPARETED \
    [--topk 10] \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

Search By Data

npx jai-sdk similarity-search-by-data \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --data "$(cat ./data-file-body.json)" \
    [--topk 10] \
    [--verbose | -v] \
    [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
    --key YOUR_JAI_API_KEY

data-file-body.json content

[{
  "id": 0,
  "sepal length (cm)": 0.1,
  "sepal width (cm)": 1.2,
  "petal length (cm)": 0.3,
  "petal width (cm)": 2.4
}]

Prediction

npx jai-sdk predict \
    --databaseName YOUR_COLLECTION_NAME_HERE \
    --data "$(cat ./data-file-body.json)" \
   [--predict-probability | -p] true \
   [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
   [--verbose | -v] \
    --key YOUR_JAI_API_KEY

Recommendation Methods

Recommendation By ID

npx jai-sdk recommendation-search-by-id \
   --databaseName YOUR_COLLECTION_NAME_HERE \
   --arrayOfIds IDS_COMMA_SEPARETED \
   [--topk 10] \
   [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
   [--verbose | -v] \
   --key YOUR_JAI_API_KEY

Recommendation By Data

npx jai-sdk recommendation-search-by-data \
   --databaseName YOUR_COLLECTION_NAME_HERE \
   --data "$(cat ./data-file-body.json)" \
   [--topk 10] \
   [--environment | -e] YOUR_JAI_ENVIRONMENT_NAME_OR_KEY \
   [--verbose | -v] \
   --key YOUR_JAI_API_KEY

data-file-body.json content

[{
  "id": 0,
  "sepal length (cm)": 0.1,
  "sepal width (cm)": 1.2,
  "petal length (cm)": 0.3,
  "petal width (cm)": 2.4
}]

NodeJS / Javascript Implementation

const express = require('express')
const app = express()

require('dotenv').config()

const {
    getStatus,
    authenticate,
    authenticateFromEnvironmentVariable,
    jaiEnvironmentFromEnvironmentVariable,
    insertData,
    getFields,
    isDatabaseNameValid,
    checkInsertedData,
    addData,
    ...
} = require('jai-sdk');

if (process.env.JAI_API_KEY) {
    authenticateFromEnvironmentVariable()
    console.debug(authMessage());
}

if (process.env.JAI_ENVIRONMENT_NAME) {
    jaiEnvironmentFromEnvironmentVariable()
    console.debug(authMessage());
}

app.get('/get-status', (req, res) => {
    getStatus().then(data => {
        res.send(data);
    })
})

...