askaiden

Askaiden - JavaScript client for askaiden The operating system to build AI Tutors This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.5
• Package version: 0.0.5
• 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 askaiden --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 Askaiden = require('askaiden');
var defaultClient = Askaiden.ApiClient.instance;


var api = new Askaiden.AidenApi()
var body = new Askaiden.AppModelsRequestAidenStep(); // {AppModelsRequestAidenStep} 
var aidenId = "aidenId_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAidenStep(body, aidenId, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
Askaiden.AidenApi	addAidenStep	POST /api/v1/aiden/{aiden_id}/steps	Add Step
Askaiden.AidenApi	createAiden	POST /api/v1/aiden	Create
Askaiden.AidenApi	deleteAiden	DELETE /api/v1/aiden/{aiden_id}	Delete
Askaiden.AidenApi	deleteAidenStep	DELETE /api/v1/aiden/{aiden_id}/steps/{step_id}	Delete Step
Askaiden.AidenApi	getAiden	GET /api/v1/aiden/{aiden_id}	Get
Askaiden.AidenApi	invokeAiden	POST /api/v1/aiden/{aiden_id}/invoke	Invoke
Askaiden.AidenApi	listAidenSteps	GET /api/v1/aiden/{aiden_id}/steps	List Steps
Askaiden.AidenApi	listAidens	GET /api/v1/aiden	List
Askaiden.AidenApi	updateAiden	PATCH /api/v1/aiden/{aiden_id}	Update
Askaiden.ConversationsApi	createConversations	POST /api/v1/conversations	Create
Askaiden.ConversationsApi	deleteConversations	DELETE /api/v1/conversations/{conversationId}	Delete
Askaiden.ConversationsApi	listConversations	GET /api/v1/conversations	List
Askaiden.ConversationsApi	listMessages	GET /api/v1/conversations/{conversationId}/messages	List
Askaiden.ConversationsApi	updateConversations	PATCH /api/v1/conversations/{conversationId}	Update
Askaiden.DatasourceApi	createDatasources	POST /api/v1/datasources	Create
Askaiden.DatasourceApi	deleteDatasource	DELETE /api/v1/datasources/{datasource_id}	Delete
Askaiden.DatasourceApi	getDatasource	GET /api/v1/datasources/{datasource_id}	Get
Askaiden.DatasourceApi	listDatasources	GET /api/v1/datasources	List
Askaiden.DatasourceApi	updateDatasource	PATCH /api/v1/datasources/{datasource_id}	Update
Askaiden.SkillsApi	addDatasource	POST /api/v1/skills/{skill_id}/datasources	Add Datasource
Askaiden.SkillsApi	addSkillTool	POST /api/v1/skills/{skill_id}/tools	Add Tool
Askaiden.SkillsApi	createSkill	POST /api/v1/skills	Create
Askaiden.SkillsApi	deleteSkill	DELETE /api/v1/skills/{skill_id}	Delete
Askaiden.SkillsApi	getSkill	GET /api/v1/skills/{skill_id}	Get
Askaiden.SkillsApi	invokeSkill	POST /api/v1/skills/{skill_id}/invoke	Invoke
Askaiden.SkillsApi	listRuns	GET /api/v1/skills/{skill_id}/runs	List Runs
Askaiden.SkillsApi	listSkillDatasources	GET /api/v1/skills/{skill_id}/datasources	List Datasources
Askaiden.SkillsApi	listSkillTools	GET /api/v1/skills/{skill_id}/tools	List Tools
Askaiden.SkillsApi	listSkills	GET /api/v1/skills	List
Askaiden.SkillsApi	removeDatasource	DELETE /api/v1/skills/{skill_id}/datasources/{datasource_id}	Remove Datasource
Askaiden.SkillsApi	removeTool	DELETE /api/v1/skills/{skill_id}/tools/{tool_id}	Remove Tool
Askaiden.SkillsApi	updateSkill	PATCH /api/v1/skills/{skill_id}	Update
Askaiden.ToolApi	createTools	POST /api/v1/tools	Create
Askaiden.ToolApi	deleteTool	DELETE /api/v1/tools/{tool_id}	Delete
Askaiden.ToolApi	getApiV1ToolsToolIdGet	GET /api/v1/tools/{tool_id}	Get
Askaiden.ToolApi	listTools	GET /api/v1/tools	List
Askaiden.ToolApi	updateApiV1ToolsToolIdPatch	PATCH /api/v1/tools/{tool_id}	Update
Askaiden.UsersApi	createUser	POST /api/v1/user	Create
Askaiden.UsersApi	deleteUser	DELETE /api/v1/user	Delete
Askaiden.UsersApi	getUser	GET /api/v1/user	Get
Askaiden.UsersApi	updateUser	PATCH /api/v1/user	Update

Documentation for Models

• Askaiden.AidenInvoke
• Askaiden.AidenList
• Askaiden.AnyOfValidationErrorLocItems
• Askaiden.AppModelsRequestAiden
• Askaiden.AppModelsRequestAidenStep
• Askaiden.AppModelsRequestDatasource
• Askaiden.AppModelsRequestSkill
• Askaiden.AppModelsRequestSkillDatasource
• Askaiden.AppModelsRequestSkillInvoke
• Askaiden.AppModelsRequestSkillTool
• Askaiden.AppModelsRequestTool
• Askaiden.AppModelsRequestUser
• Askaiden.AppModelsResponseAiden
• Askaiden.AppModelsResponseDatasource
• Askaiden.AppModelsResponseSkill
• Askaiden.AppModelsResponseSkillInvoke
• Askaiden.AppModelsResponseTool
• Askaiden.AppModelsResponseUser
• Askaiden.Conversation
• Askaiden.ConversationCreation
• Askaiden.ConversationDefinition
• Askaiden.DatasourceList
• Askaiden.DatasourceStatus
• Askaiden.DatasourceType
• Askaiden.HTTPValidationError
• Askaiden.Language
• Askaiden.Memory
• Askaiden.PrismaModelsAiden
• Askaiden.PrismaModelsAidenStep
• Askaiden.PrismaModelsDatasource
• Askaiden.PrismaModelsSkill
• Askaiden.PrismaModelsSkillDatasource
• Askaiden.PrismaModelsSkillTool
• Askaiden.PrismaModelsTool
• Askaiden.PrismaModelsUser
• Askaiden.SkillDatasosurceList
• Askaiden.SkillList
• Askaiden.SkillRunList
• Askaiden.SkillToolList
• Askaiden.ToolList
• Askaiden.ToolType
• Askaiden.UserType
• Askaiden.ValidationError

Documentation for Authorization

HTTPBearer