logic_mill_api

LogicMillApi - JavaScript client for logic_mill_api This is the API of the Logic Mill project This SDK is automatically generated by the Swagger Codegen project:

API version: 0.0.0
Package version: 0.0.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 logic_mill_api --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 LogicMillApi = require('logic_mill_api');

var api = new LogicMillApi.DefaultApi()
var body = new LogicMillApi.BulkDocumentRequest(); // {BulkDocumentRequest} 
var index = "index_example"; // {String} 
var opts = { 
  'saveInEs': false // {Boolean} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulkEncodeDocumentsEndpointIndicesIndexEncodeBulkPut(body, index, opts, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
LogicMillApi.DefaultApi	bulkEncodeDocumentsEndpointIndicesIndexEncodeBulkPut	PUT /indices/{index}/encode/bulk	Bulk Encode Documents Endpoint
LogicMillApi.DefaultApi	bulkSaveDocumentsEndpointIndicesIndexAddBulkPut	PUT /indices/{index}/add/bulk	Bulk Save Documents Endpoint
LogicMillApi.DefaultApi	createIndexEndpointIndicesIndexPost	POST /indices/{index}	Create Index Endpoint
LogicMillApi.DefaultApi	existsEndpointIndicesIndexDocDocIdExistsGet	GET /indices/{index}/doc/{doc_id}/exists	Exists Endpoint
LogicMillApi.DefaultApi	readDocumentEndpointIndicesIndexDocDocIdGet	GET /indices/{index}/doc/{doc_id}	Read Document Endpoint
LogicMillApi.DefaultApi	readIndexMappingIndicesIndexMappingGet	GET /indices/{index}/mapping	Read Index Mapping
LogicMillApi.DefaultApi	readIndicesEndpointIndicesGet	GET /indices	Read Indices Endpoint
LogicMillApi.DefaultApi	readSimilarDocumentsEndpointIndicesIndexDocDocIdSimilarityGet	GET /indices/{index}/doc/{doc_id}/similarity	Read Similar Documents Endpoint
LogicMillApi.DefaultApi	readSimilarDocumentsWithQueryEndpointIndicesIndexDocDocIdSimilarityPut	PUT /indices/{index}/doc/{doc_id}/similarity	Read Similar Documents With Query Endpoint
LogicMillApi.DefaultApi	readStatusEndpointGet	GET /	Read Status Endpoint
LogicMillApi.DefaultApi	searchEndpointIndicesIndexSearchPut	PUT /indices/{index}/search	Search Endpoint
LogicMillApi.DefaultApi	similaritySearchEndpointIndicesIndexEncodeSimilarityPut	PUT /indices/{index}/encode/similarity	Similarity Search Endpoint
LogicMillApi.DefaultApi	updateMetadataEndpointIndicesIndexDocDocIdMetadataPut	PUT /indices/{index}/doc/{doc_id}/metadata	Update Metadata Endpoint
LogicMillApi.DefaultApi	updateVectorEndpointIndicesIndexDocDocIdVectorPut	PUT /indices/{index}/doc/{doc_id}/vector	Update Vector Endpoint

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

erikbuunk/lm-js-client