AI

(plugins.ai)

Overview

AIProvider class that provides access to create AI chat and embedding clients/builders.

Returned Types

ChatClient,GeminiChatBuilder,OpenAiChatBuilder,GeminiEmbeddingModelBuilder,OpenAiEmbeddingModelBuilder,ServoyEmbeddingStoreBuilder,EmbeddingStore,EmbeddingModel,ChatResponse,SearchResult,ToolBuilder,

Methods Summarized

Type
Name
Summary

Creates a builder for Gemini chat models.

Creates a Gemini chat client using the provided API key and model name.

Creates an OpenAI chat client using the provided API key and model name.

Creates a builder for OpenAI chat models.

Methods Detailed

createGeminiChatBuilder()

Creates a builder for Gemini chat models.

Returns: GeminiChatBuilder GeminiChatBuilder instance.

createGeminiClient(apiKey, modelName)

Creates a Gemini chat client using the provided API key and model name. This is a quick way to create a client without using the builder.

Parameters

  • String apiKey The Gemini API key.

  • String modelName The Gemini model name.

Returns: ChatClient ChatClient instance for Gemini.

createGeminiEmbeddingModelBuilder()

Creates a builder for Gemini embeddings.

Returns: GeminiEmbeddingModelBuilder GeminiEmbeddingModelBuilder instance.

createOpenAIClient(apiKey, modelName)

Creates an OpenAI chat client using the provided API key and model name. This is a quick way to create a client without using the builder.

Parameters

  • String apiKey The OpenAI API key.

  • String modelName The OpenAI model name.

Returns: ChatClient ChatClient instance for OpenAI.

createOpenAiChatBuilder()

Creates a builder for OpenAI chat models.

Returns: OpenAiChatBuilder OpenAiChatBuilder instance.

createOpenAiEmbeddingModelBuilder()

Creates a builder for OpenAI store.

Returns: OpenAiEmbeddingModelBuilder OpenAiEmbeddingModelBuilder instance.


Last updated

Was this helpful?