Interface SignageAIProviderRequest

Body of a request creating or updating a provider row. credentials is required on create; left out of an update the stored value is kept

interface SignageAIProviderRequest {
    allowed_models?: string[];
    credentials?: Record<string, any>;
    default_model?: string;
    enabled?: boolean;
    endpoint?: string;
    is_default?: boolean;
    location?: string;
    name?: string;
    provider?: SignageAIProviderType;
    quotas?: Record<string, number>;
}

Properties

allowed_models? credentials? default_model? enabled? endpoint? is_default? location? name? provider? quotas?

Properties

Optionalallowed_models

allowed_models?: string[]

Models this row may be asked for

Optionalcredentials

credentials?: Record<string, any>

Vendor credentials, in the shape that vendor expects

Optionaldefault_model

default_model?: string

Model used when a request does not name one

Optionalenabled

enabled?: boolean

Whether the row may be used

Optionalendpoint

endpoint?: string

Vendor endpoint, for deployments that have their own

Optionalis_default

is_default?: boolean

Whether the row is the default for its domain

Optionallocation

location?: string

Vendor region, for deployments that have one

Optionalname

name?: string

Display name for the provider

Optionalprovider

provider?: SignageAIProviderType

Vendor the provider talks to

Optionalquotas

quotas?: Record<string, number>

Per user and per domain image allowances

Settings

Member Visibility

On This Page

Properties