catalog

type AdapterAPI ¶

type AdapterAPI struct {
	APIBase           string      `json:"apiBase"`
	PollInterval      PollSeconds `json:"pollInterval"`
	PollTimeout       PollSeconds `json:"pollTimeout"`
	FilePollInterval  PollSeconds `json:"filePollInterval"`
	FilePollTimeout   PollSeconds `json:"filePollTimeout"`
	PendingStatusText []string    `json:"pendingStatusText"`
	ReadyStatusText   string      `json:"readyStatusText"`
	FailedStatusText  []string    `json:"failedStatusText"`
	ImageFallbackExt  string      `json:"imageFallbackExt"`
	VideoFallbackExt  string      `json:"videoFallbackExt"`
}

AdapterAPI contains endpoints, polling settings, status values, and fallback extensions for an adapter.

• APIBase: the base API endpoint
• PollInterval: seconds between generation status requests
• PollTimeout: the generation polling budget in seconds
• FilePollInterval: seconds between file status requests
• FilePollTimeout: the file polling budget in seconds
• PendingStatusText: the statuses that indicate pending work
• ReadyStatusText: the status that indicates completed work
• FailedStatusText: the statuses that indicate failed work
• ImageFallbackExt: the fallback extension for downloaded images
• VideoFallbackExt: the fallback extension for downloaded videos

type Catalog ¶

type Catalog struct {
	Providers []Provider    `json:"providers"`
	Flags     []params.Flag `json:"flags,omitempty"`
	// contains filtered or unexported fields
}

Catalog contains validated providers, their flag definitions, and individual loading failures.

• Providers: the loaded providers in source order
• Flags: the parameter flag definitions used for validation

func LoadCatalog(flags []params.Flag, sources ...Source) (*Catalog, error)

func (catalog *Catalog) ConfigError(providerID string) error

func (catalog *Catalog) DefaultModelKey(availableProviders map[string]bool) (string, bool)

func (catalog *Catalog) ModelDirectory() []ProvModelPair

func (catalog *Catalog) Provider(providerID string) (Provider, bool)

func (catalog *Catalog) ResolveModelInput(modelSpecifier string) ([]ProvModelPair, error)

type ImageAPI ¶

type ImageAPI struct {
	GenURL                  string            `json:"genURL"`
	InputMediaURL           string            `json:"inputMediaURL"`
	InputMediaProvParam     string            `json:"inputMediaProvParam"`
	InputMediaListProvParam string            `json:"inputMediaListProvParam,omitempty"`
	InputMediaPayloadType   string            `json:"inputMediaPayloadType"`
	InputMediaStyle         InputMediaStyle   `json:"inputMediaStyle"`
	FixedProvFields         map[string]string `json:"fixedProvFields"`
	FallbackExt             string            `json:"fallbackExt"`
	RespImageURL            bool              `json:"respImageURL"`
}

ImageAPI describes the endpoints and wire format for image generation.

• GenURL: the image generation endpoint
• InputMediaURL: the endpoint used when input media is present
• InputMediaListProvParam: the array field for multiple single-or-array references
• InputMediaProvParam: the request field for input media
• InputMediaPayloadType: the request encoding for input media
• InputMediaStyle: the JSON layout for input media
• FixedProvFields: the constant request fields
• FallbackExt: the file extension used when the response does not identify its media format
• RespImageURL: whether response image URLs are downloaded

type InputMediaStyle ¶

type InputMediaStyle string

InputMediaStyle identifies the request layout used for input media.

const (
	InputMediaParts  InputMediaStyle = "parts"
	InputMediaSingle InputMediaStyle = "single-or-array"
	InputMediaNested InputMediaStyle = "nested"
	InputMediaString InputMediaStyle = "string"
)

type Model ¶

type Model struct {
	ID            string             `json:"id"`
	Name          string             `json:"name"`
	Description   string             `json:"description,omitempty"`
	Media         media.Kind         `json:"media"`
	Family        string             `json:"family,omitempty"`
	Aliases       []string           `json:"aliases,omitempty"`
	PromptIgnored bool               `json:"promptIgnored,omitempty"`
	DocsURL       string             `json:"docsURL,omitempty"`
	Params        params.Definitions `json:"params,omitempty"`
}

Model contains a model's identity, media kind, family, aliases, and accepted parameters.

• ID: the provider's model identifier
• Name: the model's configured display name
• Description: the optional model description
• Media: the kind of output the model produces
• Family: the model family used when a provider varies its request format by family
• Aliases: alternate model specifiers
• PromptIgnored: whether the model ignores the prompt and therefore requires none
• DocsURL: the model's documentation address
• Params: the parameter definitions accepted by the model

func (model *Model) Param(flagName params.FlagType) (params.Definition, bool)

func (model *Model) SupportsParam(flagName params.FlagType) bool

type PollSeconds ¶

type PollSeconds int

PollSeconds is an interval or timeout expressed in whole seconds in a provider description.

func (seconds PollSeconds) Duration() time.Duration

type ProvModelPair ¶

type ProvModelPair struct {
	Provider Provider
	Model    Model
}

ProvModelPair contains a provider and one of its models.

• Provider: the provider's identity; its models and request settings are read from the catalog
• Model: the selected model configuration

