Skip to content
Mixedbread Mixedbread Search

Configuration

The Mixedbread Starlight plugin offers several configuration options to customize the search experience.

Plugin Options

Section titled “Plugin Options”

Configure the plugin in your astro.config.mjs:

starlightMixedbread({
  // Required options
  apiKey: process.env.MXBAI_API_KEY,
  storeId: process.env.MXBAI_STORE_ID,


  // Optional options
  maxResults: 8,
  baseUrl: 'https://api.mixedbread.com',
  disableUserPersonalization: false,
})

Required Options

Section titled “Required Options”

apiKey

Section titled “apiKey”
  • Type: string
  • Required: Yes
  • Description: Your Mixedbread API key for authentication
apiKey: process.env.MXBAI_API_KEY

storeId

Section titled “storeId”
  • Type: string
  • Required: Yes
  • Description: The identifier for your vector store
storeId: process.env.MXBAI_STORE_ID

Optional Options

Section titled “Optional Options”

maxResults

Section titled “maxResults”
  • Type: number
  • Default: 10
  • Description: Maximum number of search results to display
maxResults: 8  // Show up to 8 results

baseUrl

Section titled “baseUrl”
  • Type: string
  • Default: 'https://api.mixedbread.com'
  • Description: Base URL for the Mixedbread API (useful for custom deployments)
baseUrl: 'https://api.mixedbread.com'

disableUserPersonalization

Section titled “disableUserPersonalization”
  • Type: boolean
  • Default: false
  • Description: Disable local storage features (recent searches, favorites)
disableUserPersonalization: true  // Don't save user preferences

Search API Configuration

Section titled “Search API Configuration”

Customize the search endpoint in src/pages/api/search.ts:

Search Parameters

Section titled “Search Parameters”
const response = await mxbai.stores.search({
  query,                              // User's search query
  store_identifiers: [MXBAI_STORE_ID], // Your store(s)
  top_k: 10,                          // Number of results
  search_options: {
    return_metadata: true,             // Include metadata
  },
})

Metadata Filtering

Section titled “Metadata Filtering”

You can filter results by metadata:

search_options: {
  return_metadata: true,
  filter: {
    // Add custom filters here
  }
}

Learn more about metadata filtering here.