-
Notifications
You must be signed in to change notification settings - Fork 2.9k
feat: add NEAR AI Cloud provider #8169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PierreLeGuen
wants to merge
2
commits into
janhq:main
Choose a base branch
from
PierreLeGuen:nearai-provider
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: NEAR AI Cloud | ||
| description: A step-by-step guide on integrating Jan with NEAR AI Cloud. | ||
| keywords: | ||
| [ | ||
| Jan, | ||
| local AI, | ||
| privacy focus, | ||
| conversational AI, | ||
| large language models, | ||
| NEAR AI, | ||
| NEAR AI Cloud, | ||
| TEE inference, | ||
| ] | ||
| --- | ||
|
|
||
| import { Callout, Steps } from 'nextra/components' | ||
| import { Settings } from 'lucide-react' | ||
|
|
||
| # NEAR AI Cloud | ||
|
|
||
| Jan supports [NEAR AI Cloud](https://cloud.near.ai) through its OpenAI-compatible API, allowing you to use NEAR-hosted models with TEE-backed private inference from Jan. | ||
|
|
||
| ## Integrate NEAR AI Cloud with Jan | ||
|
|
||
| <Steps> | ||
|
|
||
| ### Step 1: Get Your API Key | ||
| 1. Visit [NEAR AI Cloud](https://cloud.near.ai) and sign in | ||
| 2. Create or copy an API key for your account | ||
|
|
||
| <Callout type='info'> | ||
| NEAR AI Cloud model availability and TEE attestation support can vary by model. Check the public model catalog before selecting a model ID. | ||
| </Callout> | ||
|
|
||
| ### Step 2: Configure Jan | ||
|
|
||
| 1. Navigate to the **Settings** page (<Settings width={16} height={16} style={{display:"inline"}}/>) | ||
| 2. Under **Model Providers**, select **NEAR AI** | ||
| 3. Insert your **API Key** | ||
| 4. Keep the default base URL: `https://cloud-api.near.ai/v1` | ||
|
|
||
| ### Step 3: Start Using NEAR AI Cloud Models | ||
|
|
||
| 1. Open any existing **Chat** or create a new one | ||
| 2. Select a NEAR AI Cloud model from the **model selector** | ||
| 3. Start chatting | ||
| </Steps> | ||
|
|
||
| ## Available Models Through NEAR AI Cloud | ||
|
|
||
| Jan refreshes NEAR AI Cloud models from the public catalog at `https://cloud-api.near.ai/v1/model/list`. Use the `modelId` value from that catalog when adding a model manually. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **1. API Key Issues** | ||
| - Verify your API key is correct and not expired | ||
| - Confirm your account has access to the model you selected | ||
|
|
||
| **2. Connection Problems** | ||
| - Check your internet connection | ||
| - Verify the base URL is `https://cloud-api.near.ai/v1` | ||
| - Look for error messages in [Jan's logs](/docs/desktop/troubleshooting#how-to-get-error-logs) | ||
|
|
||
| **3. Model Unavailable** | ||
| - Confirm the model appears in the [NEAR AI Cloud model catalog](https://cloud-api.near.ai/v1/model/list) | ||
| - Check whether the model supports chat-style text output | ||
|
|
||
| Need more help? Join our [Discord community](https://discord.gg/FTk2MvZwJH). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { providerModels } from '../models' | ||
| import { predefinedProviders } from '../providers' | ||
|
|
||
| describe('NEAR AI predefined provider', () => { | ||
| it('registers NEAR AI Cloud as an OpenAI-compatible remote provider', () => { | ||
| const provider = predefinedProviders.find((p) => p.provider === 'nearai') | ||
|
|
||
| expect(provider).toBeDefined() | ||
| expect(provider?.base_url).toBe('https://cloud-api.near.ai/v1') | ||
| expect(provider?.explore_models_url).toBe( | ||
| 'https://cloud-api.near.ai/v1/model/list' | ||
| ) | ||
| expect(provider?.settings.map((s) => s.key)).toEqual([ | ||
| 'api-key', | ||
| 'base-url', | ||
| ]) | ||
| }) | ||
|
|
||
| it('uses the live model catalog instead of a static model list', () => { | ||
| expect(providerModels.nearai.models).toBe(true) | ||
| expect(providerModels.nearai.supportsStreaming).toBe(true) | ||
| expect(providerModels.nearai.supportsToolCalls).toBe(true) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.