Skip to content
ContractSpec
Start here

Package manual · integrations

·Knowledge, retrieval and evidence

integration.provider-embedding

Embedding provider implementations for ContractSpec.

integrationsintegrationv2.0.5experimentalservernode
@lssm-tech/integration.provider-embedding
bun add @lssm-tech/integration.provider-embedding
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Embedding provider implementations for ContractSpec with deterministic batch ordering and fail-closed vector validation.

  • MistralEmbeddingProvider uses the Mistral SDK and rejects empty inputs, over-budget batches, incomplete or index-invalid responses, missing usage, non-finite vectors, and requested dimension drift. It forwards explicit output dimensions and abort signals and performs bounded transient retries.
  • OpenAIEmbeddingProvider implements the official POST /v1/embeddings REST contract, defaults to text-embedding-3-small, and supports optional dimensions, abort signals, bounded transient retries, organization/project headers, and injected fetch. Its default limits track the API contract: 2,048 inputs, 8,192 tokens per input, and 300,000 tokens per request.

Both adapters attach one provider-reported EmbeddingUsageReceipt to every result in a request. Cost is unavailable until the caller injects a calculator backed by a pinned pricing reference; adapters never guess current prices. The default UTF-8 byte counter is deliberately conservative. Inject a model-aware tokenizer when maximum batch utilization matters. Mistral's configurable default limits are local platform guardrails because its public endpoint contract does not publish equivalent batch ceilings.

API keys remain constructor-only secret material and never appear in result metadata or error messages. Callers should pin model, dimension, chunker, normalizer, and policy revisions in their index-generation fingerprint.

Usage

Import the root entrypoint for the domain surface, or import a concrete implementation from the ./impls/* subpaths.

Compatibility

This package owns the embedding implementation slice split out of @lssm-tech/integration.providers-impls. The legacy package continues to re-export these subpaths for existing consumers.

Vercel AI Gateway embeddings

GatewayEmbeddingProvider from @lssm-tech/integration.provider-embedding/impls/gateway-embedding calls the Gateway's OpenAI-compatible POST https://ai-gateway.vercel.sh/v1/embeddings with the host-resolved AI_GATEWAY_API_KEY or Vercel OIDC token. Each request carries providerOptions.gateway (only, inference region — EU by default —, zeroDataRetention, disallowPromptTraining: true). The model is fixed at construction (exact <author>/<model>, no latest/auto), requests are never retried because a lost response may already be billed, and a response whose reported final provider is outside only is rejected. Usage receipts report provider vercel-ai-gateway.

Relationships

THIS PACKAGEintegration.provider-embedding7 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

2 declarations

Declared capabilities

Integration Provider Embedding

Embedding provider implementations for ContractSpec.

Scripts

  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lint:checknode ../../../scripts/biome.cjs check .
  • lint:fixnode ../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../scripts/biome.cjs check --write .
  • testbun test
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit