# floomai

> Floom orchestrates & executes Generative AI pipelines, Empowering Developers and DevOps to focus on what matters.

Latest version **1.0.1** (published 2024-02-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install floomai
pnpm add floomai
yarn add floomai
bun add floomai
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-02-28 |
| First published | 2023-09-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Floom |
| Maintainers | floomai |
| Keywords | GenAI, Generative AI, Generative, Langchain, llamaindex, llm, ai, artificial intelligence, floom |

## Links

- npm: https://www.npmjs.com/package/floomai
- npm.io page: https://npm.io/package/floomai

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.5.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-02-28
- 1.0.0 — 2023-09-12

## README

# FloomSDK for Node.js

FloomSDK is a powerful Node.js client designed to simplify integrating Floom's Generative AI capabilities into your Node.js or TypeScript applications. This SDK provides an easy-to-use interface for interacting with Floom's API, enabling developers to focus on creating innovative applications without worrying about the underlying API calls.

## Features

- **Easy Integration**: Quickly add Floom's Generative AI features to your projects.
- **TypeScript Support**: Comes with TypeScript definitions for better development experience.
- **Flexible**: Use with both JavaScript and TypeScript projects.

## Getting Started

### Prerequisites

- Node.js (version 12.x or newer)
- An API key from Floom

### Installation

Install FloomSDK using npm:

```bash
npm install floomai
```

Or using yarn:

```bash
yarn add floomai
```

### Basic Usage

Here's how you can get started with the FloomSDK in your Node.js or TypeScript project:

```javascript
const { FloomClient, DataTransferType } = require('floomai');

const main = async () => {
    const floomClient = new FloomClient(
        "floom-endpoint",
        "api-key"
    );

    try {
        const response = await floomClient.run(
            "pipeline-idm-docs1",
            "",
            "How do I reset the oil alert in my dashboard?",
            null,
            DataTransferType.Base64
        );
        if(response.values) {
            console.log('Floom response:', response.values[0].value);
        }
    } catch (error) {
        console.error('An error occurred connecting to Floom:', error);
    }
};

main();
```

## Documentation

For detailed documentation and API references, visit [Floom Documentation](https://floom.ai/docs).

## Support and Contributions

If you encounter any issues or require assistance, please file an issue on our [GitHub issues page](https://github.com/FloomAI/FloomSDK-NodeJS/issues).

Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request.

## License

FloomSDK is [MIT licensed](./LICENSE).

---
_Source: https://npm.io/package/floomai · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._