https://github.com/refuel-ai/refuel-sdk

Label, clean and enrich text datasets with LLMs
https://github.com/refuel-ai/refuel-sdk

Last synced: 8 days ago
JSON representation

Label, clean and enrich text datasets with LLMs

• Host: GitHub
• URL: https://github.com/refuel-ai/refuel-sdk
• Owner: refuel-ai
• License: mit
• Created: 2024-11-11T17:10:20.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-24T01:55:35.000Z (15 days ago)
• Last Synced: 2024-12-24T02:43:15.171Z (15 days ago)
• Language: TypeScript
• Homepage: https://www.refuel.ai/blog-posts/introducing-refuel-cloud
• Size: 297 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_ai_agents - Refuel-Sdk - Label, clean and enrich text datasets with LLMs (Building / Datasets)

README

        
# Refuel JavaScript SDK

The Refuel JavaScript SDK is a lightweight and easy-to-use client library for interacting with the [Refuel API](https://cloud-api.refuel.ai/docs). It enables you to label data, manage application responses, and collect feedback seamlessly within your JavaScript or TypeScript applications.

_Note: We also have a [SDK for Python](https://docs.refuel.ai/python-sdk/)._

# 📦 Installation

To install the SDK, use npm or yarn:

```sh

npm install refuel-sdk

```

or

```sh

yarn add refuel-sdk

```

# 🧑‍💻 Usage

To get started, you'll need a Refuel API key. You can find this in your [account settings](https://app.refuel.ai/settings) or contact your team administrator.

Import the SDK into your application and start interacting with the Refuel API:

## Example: Label Data

```javascript

import { Refuel } from "refuel-sdk";

const refuel = new Refuel("your_access_token");

const applicationLabels = await refuel.applications.label(

    "your_application_id",

    [

        // Data to label

        {

            menu_text:

                "Grilled chicken sandwich with avocado and chipotle mayo",

        },

    ]

);

```

## Example: Update Label with Feedback

```javascript

import { Refuel } from "refuel-sdk";

const refuel = new Refuel("your_access_token");

await refuel.applications.feedback(

    "your_application_id",

    "your_labeled_item_id",

    // Correct label

    {

        vegetarian: "no",

    }

);

```

# Questions?

Reach out to us at [email protected] with any questions!