​
Overview

Async Integration let’s you log events and calls without placing Helicone in your app’s critical path. This ensures that an issue with Helicone will not cause an outage to your app.

1

Install Helicone Async

npm install @helicone/async
2

Initialize Logger

import { HeliconeAsyncLogger } from "@helicone/async";
import OpenAI from "openai";

const logger = new HeliconeAsyncLogger({
  apiKey: process.env.HELICONE_API_KEY,
  // pass in the providers you want logged
  providers: {
    openAI: OpenAI,
    //anthropic: Anthropic,
    //cohere: Cohere
    // ...
  }
});
logger.init();

const openai = new OpenAI();

async function main() {
  const completion = await openai.chat.completions.create({
    messages: [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Who won the world series in 2020?"},
      {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
      {"role": "user", "content": "Where was it played?"}
    ],
    model: "gpt-3.5-turbo",
  });

  console.log(completion.choices[0]);
}

main();
3

Properties

You can set properties on the logger to be used in Helicone using the withProperties method. (These can be used for Sessions, User Metrics, and more.)

const sessionId = randomUUID();

logger.withProperties({
  "Helicone-Session-Id": sessionId,
  "Helicone-Session-Path": "/abstract",
  "Helicone-Session-Name": "Course Plan",
}, () => {
  const completion = await openai.chat.completions.create({
    // ...
  })
})

​
Disabling Logging

You can completely disable all logging to Helicone if needed when using the async integration mode. This is useful for development environments or when you want to temporarily stop sending data to Helicone without changing your code structure.

# Disable all logging in async mode
logger.disable_logging()

# Later, re-enable logging if needed
logger.enable_logging()

When logging is disabled, no traces will be sent to Helicone. This is different from disable_content_tracing() which only omits request and response content but still sends other metrics. Note that this feature is only available when using Helicone’s async integration mode.

​
Supported Providers

  • OpenAI
  • Anthropic
  • Azure OpenAI
  • Cohere
  • Bedrock
  • Google AI Platform

​
Other Integrations

Was this page helpful?

Suggest editsRaise issue