neuralseek

v1.0.2

Published

15 days ago

NeuralSeek___The_business_LLM_accelerator

Downloads

226

0High
0Medium
0Low

neuralseek

neuralSeek

NeuralSeek - JavaScript client for neuralSeek NeuralSeek - The business LLM accelerator This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.1
Package version: 1.0.1
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://neuralseek.com

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 neuralSeek --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 NeuralSeek = require('neuralSeek');
var defaultClient = NeuralSeek.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['apikey'] = "Token"

var api = new NeuralSeek.AnalyticsApi()
var opts = { 
  'body': new NeuralSeek.AnalyticsBody() // {AnalyticsBody} The request object.  You may optionally limit the result set using \"count\"
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.analytics(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.neuralseek.com/v1/{instance}

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NeuralSeek.AnalyticsApi | analytics | POST /analytics | Instance Analytics NeuralSeek.CategorizeApi | categorize | POST /categorize | Categorize text into an Intent & Category NeuralSeek.ExtractEntitiesApi | extractEntities | POST /extract | Extract entitites from text NeuralSeek.GuardrailsApi | pii | POST /pii | Find PII in a user utterance NeuralSeek.GuardrailsApi | score | POST /score | Run the Semantic Scoring model on text against an array of passages NeuralSeek.KeysApi | keycheck | POST /keycheck | Validate an api key NeuralSeek.KeysApi | otp | POST /otp | Create a One Time Password NeuralSeek.LogsApi | logExternalAgent | POST /logExternalAgent | Log external agent execution details NeuralSeek.LogsApi | logs | POST /logs | Instance Logs NeuralSeek.MAIstroApi | chat | POST /chat/completions | Chat Completions - compatible mAIStro endpoint NeuralSeek.MAIstroApi | maistro | POST /maistro | Run mAistro NTL or agent NeuralSeek.MAIstroApi | maistroAgentGet | GET /maistro/{agent} | Run a mAIstro agent via GET NeuralSeek.MAIstroApi | maistroBatch | POST /maistro_batch | Call mAIstro NTL or an agent via batch NeuralSeek.MAIstroApi | maistroBatchDelete | DELETE /maistro_batch | Cancel current mAIstro batch run NeuralSeek.MAIstroApi | maistroBatchGet | GET /maistro_batch | Get mAIstro batch results NeuralSeek.MAIstroApi | maistroStream | POST /maistro_stream | Stream mAIstro NTL or an agent NeuralSeek.MAIstroAgentRatingsApi | maistroRate | POST /maistroRate | Rate an Agent NeuralSeek.MAIstroAgentRatingsApi | maistroRatings | POST /maistroRatings | Get the average user ratings for an agent NeuralSeek.SeekApi | seek | POST /seek | Seek an answer from NeuralSeek NeuralSeek.SeekApi | seekStream | POST /seek_stream | Stream a Seek an answer from NeuralSeek NeuralSeek.SeekAnswerRatingsApi | answerRatings | POST /answerRatings | Get the average user ratings for an answer NeuralSeek.SeekAnswerRatingsApi | rate | POST /rate | Rate an answer NeuralSeek.ServiceTestApi | servicetest | GET /test | Service check NeuralSeek.TestQuestionsApi | getTestResults | GET /getTestResults | Get Test Results NeuralSeek.TestQuestionsApi | test | POST /test | Test questions via batch upload NeuralSeek.TrainKBApi | train | POST /train | Submit KnowledgeBase Training NeuralSeek.TranslateApi | deleteTranslateGlossary | DELETE /translateGlossary | Delete the custom translations NeuralSeek.TranslateApi | identifyLanguage | POST /identify | Identify the source language NeuralSeek.TranslateApi | identifyLanguageJSON | POST /identify-single | Identify the source language (JSON) NeuralSeek.TranslateApi | translate | POST /translate | Translate text into a desired language NeuralSeek.TranslateApi | translateGlossary | POST /translateGlossary | Add custom translations NeuralSeek.UserDataApi | deleteUserData | DELETE /user_data | Delete all user data

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

neuralSeek

Installation

For Node.js

npm

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

apiKey

embedcode