universal_search_engine v2.1.0
universal_search_engine
UniversalSearchEngine - JavaScript client for universal_search_engine universal search engine api This SDK is automatically generated by the Swagger Codegen project:
- API version: 2.0.1
- Package version: 2.0.1
- Build package: io.swagger.codegen.languages.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 universal_search_engine --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your universal_search_engine from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('universal_search_engine')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/universal_search_engine then install it via:
npm install YOUR_USERNAME/universal_search_engine --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, that's to say your javascript file where you actually
use this library):
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 UniversalSearchEngine = require('universal_search_engine');
var api = new UniversalSearchEngine.WalkoverSearch()
var name = "name_example"; // {String} name of index to be created
var type = "type_example"; // {String} type of index, should be Simple_Search or Ecommerce
var API_KEY = "API_KEY_example"; // {String} API_KEY for authentication
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addIndex(name, type, API_KEY, callback);
Documentation for API Endpoints
All URIs are relative to https://search-engine-walkover.el.r.appspot.com
Class | Method | HTTP request | Description |
---|---|---|---|
UniversalSearchEngine.WalkoverSearch | addIndex | POST /addIndexByApi | Add Index By Api |
UniversalSearchEngine.WalkoverSearch | addObject | POST /add/{index_name} | This will add an object to the given index. |
UniversalSearchEngine.WalkoverSearch | addObjects | POST /bulkadd/{index_name} | This will add an array of objects to the given index. |
UniversalSearchEngine.WalkoverSearch | copyIndexConfig | POST /copyIndexConfig | Copy Index configuration from one index to another |
UniversalSearchEngine.WalkoverSearch | deleteIndex | DELETE /deleteIndexByApi | Delete Index |
UniversalSearchEngine.WalkoverSearch | deleteObject | DELETE /delete/{index_name} | This will delete the object with given object id |
UniversalSearchEngine.WalkoverSearch | generateEvent | POST /event/{index_name} | This will generate an event. |
UniversalSearchEngine.WalkoverSearch | getAllObjects | POST /getAllObjects | Get All objects stored in index |
UniversalSearchEngine.WalkoverSearch | searchQuery | POST /search/{index_name} |
Documentation for Models
- UniversalSearchEngine.ModelObject
- UniversalSearchEngine.Object1
- UniversalSearchEngine.SearchParameters
Documentation for Authorization
All endpoints do not require authorization.