Voyage AI

Portkey provides a robust and secure gateway to facilitate the integration of various Large Language Models (LLMs) into your applications, including Voyage AI’s embedding and Re-rank endpoints.

With Portkey, you can take advantage of features like fast AI gateway access, observability, prompt management, and more, all while ensuring the secure management of your LLM API keys through a virtual key system.

Provider Slug: voyage

Portkey SDK Integration with Voyage

Portkey provides a consistent API to interact with models from Voyage. To integrate Voyage with Portkey:

1. Install the Portkey SDK

Add the Portkey SDK to your application to interact with Voyage AI’s models through Portkey’s gateway.

NodeJS

npm install --save portkey-ai

Python

pip install portkey-ai

2. Initialize Portkey with the API Key

To use Voyage with Portkey, get your API key from here, then add it to Portkey to create the virtual key.

NodeJS SDK

import Portkey from 'portkey-ai'

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY", // defaults to process.env["PORTKEY_API_KEY"]
    Authorization: "VOYAGE_API_KEY",  // Replace with your Voyage API key
    provider: "voyage"
})

Python SDK

from portkey_ai import Portkey

portkey = Portkey(
    api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
    Authorization="VOYAGE_API_KEY",  # Replace with your Voyage API key
    provider="voyage"
)

Embeddings

Embedding endpoints are natively supported within Portkey like this:

NodeJS

const embedding = await portkey.embeddings.create({
    input: 'Name the tallest buildings in Hawaii',
    model: 'voyage-3'
});

console.log(embedding);

Python SDK

embedding =  portkey.embeddings.create(
    input= 'Name the tallest buildings in Hawaii',
    model= 'voyage-3'
)

print(embedding)

Re-ranking

You can use Voyage reranking the portkey.post method with the body expected by Voyage

NodeJS SDK

const response = await portkey.post(
"/rerank",
{
  "model": "rerank-2-lite",
  "query": "What is the capital of the United States?",
  "documents": [
    "Carson City is the capital city of the American state of Nevada.",
    "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
    "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
    "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states."
  ]
})

Python SDK

response = portkey.post(
        "/rerank",
        model="rerank-2-lite",
        query="What is the capital of the United States?",
        documents=[
            "Carson City is the capital city of the American state of Nevada.",
            "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
            "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
            "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states."
        ]
    )

print(response)

Next Steps

The complete list of features supported in the SDK is available on the link below.

SDK

Explore the SDK documentation

You’ll find more information in the relevant sections:

1. Add metadata to your requests
2. Add gateway configs to your Voyage requests
3. Tracing Voyage requests
4. Setup a fallback from OpenAI to Voyage APIs