marqo

Marqo - JavaScript client for marqo No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.2.0
• Package version: 0.2.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install marqo --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Marqo = require('marqo');
var defaultClient = Marqo.ApiClient.instance;
// Configure HTTP basic authorization: HTTPBasic
var HTTPBasic = defaultClient.authentications['HTTPBasic'];
HTTPBasic.username = 'YOUR USERNAME'
HTTPBasic.password = 'YOUR PASSWORD'

var api = new Marqo.DefaultApi()
var body = null; // {[Object]} 
var indexName = "indexName_example"; // {String} 
var opts = { 
  'refresh': true, // {Boolean} 
  'batchSize': 0, // {Number} 
  'processes': 1 // {Number} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDocumentsIndexesIndexNameDocumentsPost(body, indexName, opts, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
Marqo.DefaultApi	addDocumentsIndexesIndexNameDocumentsPost	POST /indexes/{index_name}/documents	Add Documents
Marqo.DefaultApi	createIndexIndexesIndexNamePost	POST /indexes/{index_name}	Create Index
Marqo.DefaultApi	deleteDocsIndexesIndexNameDocumentsDeleteBatchPost	POST /indexes/{index_name}/documents/delete-batch	Delete Docs
Marqo.DefaultApi	deleteIndexIndexesIndexNameDelete	DELETE /indexes/{index_name}	Delete Index
Marqo.DefaultApi	getDocumentByIdIndexesIndexNameDocumentsDocumentIdGet	GET /indexes/{index_name}/documents/{document_id}	Get Document By Id
Marqo.DefaultApi	getIndexStatsIndexesIndexNameStatsGet	GET /indexes/{index_name}/stats	Get Index Stats
Marqo.DefaultApi	refreshIndexIndexesIndexNameRefreshPost	POST /indexes/{index_name}/refresh	Refresh Index
Marqo.DefaultApi	rootGet	GET /	Root
Marqo.DefaultApi	searchIndexesIndexNameSearchPost	POST /indexes/{index_name}/search	Search

Documentation for Models

• Marqo.AnyOfValidationErrorLocItems
• Marqo.HTTPValidationError
• Marqo.SearchQuery
• Marqo.ValidationError

Documentation for Authorization

HTTPBasic

• Type: HTTP basic authentication