以编程方式使用文档

> Seekr 提供由 AI 驱动的解决方案,实现结构化、可解释和透明的 AI 交互。

本指南提供快速入门概览 ChatSeekrFlow 聊天模型.

概述

ChatSeekrFlow 类封装了托管在 SeekrFlow 上的聊天模型端点,支持与 LangChain 应用程序的无缝集成。

集成详情

可序列化下载量版本
ChatSeekrFlowseekraibeta!PyPI - 下载量!PyPI - 版本

模型特性

工具调用结构化输出图像输入音频输入视频输入Token 级流式输出原生异步Token 使用量对数概率

支持的方法

ChatSeekrFlow 支持所有方法 ChatModel, **除了异步 API**.

端点要求

服务端点 ChatSeekrFlow 封装 **必须** have OpenAI-compatible chat input/output format. It can be used for:

  1. **微调 Seekr 模型**
  2. **自定义 SeekrFlow 模型**
  3. **使用 Seekr 检索系统启用 RAG 的模型**

有关异步用法,请参阅 AsyncChatSeekrFlow (即将推出)。

在 LangChain 中开始使用 ChatSeekrFlow

本指南介绍如何在 LangChain 中将 SeekrFlow 作为聊天模型使用。

设置

确保已安装必要的依赖项:

pip install seekrai langchain langchain-community

您还需要从 Seekr 获取 API 密钥以验证请求。

# Standard library



# Third-party
from langchain.prompts import ChatPromptTemplate
from langchain.schema import HumanMessage
from langchain_core.runnables import RunnableSequence

# OSS SeekrFlow integration
from langchain_seekrflow import ChatSeekrFlow
from seekrai import SeekrFlow

API 密钥设置

您需要将 API 密钥设置为环境变量以验证请求。

运行下方代码单元。

或在运行查询前手动分配:

SEEKR_API_KEY = "your-api-key-here"
os.environ["SEEKR_API_KEY"] = getpass.getpass("Enter your Seekr API key:")

实例化

os.environ["SEEKR_API_KEY"]
seekr_client = SeekrFlow(api_key=SEEKR_API_KEY)

llm = ChatSeekrFlow(
    client=seekr_client, model_name="meta-llama/Meta-Llama-3-8B-Instruct"
)

调用

response = llm.invoke([HumanMessage(content="Hello, Seekr!")])
print(response.content)
Hello there! I'm Seekr, nice to meet you! What brings you here today? Do you have a question, or are you looking for some help with something? I'm all ears (or rather, all text)!

链接

prompt = ChatPromptTemplate.from_template("Translate to French: {text}")

chain: RunnableSequence = prompt | llm
result = chain.invoke({"text": "Good morning"})
print(result)
content='The translation of "Good morning" in French is:\n\n"Bonne journée"' additional_kwargs={} response_metadata={}
def test_stream():
    """Test synchronous invocation in streaming mode."""
    print("\n🔹 Testing Sync `stream()` (Streaming)...")

    stream = llm.stream_events([HumanMessage(content="Write me a haiku.")], version="v3")
    for token in stream.text:
        print(token, end="", flush=True)


# ✅ Ensure streaming is enabled
llm = ChatSeekrFlow(
    client=seekr_client,
    model_name="meta-llama/Meta-Llama-3-8B-Instruct",
    streaming=True,  # ✅ Enable streaming
)

# ✅ Run sync streaming test
test_stream()
🔹 Testing Sync `stream()` (Streaming)...
Here is a haiku:

Golden sunset fades
Ripples on the quiet lake
Peaceful evening sky

错误处理与调试

# Define a minimal mock SeekrFlow client
class MockSeekrClient:
    """Mock SeekrFlow API client that mimics the real API structure."""

    class MockChat:
        """Mock Chat object with a completions method."""

        class MockCompletions:
            """Mock Completions object with a create method."""

            def create(self, *args, **kwargs):
                return {
                    "choices": [{"message": {"content": "Mock response"}}]
                }  # Mimic API response

        completions = MockCompletions()

    chat = MockChat()


def test_initialization_errors():
    """Test that invalid ChatSeekrFlow initializations raise expected errors."""

    test_cases = [
        {
            "name": "Missing Client",
            "args": {"client": None, "model_name": "seekrflow-model"},
            "expected_error": "SeekrFlow client cannot be None.",
        },
        {
            "name": "Missing Model Name",
            "args": {"client": MockSeekrClient(), "model_name": ""},
            "expected_error": "A valid model name must be provided.",
        },
    ]

    for test in test_cases:
        try:
            print(f"Running test: {test['name']}")
            faulty_llm = ChatSeekrFlow(**test["args"])

            # If no error is raised, fail the test
            print(f"❌ Test '{test['name']}' failed: No error was raised!")
        except Exception as e:
            error_msg = str(e)
            assert test["expected_error"] in error_msg, f"Unexpected error: {error_msg}"
            print(f"✅ Expected Error: {error_msg}")


# Run test
test_initialization_errors()
Running test: Missing Client
✅ Expected Error: SeekrFlow client cannot be None.
Running test: Missing Model Name
✅ Expected Error: A valid model name must be provided.

API 参考