@genai-impact/ecologits-openai/README.md

Ecologits.js Wrapper & Calculator for the OpenAI API

# Ecologits.js - OpenAI provider

## Install

### `npm`

```
npm install @genai-impact/ecologits-openai
```

### `yarn`

```
yarn add @genai-impact/ecologits-openai
```

## Usage (Wrapper)

```ts
import OpenAI from "@genai-impact/ecologits-openai";

const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});
const main = async () => {
  try {
    const response = await client.chat.completions.create({
      messages: [{ role: "user", content: "Tell me a funny joke!" }],
      model: "gpt-3.5-turbo",
    });
    // Get estimated environmental impacts of the inference
    console.log(
      `Energy consumption: ${response.impacts.energy.value} ${response.impacts.energy.unit}`
    );
    console.log(
      `GHG emissions: ${response.impacts.gwp.value} ${response.impacts.gwp.unit}`
    );
  } catch (e) {
    console.error(e);
    throw e;
  }
};
main();
```

## Usage (Calculator)

```ts
import { completeImpact } from "@genai-impact/ecologits-openai";
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

const model = "gpt-3.5-turbo";

const main = async () => {
  try {
    const startDate = new Date();
    const response = await client.chat.completions.create({
      messages: [{ role: "user", content: "Tell me a funny joke!" }],
      model,
    });
    const impacts = completeImpact(response, model, startDate);
    // Get estimated environmental impacts of the inference
    console.log(
      `Energy consumption: ${impacts.energy.value} ${impacts.energy.unit}`
    );
    console.log(`GHG emissions: ${impacts.gwp.value} ${impacts.gwp.unit}`);
  } catch (e) {
    console.error(e);
    throw e;
  }
};
main();
```