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.
npm install --save 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.
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"
})
Embeddings
Embedding endpoints are natively supported within Portkey like this:
const embedding = await portkey.embeddings.create({
input: 'Name the tallest buildings in Hawaii',
model: 'voyage-3'
});
console.log(embedding);
Re-ranking
You can use Voyage reranking the portkey.post
method with the body expected by Voyage
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."
]
})
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:
Was this page helpful?