OpenAI Integration

​

Using OpenAI With Pezzo

Ensure that you have the latest version of the Pezzo Client installed, as well as the OpenAI NPM package.

npm i @pezzo/client openai

npm i @pezzo/client openai

pip install pezzo

​

Initialize Pezzo and PezzoOpenAI

Learn more about how to initialize the Pezzo Client:

• Node.js
• Python

​

Making Requests to OpenAI

​

Option 1: With Prompt Management (Recommended)

We recommend you to manage your AI prompts through Pezzo. This allows you to easily manage your prompts, and keep track of your AI requests. Click here to learn about Prompt Management in Pezzo.

Below is an example of how you can use Pezzo to retrieve a prompt, and then use it to make a request to OpenAI.

  // Fech prompt from Pezzo
  const prompt = await pezzo.getPrompt("PromptName");

  // Provide the prompt as-is to OpenAI
  const response = await openai.chat.completions.create(prompt);

  // Or you can override specific properties if you wish
  const response = await openai.chat.completions.create({
    ...prompt,
    model: "gpt-4",
  });

  // Fech prompt from Pezzo
  const prompt = await pezzo.getPrompt("PromptName");

  // Provide the prompt as-is to OpenAI
  const response = await openai.chat.completions.create(prompt);

  // Or you can override specific properties if you wish
  const response = await openai.chat.completions.create({
    ...prompt,
    model: "gpt-4",
  });

  from pezzo.client import pezzo
  from pezzo.openai import openai

  # Fetch prompt from Pezzo
  prompt = pezzo.get_prompt("PromptName")

  # Provide the prompt to OpenAI
  response = openai.ChatCompletion.create(
    pezzo_prompt=prompt
  )

  # You can override specific properties if you wish
  response = openai.ChatCompletion.create(
    pezzo_prompt=prompt,
    model="gpt-4"
  )

Congratulations! You’ve about to benefit from seamless prompt version management and request tracking. Your request will now be visible in the Requests page of your Pezzo project.

​

Option 2: Without Prompt Management

If you don’t want to manage your prompts through Pezzo, you can still use Pezzo to make requests to OpenAI and benefit from Pezzo’s Observability features.

You will consume the make request to the OpenAI exactly as you normally would. The only difference is that you will use the PezzoOpenAI instance we created above. Here is an example:

const response = await openai.chat.completions.create({
  model: "gpt-3.5-turbo",
  temperature: 0,
  messages: [
    {
      role: "user",
      content: "Hey, how are you doing?",
    },
  ],
});

const response = await openai.chat.completions.create({
  model: "gpt-3.5-turbo",
  temperature: 0,
  messages: [
    {
      role: "user",
      content: "Hey, how are you doing?",
    },
  ],
});

from pezzo.client import pezzo
from pezzo.openai import openai

response = openai.ChatCompletion.create(
  model="gpt-3.5-turbo",
  temperature=0,
  messages=[
    {
      "role": "user",
      "content": "Hey, how are you doing?",
    }
  ]
)

You should now be able to see your request in the Requests page of your Pezzo project.

​

Additional Capabilities

The Pezzo client enhances your developer experience by providing additional functionality to the OpenAI API. This is done through the second argument of the createChatCompletion method.

​

Variables

You can specify variables that will be interpolated by the Pezzo client before sending the request to OpenAI. This is useful if you want to use the same prompt for multiple requests, but with different variables.

const response = await openai.chat.completions.create(..., {
  variables: {
    age: 22,
    country: "France"
  }
});

const response = await openai.chat.completions.create(..., {
  variables: {
    age: 22,
    country: "France"
  }
});

response = openai.ChatCompletion.create(
  ...,
  pezzo_options={
    "variables": {
      "age": 22,
      "country": "France"
    }
  }
)

Notice the variables in the prompt. The Pezzo client will replace them with the values you specified in the variables object.

​

Custom Properties

You can also specify custom properties that will be sent to Pezzo. This is useful if you want to add additional information to your request, such as the user ID, or the request ID. This information will be visible in the Requests page of your Pezzo project, and you will be able to filter requests based on these properties.

const response = await openai.chat.completions.create({
  ...
}, {
  properties: {
    userId: "some-user-id",
    traceId: "some-trace-id"
  }
});

const response = await openai.chat.completions.create({
  ...
}, {
  properties: {
    userId: "some-user-id",
    traceId: "some-trace-id"
  }
});

response = await openai.ChatCompletion.create(
  ...,
  pezzo_options={
    "properties": {
      "userId": "some-user-id",
      "traceId": "some-trace-id"
    }
  }
)

​

Request Caching

Utilizing request caching can sometimes save up to 90% on your API costs and execution time. You can enable cache by setting cache to true in the second argument of the createChatCompletion method.

const response = await openai.chat.completions.create({
  ...
}, {
  cache: true
});

const response = await openai.chat.completions.create({
  ...
}, {
  cache: true
});

response = await openai.ChatCompletion.create(
  ...,
  pezzo_options={
    "cache": True
  }
)

To learn more, visit the Request Caching page.