@nestbox-ai/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @nestbox-ai/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AppApi | appControllerGetHello | GET / | CollectionApi | collectionControllerAddDocToCollection | POST /collections/{collection_id}/docs | Add a new doc CollectionApi | collectionControllerChunkFileToCollection | POST /collections/{collection_id}/docs/file | Use a file to chunk and add to collection CollectionApi | collectionControllerCreateCollection | POST /collections | Create a new collection CollectionApi | collectionControllerDeleteCollection | DELETE /collections/{collection_id} | Delete a collection CollectionApi | collectionControllerDeleteDoc | DELETE /collections/{collection_id}/docs/{doc_id} | Delete doc by ID CollectionApi | collectionControllerDeleteDocsByMetadata | DELETE /collections/{collection_id}/docs | Delete docs based on metadata filter CollectionApi | collectionControllerGetCollection | GET /collections/{collection_id} | Get a collection info CollectionApi | collectionControllerGetCollections | GET /collections | List all collections CollectionApi | collectionControllerGetDocById | GET /collections/{collection_id}/docs/{doc_id} | Retrieve doc by ID CollectionApi | collectionControllerSimilaritySearch | POST /collections/{collection_id}/query | Similarity search query CollectionApi | collectionControllerUpdateCollection | PUT /collections/{collection_id} | Updates a collection CollectionApi | collectionControllerUpdateDoc | PUT /collections/{collection_id}/docs/{doc_id} | Update or upsert doc

Documentation For Models

• BadRequestExceptionResponse
• ChunkFileRequestDTO
• CreateCollectionRequestDTO
• CreateDocumentRequestDTO
• FatalErrorExceptionResponse
• ForbiddenExceptionResponse
• MessageResponseDTO
• NotFoundExceptionResponse
• SimilaritySearchQueryDTO
• UnauthorizedExceptionResponse
• UpdateDocumentRequestDTO

Documentation For Authorization

Endpoints do not require authorization.