Ncompass

Portkey provides a robust and secure gateway to facilitate the integration of various Large Language Models (LLMs) into your applications, including nCompass APIs.

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.

​

Portkey SDK Integration with nCompass Models

Portkey provides a consistent API to interact with models from various providers. To integrate nCompass with Portkey:

​

1. Install the Portkey SDK

Add the Portkey SDK to your application to interact with nCompass AI’s API through Portkey’s gateway.

npm install --save portkey-ai

npm install --save portkey-ai

pip install portkey-ai

​

2. Initialize Portkey with the Virtual Key

To use nCompass with Portkey, get your API key/JWT Token from the Snowflake Platform, 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"]
    virtualKey: "VIRTUAL_KEY" // Your nCompass Virtual Key
})

import Portkey from 'portkey-ai'

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY", // defaults to process.env["PORTKEY_API_KEY"]
    virtualKey: "VIRTUAL_KEY" // Your nCompass Virtual Key
})

from portkey_ai import Portkey

portkey = Portkey(
    api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
    virtual_key="VIRTUAL_KEY"   # Replace with your virtual key for nCompass
)

​

3. Invoke Chat Completions with nCompass

Use the Portkey instance to send requests to nCompass. You can also override the virtual key directly in the API call if needed.

const chatCompletion = await portkey.chat.completions.create({
    messages: [{ role: 'user', content: 'Say this is a test' }],
    model: 'meta-llama/Llama-3.1-8B-Instruct',
});

console.log(chatCompletion.choices);

const chatCompletion = await portkey.chat.completions.create({
    messages: [{ role: 'user', content: 'Say this is a test' }],
    model: 'meta-llama/Llama-3.1-8B-Instruct',
});

console.log(chatCompletion.choices);

completion = portkey.chat.completions.create(
    messages= [{ "role": 'user', "content": 'Say this is a test' }],
    model= 'meta-llama/Llama-3.1-8B-Instruct'
)

print(completion)

​

Managing nCompass Prompts

You can manage all prompts to nCompass in the Prompt Library. All the current models of nCompass are supported and you can easily start testing different prompts.

Once you’re ready with your prompt, you can use the portkey.prompts.completions.create interface to use the prompt in your application.

You’ll find more information in the relevant sections:

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