[!警告] 如果你使用的聊天模型支持工具调用 API，那么你应该使用聊天模型的工具调用 API 而不是 Kor！

Kor 最适合用于那些没有聊天接口且不支持工具调用的老式 LLM（大语言模型）。

有关更多详细信息，请阅读 LangChain 中的 工具调用指南。

请参考 聊天模型集成表，了解支持原生工具调用的聊天模型列表。

Kor

这是一个半成品原型，它“帮助”你使用 LLM（大语言模型）从文本中提取结构化数据 🧩。

指定需要提取内容的模式，并提供一些示例。

Kor 将生成提示，将其发送到指定的 LLM 并解析输出结果。

你甚至可能会得到返回的结果。

所以是的——这只是另一个基于 LLM 的封装，带有其独特的抽象风格。 😸

查看 文档。

与 LangChain 框架 😽💗 🦜🔗 集成。

Kor 与 LangChain

使用 LLM 提取信息有三种不同的方法：

1. 基于提示/解析
2. 函数/工具调用
3. JSON 模式

请参阅 LangChain 的 提取用例文档 以获取概述。

Kor 在 解析 方法上有相当不错的实现。该方法适用于所有足够好的 LLM，无论它们是否支持函数/工具调用或 JSON 模式。

提取质量主要取决于提供良好的参考示例和良好的模式文档。

请参阅 此处 和 此处 的指南。

版本 1.0.0 发布

• kor 兼容 pydantic v2 和 v1。
• pydantic v2 相较于 v1 有重大破坏性更改，因此 kor 主版本号进行了提升以作为预防措施。

需要注意的主要事项：

1. 如果使用 pydantic v2 进行验证，请为任何可选字段设置一个 default 值。

class MusicRequest(BaseModel):
    song: Optional[List[str]] = Field(
        default=None,
        description="The song(s) that the user would like to be played."
    )

2. Kor 模式使用 pydantic 进行类型检查。Pydantic v2 更加严格，可能会发现隐藏在现有用户代码中的问题，这些代码之前使用了 kor 库。

3. 使用 pydantic v2 时尚未实现序列化功能。

Kor 风格模式

from langchain.chat_models import ChatOpenAI
from kor import create_extraction_chain, Object, Text

llm = ChatOpenAI(
    model_name="gpt-3.5-turbo",
    temperature=0,
    max_tokens=2000,
    model_kwargs = {
        'frequency_penalty':0,
        'presence_penalty':0,
        'top_p':1.0
    }
)

schema = Object(
    id="player",
    description=(
        "User is controlling a music player to select songs, pause or start them or play"
        " music by a particular artist."
    ),
    attributes=[
        Text(
            id="song",
            description="User wants to play this song",
            examples=[],
            many=True,
        ),
        Text(
            id="album",
            description="User wants to play this album",
            examples=[],
            many=True,
        ),
        Text(
            id="artist",
            description="Music by the given artist",
            examples=[("Songs by paul simon", "paul simon")],
            many=True,
        ),
        Text(
            id="action",
            description="Action to take one of: `play`, `stop`, `next`, `previous`.",
            examples=[
                ("Please stop the music", "stop"),
                ("play something", "play"),
                ("play a song", "play"),
                ("next song", "next"),
            ],
        ),
    ],
    many=False,
)

chain = create_extraction_chain(llm, schema, encoder_or_encoder_class='json')
chain.invoke("play songs by paul simon and led zeppelin and the doors")['data']

{'player': {'artist': ['paul simon', 'led zeppelin', 'the doors']}}

Pydantic 风格模式

• 查看文档 pydantic。

class Action(enum.Enum):
    play = "play"
    stop = "stop"
    previous = "previous"
    next_ = "next"


class MusicRequest(BaseModel):
    song: Optional[List[str]] = Field(
        default=None,
        description="The song(s) that the user would like to be played."
    )
    album: Optional[List[str]] = Field(
        default=None,
        description="The album(s) that the user would like to be played."
    )
    artist: Optional[List[str]] = Field(
        default=None,
        description="The artist(s) whose music the user would like to hear.",
        examples=[("Songs by paul simon", "paul simon")],
    )
    action: Optional[Action] = Field(
        default=None,
        description="The action that should be taken; one of `play`, `stop`, `next`, `previous`",
        examples=[
            ("Please stop the music", "stop"),
            ("play something", "play"),
            ("play a song", "play"),
            ("next song", "next"),
        ],
    )
    
schema, validator = from_pydantic(MusicRequest)   
chain = create_extraction_chain(
    llm, schema, encoder_or_encoder_class="json", validator=validator
)
chain.invoke("stop the music now")["validated_data"]

MusicRequest(song=None, album=None, artist=None, action=<Action.stop: 'stop'>)

兼容性

Kor 已在 Python 3.8、3.9、3.10、3.11 上测试通过。

安装

pip install kor

💡 创意

以下是使用 Kor 可以实现的一些创意。

• 从符合提取模式的文本中提取数据。
• 通过精确理解用户请求，为 AI 助手赋予技能。
• 为现有 API 提供自然语言访问能力。

🚧 原型

原型！因此 API 预计不会稳定！

✨ Kor 擅长什么？🌟

• 犯错！很多错误！
• 缓慢！它使用带有示例的大型提示（prompts），最适合与更大、更慢的 LLMs（大语言模型）一起工作。
• 在处理较长文本时容易崩溃！当处理大型表单或长文本输入时，上下文长度窗口可能会成为限制。

随着 LLMs 的改进，预计其中一些问题将得到缓解。

局限性

Kor 没有任何局限性。（开玩笑的。）

请查看上面的部分以及兼容性部分。

有想法？

打开一个问题，我们一起讨论！

🎶 为什么起这个名字？

快速输入且足够独特。

贡献

如果您有任何想法或功能请求，请打开一个问题并分享！

更多信息请参见 CONTRIBUTING.md。

其他包

从概率上讲，这个包不太可能适用于您的用例。

所以这里有一些很好的替代品：

• Promptify
• MiniChain

Kor 快速上手指南

Kor 是一个用于从文本中提取结构化数据的开源工具，基于大语言模型（LLM）实现。以下是快速上手指南。

---

环境准备

系统要求

• Python 版本：3.8, 3.9, 3.10, 3.11
• 支持的操作系统：Windows、macOS、Linux

前置依赖

• 需要安装 LangChain 框架。
• 推荐使用支持 JSON 模式的 LLM 模型（如 gpt-3.5-turbo）。

---

安装步骤

运行以下命令安装 Kor：

pip install kor

如果需要加速安装，可以使用国内镜像源，例如：

pip install kor -i https://pypi.tuna.tsinghua.edu.cn/simple

---

基本使用

以下是一个简单的使用示例，展示如何通过 Kor 提取结构化数据。

示例 1：Kor 风格 Schema

from langchain.chat_models import ChatOpenAI
from kor import create_extraction_chain, Object, Text

# 初始化 LLM
llm = ChatOpenAI(
    model_name="gpt-3.5-turbo",
    temperature=0,
    max_tokens=2000,
    model_kwargs = {
        'frequency_penalty':0,
        'presence_penalty':0,
        'top_p':1.0
    }
)

# 定义 Schema
schema = Object(
    id="player",
    description=(
        "用户正在控制音乐播放器以选择歌曲、暂停或开始播放，或者播放特定艺术家的音乐。"
    ),
    attributes=[
        Text(
            id="song",
            description="用户想播放的歌曲",
            examples=[],
            many=True,
        ),
        Text(
            id="album",
            description="用户想播放的专辑",
            examples=[],
            many=True,
        ),
        Text(
            id="artist",
            description="用户想听的艺术家",
            examples=[("播放保罗·西蒙的歌曲", "保罗·西蒙")],
            many=True,
        ),
        Text(
            id="action",
            description="操作类型：`play`、`stop`、`next`、`previous`。",
            examples=[
                ("请停止播放音乐", "stop"),
                ("播放点东西", "play"),
                ("播放一首歌", "play"),
                ("下一首", "next"),
            ],
        ),
    ],
    many=False,
)

# 创建提取链并调用
chain = create_extraction_chain(llm, schema, encoder_or_encoder_class='json')
result = chain.invoke("播放保罗·西蒙、齐柏林飞艇和大门乐队的歌曲")['data']
print(result)

输出结果：

{'player': {'artist': ['保罗·西蒙', '齐柏林飞艇', '大门乐队']}}

---

示例 2：Pydantic 风格 Schema

from enum import Enum
from typing import List, Optional
from pydantic import BaseModel, Field
from kor import create_extraction_chain, from_pydantic

class Action(Enum):
    play = "play"
    stop = "stop"
    previous = "previous"
    next_ = "next"

class MusicRequest(BaseModel):
    song: Optional[List[str]] = Field(
        default=None,
        description="用户想播放的歌曲。"
    )
    album: Optional[List[str]] = Field(
        default=None,
        description="用户想播放的专辑。"
    )
    artist: Optional[List[str]] = Field(
        default=None,
        description="用户想听的艺术家。",
        examples=[("播放保罗·西蒙的歌曲", "保罗·西蒙")],
    )
    action: Optional[Action] = Field(
        default=None,
        description="应执行的操作：`play`、`stop`、`next`、`previous`。",
        examples=[
            ("请停止播放音乐", "stop"),
            ("播放点东西", "play"),
            ("播放一首歌", "play"),
            ("下一首", "next"),
        ],
    )

# 转换为 Kor Schema
schema, validator = from_pydantic(MusicRequest)

# 创建提取链并调用
chain = create_extraction_chain(
    llm, schema, encoder_or_encoder_class="json", validator=validator
)
result = chain.invoke("现在停止播放音乐")["validated_data"]
print(result)

输出结果：

MusicRequest(song=None, album=None, artist=None, action=<Action.stop: 'stop'>)

---

以上是 Kor 的基本使用方法，更多高级功能请参考官方文档：Kor 文档。