Skip to content

@graphty/graphty-element / catalog / AiProviderDescriptor

Interface: AiProviderDescriptor ​

Defined in: graphty-element/src/catalog/ai.ts:53

One AI provider.

Properties ​

defaultModel ​

readonly defaultModel: string

Defined in: graphty-element/src/catalog/ai.ts:67

The model used when ProviderOptions.model is not set.


id ​

readonly id: "openai" | "anthropic" | "google" | "webllm" | "mock"

Defined in: graphty-element/src/catalog/ai.ts:55

The provider id, as createProvider and the key store take it.


keyShape? ​

readonly optional keyShape?: AiKeyShape

Defined in: graphty-element/src/catalog/ai.ts:61

What its keys look like; absent for a provider that takes none.


models ​

readonly models: readonly AiModelDescriptor[]

Defined in: graphty-element/src/catalog/ai.ts:69

The models the element knows this provider offers. Any other model id may still be configured.


plainName ​

readonly plainName: string

Defined in: graphty-element/src/catalog/ai.ts:57

The provider's own name.


requiresKey ​

readonly requiresKey: boolean

Defined in: graphty-element/src/catalog/ai.ts:59

Whether the provider needs an API key.


runsLocally ​

readonly runsLocally: boolean

Defined in: graphty-element/src/catalog/ai.ts:63

Whether the model runs in this browser rather than on the provider's servers.


testOnly ​

readonly testOnly: boolean

Defined in: graphty-element/src/catalog/ai.ts:65

Whether the provider is a scripted stand-in for tests rather than a real model.