This is an automated email from the ASF dual-hosted git repository.
sxnan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new b88389a [Improvement] Add inherited parameters to
ChatModelSetup/EmbeddingModelSetup docstrings (#195)
b88389a is described below
commit b88389a5f9bc6d4430876ffb87f7a459d26ab6f9
Author: Eugene <[email protected]>
AuthorDate: Thu Sep 25 21:05:03 2025 +0800
[Improvement] Add inherited parameters to
ChatModelSetup/EmbeddingModelSetup docstrings (#195)
---
.../integrations/chat_models/anthropic/anthropic_chat_model.py | 6 ++++++
python/flink_agents/integrations/chat_models/ollama_chat_model.py | 6 ++++++
.../integrations/chat_models/openai/openai_chat_model.py | 6 ++++++
python/flink_agents/integrations/chat_models/tongyi_chat_model.py | 6 ++++++
.../integrations/embedding_models/local/ollama_embedding_model.py | 4 ++++
.../integrations/embedding_models/openai_embedding_model.py | 4 ++++
6 files changed, 32 insertions(+)
diff --git
a/python/flink_agents/integrations/chat_models/anthropic/anthropic_chat_model.py
b/python/flink_agents/integrations/chat_models/anthropic/anthropic_chat_model.py
index 5304df5..99786ad 100644
---
a/python/flink_agents/integrations/chat_models/anthropic/anthropic_chat_model.py
+++
b/python/flink_agents/integrations/chat_models/anthropic/anthropic_chat_model.py
@@ -210,6 +210,12 @@ class AnthropicChatModelSetup(BaseChatModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from BaseChatModelSetup)
+ prompt : Optional[Union[Prompt, str]
+ Prompt template or string for the model. (Inherited from
BaseChatModelSetup)
+ tools : Optional[List[str]]
+ List of available tools to use in the chat. (Inherited from
BaseChatModelSetup)
model : str
Specifies the Anthropic model to use. Defaults to
claude-sonnet-4-20250514.
max_tokens: int
diff --git a/python/flink_agents/integrations/chat_models/ollama_chat_model.py
b/python/flink_agents/integrations/chat_models/ollama_chat_model.py
index 5df4524..38d3cd7 100644
--- a/python/flink_agents/integrations/chat_models/ollama_chat_model.py
+++ b/python/flink_agents/integrations/chat_models/ollama_chat_model.py
@@ -167,6 +167,12 @@ class OllamaChatModelSetup(BaseChatModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from BaseChatModelSetup)
+ prompt : Optional[Union[Prompt, str]
+ Prompt template or string for the model. (Inherited from
BaseChatModelSetup)
+ tools : Optional[List[str]]
+ List of available tools to use in the chat. (Inherited from
BaseChatModelSetup)
temperature : float
The temperature to use for sampling.
num_ctx : int
diff --git
a/python/flink_agents/integrations/chat_models/openai/openai_chat_model.py
b/python/flink_agents/integrations/chat_models/openai/openai_chat_model.py
index 0bf831a..9a2aa04 100644
--- a/python/flink_agents/integrations/chat_models/openai/openai_chat_model.py
+++ b/python/flink_agents/integrations/chat_models/openai/openai_chat_model.py
@@ -184,6 +184,12 @@ class OpenAIChatModelSetup(BaseChatModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from BaseChatModelSetup)
+ prompt : Optional[Union[Prompt, str]
+ Prompt template or string for the model. (Inherited from
BaseChatModelSetup)
+ tools : Optional[List[str]]
+ List of available tools to use in the chat. (Inherited from
BaseChatModelSetup)
model : str
The OpenAI model to use.
temperature : float
diff --git a/python/flink_agents/integrations/chat_models/tongyi_chat_model.py
b/python/flink_agents/integrations/chat_models/tongyi_chat_model.py
index 32d84d8..491de3c 100644
--- a/python/flink_agents/integrations/chat_models/tongyi_chat_model.py
+++ b/python/flink_agents/integrations/chat_models/tongyi_chat_model.py
@@ -211,6 +211,12 @@ class TongyiChatModelSetup(BaseChatModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from BaseChatModelSetup)
+ prompt : Optional[Union[Prompt, str]
+ Prompt template or string for the model. (Inherited from
BaseChatModelSetup)
+ tools : Optional[List[str]]
+ List of available tools to use in the chat. (Inherited from
BaseChatModelSetup)
temperature : float
The temperature to use for sampling.
additional_kwargs : Dict[str, Any]
diff --git
a/python/flink_agents/integrations/embedding_models/local/ollama_embedding_model.py
b/python/flink_agents/integrations/embedding_models/local/ollama_embedding_model.py
index c8c95a5..1829703 100644
---
a/python/flink_agents/integrations/embedding_models/local/ollama_embedding_model.py
+++
b/python/flink_agents/integrations/embedding_models/local/ollama_embedding_model.py
@@ -101,6 +101,10 @@ class OllamaEmbeddingModelSetup(BaseEmbeddingModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from
BaseEmbeddingModelSetup)
+ model : str
+ Name of the embedding model to use. (Inherited from
BaseEmbeddingModelSetup)
truncate : bool
Controls what happens if input text exceeds model's maximum length
(default: True).
diff --git
a/python/flink_agents/integrations/embedding_models/openai_embedding_model.py
b/python/flink_agents/integrations/embedding_models/openai_embedding_model.py
index 29834c6..30b8ee1 100644
---
a/python/flink_agents/integrations/embedding_models/openai_embedding_model.py
+++
b/python/flink_agents/integrations/embedding_models/openai_embedding_model.py
@@ -135,6 +135,10 @@ class OpenAIEmbeddingModelSetup(BaseEmbeddingModelSetup):
Attributes:
----------
+ connection : str
+ Name of the referenced connection. (Inherited from
BaseEmbeddingModelSetup)
+ model : str
+ Name of the embedding model to use. (Inherited from
BaseEmbeddingModelSetup)
encoding_format : str
The format to return the embeddings in (default: "float").
Can be either "float" or "base64".
