ErisPulse-OpenAI 模块文档
简介
ErisPulse-OpenAI 是一个 OpenAI 通用接口的封装模块，提供了便捷的异步接口来与 OpenAI API 交互。
使用示例
基本使用
from ErisPulse import sdk
# 初始化模块
openai = sdk.OpenAI
# 同步聊天
messages = [{"role": "user", "content": "你好"}]
response = await openai.chat(messages)
print(response)
# 流式聊天
async for chunk in openai.chat_stream(messages):
print(chunk, end="", flush=True)
自定义配置
# 自定义模型和参数
response = await openai.chat(
messages,
model="gpt-4",
temperature=0.5,
max_tokens=500
)
流式处理回调
async def handle_stream(content):
print(content, end="", flush=True)
response = await openai.chat(
messages,
stream=True,
stream_handler=handle_stream
)
API 参考
chat(messages, model=None, stream=False, stream_handler=None, **kwargs)
messages: List[Dict[str, str]] - 对话消息列表model: Optional[str] - 指定模型，默认为配置中的模型stream: bool - 是否使用流式响应stream_handler: Optional[Callable] - 流式响应的回调函数**kwargs: 其他 OpenAI API 参数- 返回: str - AI 响应内容
chat_stream(messages, model=None, **kwargs)
messages: List[Dict[str, str]] - 对话消息列表model: Optional[str] - 指定模型，默认为配置中的模型**kwargs: 其他 OpenAI API 参数- 返回: AsyncGenerator[str, None] - 流式响应生成器
配置说明
需要在项目的 config.toml 中配置OpenAI相关参数
参考链接
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file erispulse_openai-2.1.3.tar.gz.
File metadata
- Download URL: erispulse_openai-2.1.3.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecbefe0caba80b661770523a237beac21815a0cd6b3ffc62030ef882d56274ca
|
|
| MD5 |
94547321bedc69edfcf5d4296f18f220
|
|
| BLAKE2b-256 |
242a88e2c6719a7e4a9c4e571aa693aa74c3ea32d0f697011ea4fccb78969b11
|
Provenance
The following attestation bundles were made for erispulse_openai-2.1.3.tar.gz:
Publisher:
python-publish.yml on ErisPulse/ErisPulse-OpenAI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
erispulse_openai-2.1.3.tar.gz -
Subject digest:
ecbefe0caba80b661770523a237beac21815a0cd6b3ffc62030ef882d56274ca - Sigstore transparency entry: 280020634
- Sigstore integration time:
-
Permalink:
ErisPulse/ErisPulse-OpenAI@2ff7d8801d5f50c620d4984f913c848c0b36b39d -
Branch / Tag:
refs/heads/master - Owner: https://github.com/ErisPulse
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@2ff7d8801d5f50c620d4984f913c848c0b36b39d -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file erispulse_openai-2.1.3-py3-none-any.whl.
File metadata
- Download URL: erispulse_openai-2.1.3-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86254edf876cbdf2061bd477a3b5270f271dee17d6be1872621225accc5e9a0d
|
|
| MD5 |
eb8b22783da8d5e9d08c52515ee1f57a
|
|
| BLAKE2b-256 |
dc957ee72f629065cd99c687d3465db6c9e65d57c0fa6de33772664d19634a9a
|
Provenance
The following attestation bundles were made for erispulse_openai-2.1.3-py3-none-any.whl:
Publisher:
python-publish.yml on ErisPulse/ErisPulse-OpenAI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
erispulse_openai-2.1.3-py3-none-any.whl -
Subject digest:
86254edf876cbdf2061bd477a3b5270f271dee17d6be1872621225accc5e9a0d - Sigstore transparency entry: 280020652
- Sigstore integration time:
-
Permalink:
ErisPulse/ErisPulse-OpenAI@2ff7d8801d5f50c620d4984f913c848c0b36b39d -
Branch / Tag:
refs/heads/master - Owner: https://github.com/ErisPulse
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@2ff7d8801d5f50c620d4984f913c848c0b36b39d -
Trigger Event:
workflow_dispatch
-
Statement type:
