> ## Documentation Index
> Fetch the complete documentation index at: https://portkey-docs-add-third-party-integration-issues-fixes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Ncompass
> Use Ncompass's AI models through Portkey for Snowflake-integrated deployments.
## Quick Start
Get started with Ncompass in under 2 minutes:
```python Python icon="python" theme={null}
from portkey_ai import Portkey
# 1. Install: pip install portkey-ai
# 2. Add @ncompass provider in model catalog
# 3. Use it:
portkey = Portkey(api_key="PORTKEY_API_KEY")
response = portkey.chat.completions.create(
model="@ncompass/meta-llama/Llama-3.1-8B-Instruct",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
```
```js Javascript icon="square-js" theme={null}
import Portkey from 'portkey-ai'
// 1. Install: npm install portkey-ai
// 2. Add @ncompass provider in model catalog
// 3. Use it:
const portkey = new Portkey({
apiKey: "PORTKEY_API_KEY"
})
const response = await portkey.chat.completions.create({
model: "@ncompass/meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
```
```python OpenAI Py icon="python" theme={null}
from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL
# 1. Install: pip install openai portkey-ai
# 2. Add @ncompass provider in model catalog
# 3. Use it:
client = OpenAI(
api_key="PORTKEY_API_KEY", # Portkey API key
base_url=PORTKEY_GATEWAY_URL
)
response = client.chat.completions.create(
model="@ncompass/meta-llama/Llama-3.1-8B-Instruct",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
```
```js OpenAI JS icon="square-js" theme={null}
import OpenAI from "openai"
import { PORTKEY_GATEWAY_URL } from "portkey-ai"
// 1. Install: npm install openai portkey-ai
// 2. Add @ncompass provider in model catalog
// 3. Use it:
const client = new OpenAI({
apiKey: "PORTKEY_API_KEY", // Portkey API key
baseURL: PORTKEY_GATEWAY_URL
})
const response = await client.chat.completions.create({
model: "@ncompass/meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
```
```sh cURL icon="square-terminal" theme={null}
# 1. Add @ncompass provider in model catalog
# 2. Use it:
curl https://api.portkey.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-d '{
"model": "@ncompass/meta-llama/Llama-3.1-8B-Instruct",
"messages": [{"role": "user", "content": "Hello!"}]
}'
```
## Add Provider in Model Catalog
Before making requests, add Ncompass to your Model Catalog:
1. Go to [**Model Catalog → Add Provider**](https://app.portkey.ai/model-catalog/providers)
2. Select **Ncompass**
3. Enter your Ncompass API key/JWT Token from Snowflake
4. Name your provider (e.g., `ncompass`)
See all setup options and detailed configuration instructions
***
## Supported Models
Ncompass provides Snowflake-integrated AI models:
Check [Ncompass' documentation](https://www.ncompass.tech/) for the complete model list.
***
## Next Steps
Add fallbacks, load balancing, and more
Monitor and trace your Ncompass requests
Manage and version your prompts
Add custom metadata to requests
For complete SDK documentation:
Complete Portkey SDK documentation