@graphty/graphty-element / ai / LlmProvider
Interface: LlmProvider ​
Defined in: graphty-element/src/ai/providers/types.ts:91
Interface for LLM providers.
Properties ​
name ​
readonlyname:string
Defined in: graphty-element/src/ai/providers/types.ts:93
Name of the provider
supportsStreaming ​
readonlysupportsStreaming:boolean
Defined in: graphty-element/src/ai/providers/types.ts:95
Whether this provider supports streaming responses
supportsSystemPromptWithTools? ​
readonlyoptionalsupportsSystemPromptWithTools?:boolean
Defined in: graphty-element/src/ai/providers/types.ts:99
Whether this provider supports custom system prompts with tools (default: true)
supportsTools ​
readonlysupportsTools:boolean
Defined in: graphty-element/src/ai/providers/types.ts:97
Whether this provider supports tool/function calling
Methods ​
configure() ​
configure(
options):void
Defined in: graphty-element/src/ai/providers/types.ts:104
Configure the provider with options.
Parameters ​
options ​
Returns ​
void
generate() ​
generate(
messages,tools,options?):Promise<LlmResponse>
Defined in: graphty-element/src/ai/providers/types.ts:114
Generate a response from the LLM.
Parameters ​
messages ​
Message[]
Conversation history
tools ​
Available tools for the LLM to use
options? ​
Optional settings
signal? ​
AbortSignal
Optional abort signal for cancellation
Returns ​
Promise<LlmResponse>
Promise resolving to the LLM response
generateStream() ​
generateStream(
messages,tools,callbacks,signal?):Promise<void>
Defined in: graphty-element/src/ai/providers/types.ts:123
Generate a streaming response from the LLM.
Parameters ​
messages ​
Message[]
Conversation history
tools ​
Available tools for the LLM to use
callbacks ​
Callbacks for streaming events
signal? ​
AbortSignal
Optional abort signal
Returns ​
Promise<void>
validateApiKey() ​
validateApiKey():
Promise<boolean>
Defined in: graphty-element/src/ai/providers/types.ts:136
Validate the configured API key by making a minimal API call. This consumes a small number of tokens but confirms the key is valid.
Returns ​
Promise<boolean>
Promise resolving to true if valid, false if invalid
Throws ​
Error if not configured or network error occurs