func SearchDirectory(pairs []ProvModelPair, searchTerm, excludeTerm string, useRegexp bool) ([]ProvModelPair, error)

func SelectMedia(pairs []ProvModelPair, imageSelected, videoSelected bool) []ProvModelPair

func (pair *ProvModelPair) Label() string

type Provider ¶

type Provider struct {
	ID           string          `json:"id"`
	DisplayName  string          `json:"displayName"`
	APIKeyEnvVar string          `json:"apiKeyEnvVar"`
	Aggregator   bool            `json:"aggregator,omitempty"`
	DefaultModel string          `json:"defaultModel,omitempty"`
	DocsURL      string          `json:"docsURL,omitempty"`
	Models       []Model         `json:"models,omitempty"`
	Config       *ProviderConfig `json:"config,omitempty"`
}

Provider contains the identity, models, and request settings declared by one provider configuration.

• ID: the provider's catalog identifier
• DisplayName: the provider name shown to users
• APIKeyEnvVar: the environment variable that supplies the provider's API key
• Aggregator: whether the provider offers models from multiple vendors
• DefaultModel: the model ID used for default selection, or empty when undeclared
• DocsURL: the provider's documentation address
• Models: the models in configuration order
• Config: the provider's request settings, absent in identity-only copies

func (p *Provider) Identity() Provider

type ProviderConfig ¶

type ProviderConfig struct {
	StringParams []params.FlagType `json:"stringParams,omitempty"`
	ImageAPI     *ImageAPI         `json:"imageAPI,omitempty"`
	VideoAPI     *VideoAPI         `json:"videoAPI,omitempty"`
	AdapterAPI   *AdapterAPI       `json:"adapterAPI,omitempty"`
}

ProviderConfig contains the request settings consumed by generators.

• StringParams: the parameters sent as strings regardless of their data type
• ImageAPI: the optional shared image API settings
• VideoAPI: the optional shared video API settings
• AdapterAPI: the optional settings for a provider-specific adapter

func (config *ProviderConfig) Clone() ProviderConfig

type Source ¶

type Source struct {
	ProviderID  string
	ConfigBytes []byte
}

Source identifies an embedded provider description supplied by the command.

• ProviderID: the provider identifier expected in the document
• ConfigBytes: the complete encoded provider description

type VideoAPI ¶

type VideoAPI struct {
	AsyncJobsURL            string          `json:"asyncJobsURL"`
	URLStartPath            string          `json:"urlStartPath"`
	JobIDField              string          `json:"jobIDField"`
	ProgressStatusText      []string        `json:"progressStatusText"`
	CompletedStatusText     string          `json:"completedStatusText"`
	FailedStatusText        []string        `json:"failedStatusText"`
	URLPathSeq              []string        `json:"urlPathSeq"`
	URLPathRequired         bool            `json:"urlPathRequired"`
	URLContentPath          string          `json:"urlContentPath"`
	AuthDownload            bool            `json:"authDownload"`
	InputMediaPayloadType   string          `json:"inputMediaPayloadType"`
	InputMediaProvParam     string          `json:"inputMediaProvParam"`
	InputMediaListProvParam string          `json:"inputMediaListProvParam,omitempty"`
	InputMediaStyle         InputMediaStyle `json:"inputMediaStyle"`
	InputMediaMustResize    bool            `json:"inputMediaMustResize"`
	FrameMediaProvParam     string          `json:"frameMediaProvParam"`
	FrameRoleProvParam      string          `json:"frameRoleProvParam"`
	FirstFrameProvValue     string          `json:"firstFrameProvValue"`
	LastFrameProvValue      string          `json:"lastFrameProvValue"`
	FallbackExt             string          `json:"fallbackExt"`
	PollInterval            PollSeconds     `json:"pollInterval"`
	PollTimeout             PollSeconds     `json:"pollTimeout"`
}

VideoAPI describes the endpoints, wire format, and polling settings for video generation.

• AsyncJobsURL: the base endpoint for video jobs
• URLStartPath: the path used to start a video job
• JobIDField: the response field containing the job identifier
• ProgressStatusText: the statuses that indicate a running job
• CompletedStatusText: the status that indicates a completed job
• FailedStatusText: the statuses that indicate a failed job
• URLPathSeq: the response path leading to the video download URL
• URLPathRequired: whether a completed response must contain a download URL
• URLContentPath: the path used to download video content when the response has no URL
• AuthDownload: whether same-origin downloads receive the provider credential
• InputMediaPayloadType: the request encoding for input media
• InputMediaListProvParam: the array field for multiple single-or-array references
• InputMediaProvParam: the request field for ordinary input media
• InputMediaStyle: the JSON layout for ordinary input media
• InputMediaMustResize: whether local input images must match the requested dimensions
• FrameMediaProvParam: the request field for timed frame images
• FrameRoleProvParam: the field naming a frame image's role
• FirstFrameProvValue: the role value for an opening frame
• LastFrameProvValue: the role value for a closing frame
• FallbackExt: the file extension used when the response does not identify its media format
• PollInterval: the number of seconds between job status requests
• PollTimeout: the maximum number of seconds allowed for job polling

func (api *VideoAPI) FrameFields() (present, complete bool)