247 lines (209 loc) · 8.7 KB

TbChatRequest

org.thingsboard.client.model.TbChatRequest

Properties

Name	Type	Description	Notes
systemMessage	String	A system-level instruction that frames the user's input, setting the persona, tone, and constraints for the generated response	[optional]
userMessage	TbUserMessage	The actual user prompt that will be answered by the AI model
chatModelConfig	AiModelConfig	Configuration of the AI chat model that should execute the request

Referenced Types

TbUserMessage

Name	Type	Description	Notes
contents	List	A list of content parts that make up the complete user prompt

AiModelConfig

Name	Type	Description	Notes
provider	String

AmazonBedrockChatModelConfig (extends AiModelConfig, provider=`AMAZON_BEDROCK`)

Name	Type	Description	Notes
providerConfig	AmazonBedrockProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

AnthropicChatModelConfig (extends AiModelConfig, provider=`ANTHROPIC`)

Name	Type	Description	Notes
providerConfig	AnthropicProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
topK	Integer		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

AzureOpenAiChatModelConfig (extends AiModelConfig, provider=`AZURE_OPENAI`)

Name	Type	Description	Notes
providerConfig	AzureOpenAiProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

GitHubModelsChatModelConfig (extends AiModelConfig, provider=`GITHUB_MODELS`)

Name	Type	Description	Notes
providerConfig	GitHubModelsProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

GoogleAiGeminiChatModelConfig (extends AiModelConfig, provider=`GOOGLE_AI_GEMINI`)

Name	Type	Description	Notes
providerConfig	GoogleAiGeminiProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
topK	Integer		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

GoogleVertexAiGeminiChatModelConfig (extends AiModelConfig, provider=`GOOGLE_VERTEX_AI_GEMINI`)

Name	Type	Description	Notes
providerConfig	GoogleVertexAiGeminiProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
topK	Integer		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

MistralAiChatModelConfig (extends AiModelConfig, provider=`MISTRAL_AI`)

Name	Type	Description	Notes
providerConfig	MistralAiProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

OllamaChatModelConfig (extends AiModelConfig, provider=`OLLAMA`)

Name	Type	Description	Notes
providerConfig	OllamaProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
topK	Integer		[optional]
contextLength	Integer		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

OpenAiChatModelConfig (extends AiModelConfig, provider=`OPENAI`)

Name	Type	Description	Notes
providerConfig	OpenAiProviderConfig
modelId	String
temperature	Double		[optional]
topP	Double		[optional]
frequencyPenalty	Double		[optional]
presencePenalty	Double		[optional]
maxOutputTokens	Integer		[optional]
timeoutSeconds	Integer		[optional]
maxRetries	Integer		[optional]
modelType	AiModelType		[optional] [readonly]

TbContent

Name	Type	Description	Notes
contentType	String

TbTextContent (extends TbContent, contentType=`TEXT`)

Name	Type	Description	Notes
text	String	The text content

OpenAiProviderConfig

Name	Type	Description	Notes
baseUrl	String		[optional]
apiKey	String		[optional]

AiModelType (enum)

CHAT

AzureOpenAiProviderConfig

Name	Type	Description	Notes
endpoint	String
serviceVersion	String		[optional]
apiKey	String

GoogleAiGeminiProviderConfig

Name	Type	Description	Notes
apiKey	String

GoogleVertexAiGeminiProviderConfig

Name	Type	Description	Notes
fileName	String
projectId	String
location	String
serviceAccountKey	String

MistralAiProviderConfig

Name	Type	Description	Notes
apiKey	String

AnthropicProviderConfig

Name	Type	Description	Notes
apiKey	String

AmazonBedrockProviderConfig

Name	Type	Description	Notes
region	String
accessKeyId	String
secretAccessKey	String

GitHubModelsProviderConfig

Name	Type	Description	Notes
personalAccessToken	String

OllamaProviderConfig

Name	Type	Description	Notes
baseUrl	String
auth	OllamaAuth

OllamaAuth

Name	Type	Description	Notes
type	String

Basic (extends OllamaAuth, type=`BASIC`)

Name	Type	Description	Notes
username	String
password	String

None (extends OllamaAuth, type=`NONE`)

See OllamaAuth for properties.

Token (extends OllamaAuth, type=`TOKEN`)

Name	Type	Description	Notes
token	String

Conventions

Package: org.thingsboard.client.model
Getter pattern: get<PropertyName>() — e.g., getId(), getName()
Setter pattern: set<PropertyName>(value) — e.g., setId(value), setName(value)
Null fields: Getters return null for unset optional fields; they do not throw exceptions