ads4gpts-openai v0.0.3

ADS4GPTs OpenAI

This is the OpenAI toolkit for ADS4GPTs.

An npm Typescript package that integrates ADS4GPTs functionalities into applications built with OpenAI TypeScript and JavaScript API Library, allowing for seamless retrieval of relevant advertisements based on contextual input.

Table of Contents

• Introduction
• Features
• Installation
• Usage
  • Prerequisites
  • Environment Variables
  • Initialization
  • Examples
• Contributing
• License
• Contact

Introduction

Ads4GPTs OpenAI Integration is a Typescript package designed to seamlessly incorporate Ads4GPTs functionalities into your OpenAI applications. It provides tools and utilities to retrieve contextually relevant advertisements, leveraging the power of OpenAI.

Whether you're building a chatbot, a recommendation system, or any application that can benefit from targeted ads, this package offers a robust and production-ready solution.

Show Your Support

If you find our ADS4GPTs project helpful, please give it a star ⭐️

Features

• Easy Integration:
  Quickly integrate ad retrieval capabilities into your OpenAI-driven applications.
• Contextual Ad Retrieval:
  Fetch relevant ads based on the provided context to enhance user engagement.
• Flexible and Extensible:
  Options to use each tool standalone or the whole toolkit for added flexibility
• Production-Ready:
  Clear error handling, retry logic, and environment-based configuration for a robust production setup.
• Privacy-First User data are provided not mined. You control what is being sent over.

Installation

You can install the package directly from npm:

npm install ads4gpts-openai

From Source

Alternatively, you can install the package from source:

1. Clone the repository:

git clone https://github.com/ADS4GPTs/ads4gpts.git

2. Navigate to the root folder of your app where you want to install the package.
3. Install the package:

npm install path/to/project/ads4gpts/libs/js-sdk/ads4gpts-openai

Linking the package from source

To link the package's source with your app's project and reflect changes in real-time, follow these steps:

1. Clone the repository:

git clone https://github.com/ADS4GPTs/ads4gpts.git

2. Navigate to the package's directory:

cd ads4gpts/libs/js-sdk/ads4gpts-openai

3. Link the package globally:

npm link

4. Navigate to the root folder of your app where you want to link the package.
5. Link the package to your app:

npm link ads4gpts-openai

Usage

Prerequisites

• Node.js 18.0.0+
• ADS4GPTs API Key
  • Obtain an API key for the ADS4GPTs service at https://ads4gpts.com/contact-us

Environment Variables

The package requires certain environment variables for API authentication:

• ADS4GPTS_API_KEY: Your ADS4GPTs API key.

Set them in your environment:

export ADS4GPTS_API_KEY='your-ads4gpts-api-key'

Alternatively, you can pass the API keys directly when initializing the toolkit or individual tools or set up a .env file.

Initialization

Import the necessary toolkit class or tools in your Typescript code:

import {
    ADS4GPTsToolkit,
    ADS4GPTsChatTool,
    ADS4GPTsBannerTool,
} from 'ads4gpts-openai';

Examples

Example 1: Using the ADS4GPTs Toolkit

import { ADS4GPTsToolkit } from 'ads4gpts-openai';

// Instantiate the toolkit (API key retrieved from environment variable)
const ads_toolkit = new ADS4GPTsToolkit();

// Retrieve ads using one of the tools
const chatArgs = {
    context: 'Looking for the latest smartphone deals',
    num_ads: 1,
};
const ads = await ads_toolkit.executeTool('ads4gpts_banner_tool', chatArgs);
console.log(ads);

Example 2: Using the tools Directly

import { ADS4GPTsChatTool } from 'ads4gpts-openai';

// Instantiate the tool (API key retrieved from environment variable)
const inChatAdsTool = new ADS4GPTsChatTool();

// Retrieve ads
const chatArgs = {
    context: 'Looking for the latest smartphone deals',
    num_ads: 1,
};
const ads = await inChatAdsTool.execute(chatArgs);
console.log(ads);

Examples for using them in your OpenAI application exist in the examples folder of the parent repo.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
2. Clone Your Fork:

git clone git@github.com:ADS4GPTs/ads4gpts.git

3. Create a Branch:

git checkout -b feature/your-feature-name

4. Make Changes: Implement your feature or bug fix.
5. Run Tests: Ensure all tests pass.

npm run test
# Or to automatically rerun tests when files change.
npm run test:watch

Formal tests are still under development.

6. Commit Changes:

git commit -am 'Add your commit message here'

7. Push to Your Fork:

git push origin feature/your-feature-name

8. Open a Pull Request: Navigate to the original repository and click "New pull request".

License

This project is licensed under the License of the ADS4GPTs repository.

Contact

• Author: ADS4GPTs
• Email: contact@ads4gpts.com
• GitHub: @ads4gpts

For issues and feature requests, please use the GitHub issues page.