Documentation
¶
Overview ¶
Package framework provides a list of dependencies that are required for the framework to work.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FrameworkConfig ¶ added in v1.1.8
type FrameworkConfig struct {
Pricing *modelcatalog.Config `json:"pricing,omitempty"`
}
FrameworkConfig represents the configuration for the framework.
type FrameworkDependency ¶
type FrameworkDependency string
FrameworkDependency is a type that represents a dependency of the framework.
const ( // FrameworkDependencyVectorStore indicates the framework requires a VectorStore implementation. FrameworkDependencyVectorStore FrameworkDependency = "vector_store" // FrameworkDependencyConfigStore indicates the framework requires a ConfigStore implementation. FrameworkDependencyConfigStore FrameworkDependency = "config_store" // FrameworkDependencyLogsStore indicates the framework requires a LogsStore implementation. FrameworkDependencyLogsStore FrameworkDependency = "logs_store" )
Directories
¶
| Path | Synopsis |
|---|---|
|
Package configstore provides a persistent configuration store for Bifrost.
|
Package configstore provides a persistent configuration store for Bifrost. |
|
tables
Package tables contains the database tables for the configstore.
|
Package tables contains the database tables for the configstore. |
|
Package encrypt provides reversible AES-256-GCM encryption and decryption utilities for securing sensitive data like API keys and credentials.
|
Package encrypt provides reversible AES-256-GCM encryption and decryption utilities for securing sensitive data like API keys and credentials. |
|
Package featureflags provides a process-wide boolean toggle registry with layered configuration sources (code default, configstore DB, config.json file) and an optional SyncDelegate hook for cluster gossip.
|
Package featureflags provides a process-wide boolean toggle registry with layered configuration sources (code default, configstore DB, config.json file) and an optional SyncDelegate hook for cluster gossip. |
|
Package gencache provides a generation-stamped memo cache: a value cache whose entries are invalidated wholesale when a monotonic "generation" counter advances.
|
Package gencache provides a generation-stamped memo cache: a value cache whose entries are invalidated wholesale when a monotonic "generation" counter advances. |
|
Package jobaccounting settles usage and cost for provider-side jobs after they complete, out of band from the original request.
|
Package jobaccounting settles usage and cost for provider-side jobs after they complete, out of band from the original request. |
|
Package logstore provides a logs store for Bifrost.
|
Package logstore provides a logs store for Bifrost. |
|
Package lrucache provides a bounded, generation-guarded LRU cache with single-flight fills, built for in-memory mirrors of database rows that are kept consistent by explicit eviction rather than TTLs.
|
Package lrucache provides a bounded, generation-guarded LRU cache with single-flight fills, built for in-memory mirrors of database rows that are kept consistent by explicit eviction rather than TTLs. |
|
Package mcp_headers implements schemas.MCPHeadersProvider against the configstore.
|
Package mcp_headers implements schemas.MCPHeadersProvider against the configstore. |
|
Package modelcatalog composes three subpackages — datasheet (pricing + model parameters + capabilities), live (per-(provider, keyID) list-models cache), and keyconfig (per-provider allow/block/aliases derived from keys) — into the ModelCatalog facade that consumers (governance, telemetry, logging, server, etc.) use.
|
Package modelcatalog composes three subpackages — datasheet (pricing + model parameters + capabilities), live (per-(provider, keyID) list-models cache), and keyconfig (per-provider allow/block/aliases derived from keys) — into the ModelCatalog facade that consumers (governance, telemetry, logging, server, etc.) use. |
|
datasheet
Package pricing owns the pricing/model-parameters catalog (compartments A + B + E): canonical pricing rows fetched from the upstream datasheet, per-provider datasheet-derived model views, supported request types and parameters, and scoped pricing overrides.
|
Package pricing owns the pricing/model-parameters catalog (compartments A + B + E): canonical pricing rows fetched from the upstream datasheet, per-provider datasheet-derived model views, supported request types and parameters, and scoped pricing overrides. |
|
keyconfig
Package keyconfig caches per-key configuration (allowed/blacklisted models, aliases) for every configured provider.
|
Package keyconfig caches per-key configuration (allowed/blacklisted models, aliases) for every configured provider. |
|
live
Package live caches the response of provider /v1/models calls per (provider, keyID, unfiltered).
|
Package live caches the response of provider /v1/models calls per (provider, keyID, unfiltered). |
|
Package objectstore provides object storage using S3-compatible backends, Google Cloud Storage, and Azure Blob Storage.
|
Package objectstore provides object storage using S3-compatible backends, Google Cloud Storage, and Azure Blob Storage. |
|
Package openapimcp synthesizes an in-process MCP server from an OpenAPI or Swagger document: every operation becomes one MCP tool whose handler issues the corresponding HTTP request against the upstream API.
|
Package openapimcp synthesizes an in-process MCP server from an OpenAPI or Swagger document: every operation becomes one MCP tool whose handler issues the corresponding HTTP request against the upstream API. |
|
Package overhead splits per-request overhead latency into per-phase buckets from a completed trace's spans.
|
Package overhead splits per-request overhead latency into per-phase buckets from a completed trace's spans. |
|
Package passthroughparse decodes the raw request and response bodies of a passthrough call into Bifrost's typed request/response schemas, so passthrough traffic can be logged and rendered like any other request.
|
Package passthroughparse decodes the raw request and response bodies of a passthrough call into Bifrost's typed request/response schemas, so passthrough traffic can be logged and rendered like any other request. |
|
Package plugins provides a framework for dynamically loading and managing plugins
|
Package plugins provides a framework for dynamically loading and managing plugins |
|
Package queryscope provides the primitive that wrappers use to push a per-call SQL constraint onto the request context for inner stores to consume.
|
Package queryscope provides the primitive that wrappers use to push a per-call SQL constraint onto the request context for inner stores to consume. |
|
Package queue is a durable, pluggable message queue with Kafka-shaped semantics: producers publish messages to a topic, and every consumer group subscribed to that topic receives every message, while the consumers inside one group compete for it.
|
Package queue is a durable, pluggable message queue with Kafka-shaped semantics: producers publish messages to a topic, and every consumer group subscribed to that topic receives every message, while the consumers inside one group compete for it. |
|
Package rssfeed fetches and parses RSS 2.0 and Atom feeds for the dashboard news tray.
|
Package rssfeed fetches and parses RSS 2.0 and Atom feeds for the dashboard news tray. |
|
Package storehooks lets a downstream build observe every runtime database pool the config and logs stores open, at the moment it opens.
|
Package storehooks lets a downstream build observe every runtime database pool the config and logs stores open, at the moment it opens. |
|
Package streaming provides functionality for accumulating streaming chunks and other chunk-related workflows
|
Package streaming provides functionality for accumulating streaming chunks and other chunk-related workflows |
|
Package tracing provides distributed tracing infrastructure for Bifrost
|
Package tracing provides distributed tracing infrastructure for Bifrost |
|
Package vectorstore provides a generic interface for vector stores.
|
Package vectorstore provides a generic interface for vector stores. |
|
Package warp holds the dashboard agent: its configuration, the model client it talks through, the read-only tools it researches with, and the loop that ties them together.
|
Package warp holds the dashboard agent: its configuration, the model client it talks through, the read-only tools it researches with, and the loop that ties them together. |
|
Package webhooks delivers signed event notifications to registered webhook endpoints.
|
Package webhooks delivers signed event notifications to registered webhook endpoints. |
Click to show internal directories.
Click to hide internal directories.