oci-genai-provider-3b
v0.3.3
Published
Oracle Cloud Infrastructure Generative AI provider for Vercel AI SDK
Maintainers
Readme
@acedergren/oci-genai-provider
Community Project — This is an independent, community-maintained project with no official affiliation with Oracle Corporation.
Oracle Cloud Infrastructure (OCI) Generative AI provider for the Vercel AI SDK.
Complete ProviderV3 implementation supporting language models, embeddings, speech synthesis, transcription, and reranking.
Works with Any Vercel AI SDK Application
This provider implements the Vercel AI SDK's ProviderV3 interface, which means it works with:
- ✅ Next.js - App Router and Pages Router
- ✅ Remix - Streaming and non-streaming
- ✅ SvelteKit - Any SvelteKit app
- ✅ Express/Fastify - Node.js servers
- ✅ OpenCode - Terminal and Desktop (with optional integration package)
- ✅ Any Framework - If it uses Vercel AI SDK, it works
No special setup required - just install and use like any other AI SDK provider.
Features
- 5+ Model Types - Language models, embeddings, speech, transcription, reranking
- Language Models - Multiple model families via OCI GenAI (see available models)
- Embedding Models - Multilingual and English semantic search
- Speech Models (TTS) - OCI Speech Synthesis in Phoenix region
- Transcription Models (STT) - OCI Speech to Text services
- Reranking Models - Cohere Rerank for search optimization
- Streaming Support - Full streaming for language models
- Type Safety - Complete TypeScript definitions
- Auth Flexibility - Config file, instance principal, resource principal
Why Use OCI GenAI?
| Feature | OCI GenAI | Other Providers | | ---------------------- | ----------------------- | --------------- | | EU Data Residency | ✅ Frankfurt, Stockholm | Limited | | Grok Models | ✅ Available | ❌ | | Cost | 💰 Competitive | Varies | | Context Window | Up to 1M tokens | Up to 2M tokens | | Enterprise Support | ✅ Oracle Cloud | Varies |
Installation
npm install @acedergren/oci-genai-provider aiOr with pnpm:
pnpm add @acedergren/oci-genai-provider aiOr with yarn:
yarn add @acedergren/oci-genai-provider aiQuick Start
import { oci } from '@acedergren/oci-genai-provider';
import { generateText } from 'ai';
const result = await generateText({
model: oci.languageModel('cohere.command-r-plus'),
prompt: 'Explain quantum computing in simple terms',
});
console.log(result.text);Feature Support
This provider supports most Vercel AI SDK v6 features for text generation. See FEATURES.md for complete details.
Supported ✅
- Streaming and non-streaming generation
- Tool/function calling on OCI-supported models
- Temperature, topP, topK, penalties
- Seed parameter (best-effort determinism)
- Multiple model families (see Oracle docs)
- Retry logic and timeout control
Not Supported ❌
- Multi-modal input (vision, audio, documents)
- JSON mode (pending AI SDK integration)
For detailed information on each feature, see FEATURES.md.
Tool calling is available for OCI model families that support it, including Cohere Command models, Llama 3.1+, Grok, Gemini, and GPT-OSS on the OCI GENERIC API format. For Cohere request debugging, set OCI_GENAI_DEBUG_COHERE_REQUESTS=1 before running your tool loop.
Authentication
Option 1: OCI Config File (Recommended)
Create ~/.oci/config:
[DEFAULT]
user=ocid1.user.oc1..aaa...
fingerprint=12:34:56:78:...
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..aaa...
region=us-phoenix-1Set environment variables:
export OCI_CONFIG_PROFILE=DEFAULT
export OCI_COMPARTMENT_ID=ocid1.compartment.oc1..aaa...Option 2: Explicit Configuration
import { createOCI } from '@acedergren/oci-genai-provider';
const provider = createOCI({
region: 'us-phoenix-1',
compartmentId: 'ocid1.compartment.oc1..aaa...',
profile: 'DEFAULT',
});
const model = provider.languageModel('cohere.command-r-plus');Option 3: Instance Principal (OCI Compute)
const provider = createOCI({
auth: 'instance_principal',
region: 'us-phoenix-1',
});Option 4: OCI Generative AI API Key
const provider = createOCI({
auth: 'api_key',
apiKey: process.env.OCI_GENAI_API_KEY,
region: 'us-chicago-1',
compartmentId: 'ocid1.compartment.oc1..aaa...',
});
const model = provider.languageModel('openai.gpt-oss-120b');auth: 'api_key' currently uses OCI's OpenAI-compatible Bearer-token endpoint for supported chat models (Meta Llama, xAI Grok, and OpenAI GPT-OSS).
See Configuration Guide for complete authentication documentation.
Language Models
Generate text using powerful language models from multiple providers.
Available Models
OCI GenAI supports models from multiple families including Cohere, Meta Llama, and others. Model availability varies by region and changes over time.
Current catalog highlights in this package include:
meta.llama-4-maverick-17b-128e-instruct-fp8meta.llama-4-scout-17b-16e-instructmeta.llama-3.3-70b-instructgoogle.gemini-2.5-flashgoogle.gemini-2.5-progoogle.gemini-2.5-flash-litecohere.command-a-03-2025cohere.command-a-reasoning-08-2025cohere.command-a-vision-07-2025xai.grok-code-fast-1xai.grok-4.20-0309-reasoningxai.grok-4.20-0309-non-reasoningxai.grok-4.20-multi-agent-0309xai.grok-4-1-fast-reasoningxai.grok-4-1-fast-non-reasoningxai.grok-3-fastopenai.gpt-oss-120bopenai.gpt-oss-20b
See Oracle's pretrained model documentation for the current list of available models and their capabilities.
Usage
import { oci } from '@acedergren/oci-genai-provider';
import { streamText } from 'ai';
const result = streamText({
model: oci.languageModel('cohere.command-r-plus'),
messages: [{ role: 'user', content: 'Write a poem about clouds' }],
temperature: 0.7,
maxTokens: 500,
});
for await (const chunk of result.textStream) {
process.stdout.write(chunk);
}Deterministic Generation
Use the seed parameter for more consistent outputs (best-effort):
const result = await model.doGenerate({
prompt: [{ role: 'user', content: [{ type: 'text', text: 'Generate a random story' }] }],
seed: 42,
temperature: 0.7,
});
// Repeated calls with same seed produce similar (not identical) resultsSee Language Models Documentation for complete reference.
Speech-to-Text Transcription
Convert audio files to text using OCI Speech:
import { oci } from '@acedergren/oci-genai-provider';
import { transcribe } from 'ai';
import { readFileSync } from 'fs';
const audioData = readFileSync('audio.wav');
const { text } = await transcribe({
model: oci.transcriptionModel('oci.speech.standard', {
language: 'en-US',
vocabulary: ['OpenCode', 'GenAI'],
}),
audioData,
});
console.log('Transcript:', text);Available Transcription Models
See Oracle's Speech documentation for the current list of available transcription models, supported languages, and audio formats.
Transcription Options
oci.transcriptionModel('oci.speech.standard', {
language: 'en-US',
vocabulary: ['term1'],
});Supported Languages
21+ languages including: English (US/UK/AU/IN), Spanish, Portuguese, French, German, Italian, Japanese, Korean, Chinese, Dutch, Polish, Russian, Turkish, Hindi, Arabic.
Embeddings
Generate text embeddings for semantic search, clustering, and RAG applications.
Available Embedding Models
See Oracle's pretrained model documentation for the current list of available embedding models.
Usage
import { oci } from '@acedergren/oci-genai-provider';
import { embed, embedMany } from 'ai';
// Single embedding
const { embedding } = await embed({
model: oci.embeddingModel('cohere.embed-v4.0', {
dimensions: 1536,
embeddingTypes: ['float'],
}),
value: 'Hello world',
});
// Batch embeddings (up to 96 texts)
const { embeddings } = await embedMany({
model: oci.embeddingModel('cohere.embed-v4.0', {
inputType: 'SEARCH_DOCUMENT',
}),
values: ['Text 1', 'Text 2', 'Text 3'],
});cohere.embed-v4.0 adds multimodal embedding support plus configurable output dimensions (256, 512, 1024, 1536). The catalog also includes OCI image-capable variants such as cohere.embed-multilingual-image-v3.0.
See Embeddings Documentation for complete reference.
Speech Models (TTS)
Generate speech from text using OCI Speech services.
Usage
import { oci } from '@acedergren/oci-genai-provider';
import { generateSpeech } from 'ai';
const result = await generateSpeech({
model: oci.speechModel('oci-tts-standard', {
voice: 'en-US-Standard-A',
region: 'us-phoenix-1', // Speech only in Phoenix
}),
text: 'Hello, this is a test.',
});
// result.audio is a Buffer containing MP3 audioNote: Speech services are only available in the us-phoenix-1 region.
See Speech Models Documentation for complete reference.
Transcription Models (STT)
Convert speech to text using OCI Speech to Text services.
Usage
import { oci } from '@acedergren/oci-genai-provider';
import { transcribe } from 'ai';
import { readFileSync } from 'fs';
const audioBuffer = readFileSync('./audio.mp3');
const result = await transcribe({
model: oci.transcriptionModel('oci-stt-standard', {
language: 'en',
region: 'us-phoenix-1',
}),
audio: audioBuffer,
});
console.log(result.text);Note: Transcription services are only available in the us-phoenix-1 region.
See Transcription Models Documentation for complete reference.
Reranking Models
Improve search results with semantic reranking.
Usage
import { oci } from '@acedergren/oci-genai-provider';
import { rerank } from 'ai';
const { ranking } = await rerank({
model: oci.rerankingModel('cohere.rerank-v3.5'),
query: 'What is quantum computing?',
documents: [
'Quantum computing uses qubits...',
'Classical computers use bits...',
'Machine learning is a subset...',
],
topN: 2,
});
// ranking contains indices and relevance scores
console.log(ranking); // Top 2 most relevant documentsSee Reranking Models Documentation for complete reference.
Regional Availability
| Surface | Region Summary |
| ------------------- | -------------------------------------------------------------------------------------------------------------- |
| xAI Grok | Primarily us-ashburn-1 and us-chicago-1; check the Oracle model-region matrix per model |
| Meta Llama | Broad OCI commercial coverage, but model-specific |
| Google Gemini | Region-limited and externally hosted for some regions |
| Cohere Command | Broad OCI commercial coverage with some dedicated-only SKUs |
| OpenAI GPT-OSS | us-ashburn-1, us-chicago-1, us-phoenix-1, eu-frankfurt-1 in the current catalog |
| Embeddings | cohere.embed-v4.0 is on-demand in select regions; image-capable v3 variants vary and some are dedicated-only |
| Speech (TTS) | us-phoenix-1 only |
| Transcription (STT) | us-phoenix-1 only |
| Reranking | Model-specific; verify in Oracle model docs |
For exact availability, use Oracle’s Generative AI Models by Region page and the per-model docs. This package intentionally keeps exact model IDs current, while regions/modes should be treated as model-specific rather than universally available.
Error Handling
The provider includes specific error classes for different failure scenarios:
import {
OCIGenAIError,
NetworkError,
RateLimitError,
AuthenticationError,
ModelNotFoundError,
} from '@acedergren/oci-genai-provider';
try {
const result = await generateText({ model, prompt: 'Hello\!' });
} catch (error) {
if (error instanceof RateLimitError) {
console.log(`Retry after ${error.retryAfterMs}ms`);
} else if (error instanceof NetworkError) {
console.log(`Network error: ${error.code}`);
} else if (error instanceof AuthenticationError) {
console.log(`Auth failed: ${error.message}`);
} else if (error instanceof ModelNotFoundError) {
console.log(`Invalid model: ${error.modelId}`);
}
}Examples
Complete working examples live in the oci-genai-examples repository:
Monorepo workspace examples:
../../examples/SvelteKit chatbot with streaming
Next.js chatbot
RAG with embeddings
Text-to-speech
Speech-to-text
RAG with embeddings + reranking
Migration from v1.x
v2.0 introduces ProviderV3 support with breaking changes. See Migration Guide for detailed upgrade instructions.
Quick Migration
// v1.x (deprecated)
import { oci } from '@acedergren/oci-genai-provider';
const model = oci('cohere.command-r-plus'); // ❌ No longer supported
// v2.0 (ProviderV3)
import { oci } from '@acedergren/oci-genai-provider';
const model = oci.languageModel('cohere.command-r-plus'); // ✅ Use thisTroubleshooting
Common Issues
Authentication Error
Error: Authentication failedSolution: Verify your OCI config file and ensure OCI_COMPARTMENT_ID is set.
Region Not Available for Speech
Error: Speech services not available in this regionSolution: Use us-phoenix-1 region for speech/transcription services.
Model Not Found
Error: Invalid model IDSolution: Check available models for correct model IDs.
See Troubleshooting Guide for more solutions.
Documentation
- API Reference - Complete API documentation
- Language Models - Language model reference
- Embeddings - Embedding models reference
- Speech Models - Speech synthesis reference
- Transcription Models - Speech-to-text reference
- Reranking Models - Reranking reference
- Configuration Guide - Configuration and authentication
- Migration Guide - Upgrade from v1.x to v2.0
- Troubleshooting Guide - Common issues and solutions
TypeScript
Full type safety:
import type { OCIConfig, ModelMetadata } from '@acedergren/oci-genai-provider';
const config: OCIConfig = {
region: 'us-phoenix-1',
auth: 'config_file',
compartmentId: 'ocid1.compartment.oc1..test',
};Testing
Running Tests
# All tests
pnpm test
# With coverage
pnpm test:coverage
# Watch mode
pnpm test:watch
# Unit tests only
pnpm test:unit
# Integration tests
pnpm test:integrationCoverage
We maintain 80%+ test coverage across:
- Language models
- Embedding models
- Speech models (TTS)
- Transcription models (STT)
- Reranking models
View coverage report:
pnpm test:coverage
open coverage/lcov-report/index.htmlContributing Tests
See Testing Guide for detailed information on:
- Writing unit tests
- Writing integration tests
- Using test helpers and mocks
- Test fixtures and best practices
Development
This package is part of a monorepo. For contributors:
# Clone the monorepo
git clone https://github.com/acedergren/oci-genai-provider.git
cd oci-genai-provider
# Install dependencies (requires pnpm 10+)
pnpm install
# Build this package
pnpm --filter @acedergren/oci-genai-provider build
# Run tests
pnpm --filter @acedergren/oci-genai-provider test
# Run tests in watch mode
pnpm --filter @acedergren/oci-genai-provider test -- --watchContributing
See CONTRIBUTING.md for development setup and guidelines.
Legal
Community Project — This package is not affiliated with, endorsed by, or sponsored by Oracle Corporation. "OCI" and "Oracle Cloud Infrastructure" are trademarks of Oracle Corporation.
License
MIT
Support
- GitHub Issues: oci-genai-provider/issues
- Documentation: docs/
- Examples: oci-genai-examples
