Documentation
¶
Overview ¶
Package models contains the generated model catalog and its persisted refresh overlay.
Package models contains the generated model catalog and runtime refresh layer.
Index ¶
- Constants
- func OrbUserAgent(version string) string
- func RefreshCodex(ctx context.Context, options RefreshOptions, token, accountID string) error
- type Catalog
- func (catalog *Catalog) BaseModels(overlay *Catalog) []ai.Model
- func (catalog *Catalog) Find(provider, id string) (ai.Model, bool)
- func (catalog *Catalog) MarshalJSON() ([]byte, error)
- func (catalog *Catalog) Merge(overlay *Catalog) *Catalog
- func (catalog *Catalog) MergedModels(overlay *Catalog) []ai.Model
- func (catalog *Catalog) Models(provider ...string) []ai.Model
- type RefreshOptions
Constants ¶
const ModelsDevURL = "https://models.dev/api.json"
Variables ¶
This section is empty.
Functions ¶
func OrbUserAgent ¶
OrbUserAgent formats the catalog-refresh User-Agent, mirroring upstream getPiUserAgent (pi-user-agent.ts) with Orb's public identity.
func RefreshCodex ¶ added in v0.11.0
func RefreshCodex(ctx context.Context, options RefreshOptions, token, accountID string) error
RefreshCodex replaces the stored openai-codex models with the list the ChatGPT account offers. Known models keep their catalog metadata; new ones inherit it from the highest-priority known model, taking name, cost and output limit from the same-id OpenAI API model when models.dev has one. The entry's freshness fields stay untouched, so the models.dev gate is unaffected; without an entry (no models.dev refresh yet) nothing is written.
Types ¶
type Catalog ¶
type Catalog struct {
// contains filtered or unexported fields
}
Catalog is an immutable-by-convention provider/model lookup.
func Builtin ¶
Builtin loads the catalog generated from the committed models.dev snapshot. The decoded catalog is cached for the process lifetime: the embedded JSON is immutable and every accessor returns detached values, so callers share one instance instead of re-decoding ~518KB per startup surface. The JSON ships gzip-compressed in generated.go and gunzips here on first use.
func LoadStore ¶
LoadStore restores the provider-scoped models-store.json overlay. Entries for providers bundled in the builtin catalog lose to a newer builtin: the overlay only applies when its lastModified is newer than the bundled catalog build time (upstream remote-catalog-provider.ts remoteModels).
func LoadStoreDocument ¶ added in v0.8.0
func Refresh ¶
func Refresh(ctx context.Context, options RefreshOptions) (*Catalog, error)
Refresh fetches models.dev and replaces only fetched providers in the persisted dynamic overlay. A completed refresh within the last 4 hours skips the network and returns the stored overlay (upstream remote-catalog-provider.ts gates on checkedAt plus lastModified presence).
func (*Catalog) BaseModels ¶ added in v0.16.0
BaseModels is MergedModels for callers that do not modify the models or anything they point to: without an overlay, they all share one sorted copy, so each model registry need not clone and sort the catalog again.
func (*Catalog) MarshalJSON ¶
func (*Catalog) MergedModels ¶ added in v0.4.13
MergedModels returns what Merge(overlay).Models() returns without materializing the intermediate merged catalog: each model is cloned exactly once into the sorted result.
type RefreshOptions ¶
type RefreshOptions struct {
StoreDocument document.Document
URL string
StorePath string
Client *http.Client
Now func() time.Time
// UserAgent identifies the client on the catalog request (upstream sends a
// pi User-Agent from remote-catalog-provider.ts).
UserAgent string
// Force bypasses the checkedAt refresh gate.
Force bool
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
genmodels
command
|
|
|
internal
|
|
|
cataloggen
Package cataloggen normalizes the models.dev api.json shape into pi models.
|
Package cataloggen normalizes the models.dev api.json shape into pi models. |