open-index/open-npm huggingface dataset:
npm package: @quickembedai/sdk
Description: Node.js SDK for QuickEmbed AI SaaS Platform
Author: QuickEmbed AI Team
Latest version: 1.0.3

# QuickEmbed AI Node.js SDK 🚀

The official Node.js SDK for the **QuickEmbed AI Platform** ([quickembedai.com](https://quickembedai.com)).

### **Add RAG-powered AI chatbots to your software in just 5 lines of code.**

QuickEmbed AI is an enterprise-grade **RAG-as-a-Service** platform. It eliminates the complexity of vector databases, chunking strategies, and LLM orchestration, allowing you to focus on your product.

---

## 🔗 Links
- **Official Website**: [quickembedai.com](https://quickembedai.com)
- **Full Documentation**: [https://quickembedai.com/help-center](https://quickembedai.com/help-center)
- **API Dashboard**: [quickembedai.com/dashboard/developers](https://quickembedai.com/dashboard/developers)

---

## 💻 Installation
```bash
npm install @quickembedai/sdk
```

---

## ⚡ Quick Start (5 Lines of Code)
```typescript
import { QuickEmbedAIClient } from '@quickembedai/sdk';

const client = new QuickEmbedAIClient('YOUR_API_KEY');

// 1. Ingest Data (URL, File, or Text)
await client.ingestUrl('https://docs.yourcompany.com', 'your-tenant-id');

// 2. Query with RAG (Instant Answer)
const { answer } = await client.query('How does the product work?', 'your-tenant-id');

console.log(answer);
```

---

## 🎯 Key Features
- **TypeScript First**: Full type safety for Enterprise applications.
- **Universal SDK**: Works perfectly in **Node.js backends**, **Edge functions**, and **Browser environments**.
- **Multi-Tenant Architecture**: Isolate data effortlessly using `tenant_id`.
- **Streaming Support**: Real-time token streaming for a ChatGPT-like experience.
- **Insights & Analytics**: Access document health scores and AI-generated insights via the SDK.

---

## 📖 API Reference

### `new QuickEmbedAIClient(apiKey, options)`
- `apiKey`: Your secret API key from the developer dashboard.
- `options.baseUrl`: Defaults to `https://quickembedai.com/api/v1`.

### `client.query(message, tenantId, options)`
Standard RAG inquiry. Returns `{ answer, sources }`.

### `client.queryStream(message, tenantId, onChunk, options)`
Streams AI responses token-by-token. Ideal for real-time UIs.

### `client.ingestUrl(url, tenantId)`
Crawl and index content from any public URL.

### `client.ingestFile(filePath, tenantId)`
Process and vectorize local PDF, DOCX, or CSV files.

---

## 🛡️ License
MIT © [QuickEmbed AI Team](https://quickembedai.com)
npm package: @quicker-js/class-transformer
Description: class-transformer is used to convert a plain object to a class instance and the reverse process.
Author: YunlongRan
Latest version: 2.0.0

# class-transformer
class-transformer is used to convert a plain object to a class instance and the reverse process.

## Installing

```shell
npm i @quicker-js/class-transformer
#or
yarn add @quicker-js/class-transformer
```

## Documentation
- [ApiDocs](https://quicker-js.github.io/class-transformer/)
- [Samples](https://github.com/quicker-js/class-transformer/tree/master/sample)
- [GitRepository](https://github.com/quicker-js/class-transformer)


## Issues
Create [issues](https://github.com/quicker-js/class-transformer/issues) in this repository for anything related to the Class Transformer. When creating issues please search for existing issues to avoid duplicates.


## License
Licensed under the [MIT](https://github.com/quicker-js/class-transformer/blob/master/LICENSE) License.
npm package: @quicker-js/http
Description: The HTTP module takes the corresponding data from the class-transformer conversion instance and sends a request to the server. This module uses Axios.
Author: YunlongRan
Latest version: 1.0.4

# http
The `@quicker-js/http` module takes the corresponding data from the [@quicker-js/class-transformer](https://github.com/quicker-js/class-transformer) conversion instance and sends a request to the server. This module uses Axios.

## Installing

```shell
npm i @quicker-js/http
#or
yarn add @quicker-js/http
```

## Documentation
- [ApiDocs](https://quicker-js.github.io/http/)
- [Samples](https://github.com/quicker-js/http/tree/master/sample)
- [GitRepository](https://github.com/quicker-js/http)


## Issues
Create [issues](https://github.com/quicker-js/http/issues) in this repository for anything related to the Class Transformer. When creating issues please search for existing issues to avoid duplicates.


## License
Licensed under the [MIT](https://github.com/quicker-js/http/blob/master/LICENSE) License.
npm package: @quicker-js/swagger-generator
Description: swagger-generator is used to convert a swagger api to a class instance. support url or json file.
Author: YunlongRan
Latest version: 1.1.0

# swagger-generator
swagger-generator is used to convert a swagger api to a class instance. support url or json file.

## Installing

```shell
npm i @quicker-js/swagger-generator
#or
yarn add @quicker-js/swagger-generator
```

## UseAge
Create `swagger-generator.config.js` in the root directory of the project.
```js
module.exports = {
  namespaces: {},
  output: path.resolve('src', 'api'),
  globalFiles: [],
  replaces: [],
  excludes: [],
}
```

### namespaces
This option is added in the form of keyValue, which can be a URL or a local file

```js
const path = require('path')
// "system.json" in project the root directory.
// "system.json" should a "swagger" json file.
// fetch the "https://app.com/test/v2/api-docs" url should response a "swagger" json file.
module.exports = {
  namespaces: {
    system: path.resolve('system.json'),
    test: 'https://app.com/test/v2/api-docs'
  },
}
```

### output
This option specifies the directory where the model file is generated.
```js
const path = require('path')
module.exports = {
  output: path.resolve('src', 'api'),
}
```

### globalFiles
This option is used to specify some generic class models, which are generally shared by the whole project.
```js
module.exports = {
  globalFiles: ['ResponseList', 'PageList'],
}
```

### replaces
This option is used to replace the path path or model name in the model.
```js
module.exports = {
  replaces: [
    {
      // Replace version number in path
      // For example, from:
      // @ApiRequest({
      //   url: '/order-v100001/info/{id}',
      // })
      // to:
      // @ApiRequest({
      //   url: '/order/info/{id}',
      // })
      test: /-v100001/,
      // Replace value
      value: '',
      // Replace type is path
      type: 'path',
    },
    {
      // Replace model name in name
      // For example, ResponseResult will be replaced with R
      test: /^ResponseResult/,
      // Replace value
      value: 'R',
      // Replace type is name
      type: 'name',
    },
  ],
}
```

### excludes
This option specifies which model names are excluded from the build file.
```js
module.exports = {
  // Can be string or regexp.
  excludes: [
    /\PageData/,
    'PageData'
  ]
}
```

## Documentation
- [ApiDocs](https://quicker-js.github.io/swagger-generator/)
- [Samples](https://github.com/quicker-js/swagger-generator/tree/master/sample)
- [GitRepository](https://github.com/quicker-js/swagger-generator)


## Issues
Create [issues](https://github.com/quicker-js/swagger-generator/issues) in this repository for anything related to the Class Transformer. When creating issues please search for existing issues to avoid duplicates.


## License
Licensed under the [MIT](https://github.com/quicker-js/swagger-generator/blob/master/LICENSE) License.
npm package: @quickey/react
Description: Create quickey for react elements
Author: Udi Talias
Latest version: 1.2.1

# `@quickey/react`

> Create quickey for react elements

## Intro

With Quickey React you can create quickey objects from react JSX using the <QuickeyContext /> element.

## Install

Quickey React can be installed via [npm](https://www.npmjs.com):
```sh
$ npm install --save @quickey/react
```

Or via [yarn](https://yarnpkg.com):
```sh
$ yarn add @quickey/react
```

Or using the [CDN](https://unpkg.com):

```html
<script src="https://unpkg.com/@quickey/react@latest/umd/quickey.react.js"></script>
```
Or the minified version:
```html
<script src="https://unpkg.com/@quickey/react@latest/umd/quickey.react.min.js"></script>
```

## Peer Dependencies

You should install [@quickey/core](../core) in order to use this package.

## Usage

```jsx
import { QuickeyContext } from "@quickey/react";

// Or when using the UMD module

const { QuickeyContext } = Quickey.react;

function App() {
    return (
        <div>
            <header>...</header>
            <p>...</p>
            <QuickeyContext
                id="cheats"
                actions={[
                    { keys: "I > D > D > Q > D", callback: () => console.log("GOD Mode!") },
                    { keys: "I > D > K > F > A", callback: () => console.log("Full Inventory!") }
                ]}
            >
                <p>
                    Focus this element and use the quickey actions
                </p>
            </QuickeyContext>
            <p>...</p>
            <footer>...</footer>
        </div>
    );
}
```

For your convenience, we created this [**Fiddle**](http://jsfiddle.net/udidu/53boL7um/30/), so you can take Quickey React for a quick spin.


## API

### Quickey Context

#### <QuickeyContext {...props} />

##### props

Type: `object`

###### type

Type: `string`

Wrapper root element type (e.g. `div`, `span`...);

Default: `div`

###### global

Type: `boolean`

Whether to bind the quickey object to the current target element or use it as global (bound to the document).

###### id

Type: `string`

You can supply an id to the quickey object so you can access it later.

###### title

Type: `string`

Describe this object with a title.

###### actions

Type: `Array`

A list of actions.

###### onDestroy

Type: `function`

Destroy callback function.

---
[&larr; Go back](/README.md) to Quickey
npm package: @quickey/ui
Description: Quickey UI elements
Author: Udi Talias
Latest version: 1.2.1

# `@quickey/ui`

> Quickey UI elements

## Intro

The Quickey UI package contains UI elements. This elements will save you development time when integrating Quickey into your app. For example, if you want to show your users a list of Quickey actions, you can use the **Quickey Legend** element:

<p align="center">
    <img alt="quickey" src="https://raw.githubusercontent.com/quickey/quickey/master/assets/ui.png"/>
</p>

## Install

Quickey UI can be installed via [npm](https://www.npmjs.com):
```sh
$ npm install --save @quickey/ui
```

Or via [yarn](https://yarnpkg.com):
```sh
$ yarn add @quickey/ui
```

Or using the [CDN](https://unpkg.com):

```html
<script src="https://unpkg.com/@quickey/ui@latest/umd/quickey.ui.js"></script>
```
Or the minified version:
```html
<script src="https://unpkg.com/@quickey/ui@latest/umd/quickey.ui.min.js"></script>
```

## CSS

Quickey UI contains css so you need to load it in order to make things look pretty. 💅

Use the CDN:

```html
<script src="https://unpkg.com/@quickey/ui@latest/umd/quickey.css"></script>
```

Or, if you're using a bundler (like webpack) with sass-loader, you can import the element style directly.

```javascript
import "@quickey/ui/lib/legend/styles/legend.scss";
```

## Peer Dependencies

You should install [@quickey/core](../core) in order to use this package.

## Usage

```javascript
const { createQuickey } = "@quickey/core";
import { createQuickeyLegend } from "@quickey/ui";

// Or when using the UMD module

const { createQuickey } = Quickey.core;
const { createQuickeyLegend } = Quickey.ui;

createQuickey([{
    id: "cheats",
    title: "Cheat Codes",
    actions: [...]
}, {
    id: "game",
    title: "Game Play",
    actions: [...]
}]);

const unmount = createQuickeyLegend({
    ids: ["cheats", "game"],
    el: document.querySelector(".legend")
});
```

For your convenience, we created this [**Fiddle**](http://jsfiddle.net/udidu/8ekzmns2/19/), so you can take Quickey UI for a quick spin.

## List of UI elements

* [Quickey Legend](#Quickey-Legend)
* ...


## API

### Quickey Legend

#### createQuickeyLegend([options])

Type: `function`

Creates and renders a new Quickey Legend element. It returns a `function` for unmounting the element from the DOM.

##### options

Type: `object`

###### ids

Type: `Array`

A list of Quickey ids.

###### el

Type: `Element`

The element container.

###### title

Type: `string` - optional

Default: `Keyboard Shortcuts`

Legend title.

###### showCredits

Type: `boolean` - optional

Default: `true`

Show footer credits.

###### searchBarPlaceholder

Type: `string` - optional

Default: `Search for shortcut...`

Placeholder for the legend search input.

###### style

Type: `object` - optional

If you want to add some css styles to the root element, use this object.

---
[&larr; Go back](/README.md) to Quickey