nuxt-pinecone

Pinecone integration for Nuxt: realtime video, audio, and data with client composables and server utilities

0 downloads•2 stars•v0.0.2

arashsheyda

nuxt-pinecone

Nuxt module for Pinecone vector database. Provides a server-side usePinecone() composable with auto-import support.

Features

🔒 Server-only — API key is never exposed to the client
⚡ Auto-imported usePinecone() utility in server routes
🛠 Full PineconeConfiguration support (apiKey, controllerHostUrl, sourceTag, maxRetries, assistantRegion, caller)
📦 Zero config with environment variables

Quick Setup

Install the module to your Nuxt application:

npx nuxt module add nuxt-pinecone

Add it to your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['nuxt-pinecone'],
  pinecone: {
    // All PineconeConfiguration options are supported
    // apiKey is read from NUXT_PINECONE_API_KEY env var by default
  },
})

Set your API key via environment variable (recommended):

NUXT_PINECONE_API_KEY=your_api_key

Or directly in config (not recommended for production):

export default defineNuxtConfig({
  modules: ['nuxt-pinecone'],
  pinecone: {
    apiKey: 'your_api_key',
  },
})

Usage

Use the auto-imported usePinecone() composable in any server route or API handler:

// server/api/search.post.ts
export default defineEventHandler(async (event) => {
  const { query, topK } = await readBody(event)
  const pinecone = usePinecone()
  const index = pinecone.index('my-index')

  const results = await index.query({
    vector: query,
    topK: topK || 10,
    includeMetadata: true,
  })

  return results.matches
})

// server/api/indexes.get.ts
export default defineEventHandler(async () => {
  const pinecone = usePinecone()
  return await pinecone.listIndexes()
})

Configuration

All options from PineconeConfiguration are supported (except fetchApi and additionalHeaders which are not serializable):

Option	Env Variable	Description
`apiKey`	`NUXT_PINECONE_API_KEY`	Your Pinecone API key
`controllerHostUrl`	`NUXT_PINECONE_CONTROLLER_HOST_URL`	Custom controller host URL
`sourceTag`	`NUXT_PINECONE_SOURCE_TAG`	Tag applied to User-Agent header
`maxRetries`	`NUXT_PINECONE_MAX_RETRIES`	Max retries after initial request (default: 3)
`assistantRegion`	`NUXT_PINECONE_ASSISTANT_REGION`	Region for assistant APIs (default: "us")
`caller`	—	Caller info for User-Agent (set in config)

Contribution

Local development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch