Skip to main content

saiKitz: Sidney Zhang's Toolkit for AI Conversations & Info Queries

Project description

saiKitz

saiKitz: Sidney Zhang's Toolkit for AI Conversations & Info Queries.


一个简单的AI聊天机器人。主要是为了在Jupyter Notebook里面能快速使用, 也是为了写分析报告可以获得更多文字上的帮助,有的时候更多是查询信息上的帮助。

核心使用的时kimi的API, 以及qwenollama,对于其他AI的API当然也是支持的, 前提是这些API有兼容OpenAI的API链接,当然绝对也是支持OpenAI的ChatGPT, 不过这个在国内无法直连使用,所以只作为自定义方式来支持了。

1.安装

$ pip install saikitz

2.快速开始

可以把你的API KEY设置到环境变量($AISEARCKER_API_KEY)中,或者直接在代码中设置。

这是在环境变量中使用的方式,默认使用Kimi:

from saikitz.aikit import aiSearcher

chatbot = aiSearcher()

chatttbot.chat('你好')

注册Kimi的Platform,就可以获得一个API KEY, 首次注册可以获得免费额度。简单实用已经完全足够了。 如果你需要大量使用Kimi的搜索插件,那还是需要充值一定金额的。

下面是aiSearcher的参数说明:

api_key : str|Path|None ,支持三种方式:1.环境变量(AISEARCKER_API_KEY)
                                       2.文件读取
                                       3.直接输入
base_url : str|None ,支持两种方式:1.指定渠道名:kimi(默认值)、qwen、ollama
                                   2.自定义url
no_tools : bool ,是否使用附加工具,目前只有网络搜索工具。默认为真,即不使用工具。
system_prompt : str ,默认为None,不设置则使用默认prompt
max_dialogue_turns : int ,默认为20,最大历史对话轮次,超过则删除最旧的记录,
                           设定0或负值,则不删除历史记录

你可以根据自己的需要对这些默认参数进行调整。

如果你不想使用默认模型,请使用 chatbot.set_model(model_name) 方法修改。 同样,对于默认的系统提示,也可以通过 chatbot.set_system_prompt(prompt) 来修改。

目前自带的系统提示有五种:

  • default : 默认的提示,很简单,适应绝大多数使用情况。
  • langPrompt : 更复杂的智能助理提示。可以帮助用户完成更复杂的任务。
  • chi : 纯中文助理,对于非国产LLM比较有用。
  • runse : 文本润色。
  • trans : 语言翻译。

3.其他说明

  1. 使用Kimi的搜索工具会带来较大的TPM,如果账号还未充值,可能会出现超TPM的错误返回信息。
  2. 使用ollama时,默认使用了llama3.2:latest,请注意提前ollama pull llama3.2:latest,完成模型下载。
  3. set_system_prompt()可以传入一个文本文件地址,这是为了系统提示太长时所准备的方法。
  4. 如果发现什么使用上的问题欢迎随时与我联系

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

saikitz-0.2.1.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

saikitz-0.2.1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file saikitz-0.2.1.tar.gz.

File metadata

  • Download URL: saikitz-0.2.1.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for saikitz-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cdbab7797762b930ba32d1c86c1ffbd8cc43a66e29ce4f7c428c4053d7b52b5c
MD5 a8c1feba7e9e0bf9e8f3f3c15ef1afd6
BLAKE2b-256 656461b52d9a580a7bf4c85243f0a8a69e7c97b5f9d738cb4b1b6030a512449a

See more details on using hashes here.

File details

Details for the file saikitz-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: saikitz-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for saikitz-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28cca9260961bce1601004dbbc7b6f0df4fe8100a6ae5aafeece89d8b315cd10
MD5 c29fe91b530c6c9d9377a7813b14e943
BLAKE2b-256 2a0e20a7c8494427a0a29beac973ad2b181e55aa023475bdda0590ac499d60c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page