141 lines
11 KiB
Markdown
141 lines
11 KiB
Markdown
## FunctionDef calculate_md5(input_string)
|
||
**calculate_md5**: 该函数的功能是计算输入字符串的MD5加密值。
|
||
|
||
**参数**:
|
||
- **input_string**: 需要进行MD5加密的输入字符串。
|
||
|
||
**代码描述**:
|
||
`calculate_md5` 函数首先创建一个 `hashlib.md5()` 的实例。然后，它使用输入字符串（在进行编码转换为'utf-8'格式后）更新MD5对象。接着，通过调用 `hexdigest()` 方法，将加密后的数据转换为16进制的字符串形式。最后，函数返回这个加密后的字符串。
|
||
|
||
在项目中，`calculate_md5` 函数被 `BaiChuanWorker` 类的 `do_chat` 方法调用。在 `do_chat` 方法中，`calculate_md5` 用于生成对百川AI聊天API请求的签名。这个签名是通过将API的密钥、请求的JSON数据以及时间戳拼接后，使用 `calculate_md5` 函数加密生成的。生成的MD5签名随后被添加到请求的HTTP头中，作为请求认证的一部分。这显示了 `calculate_md5` 函数在确保API请求安全性方面的重要作用。
|
||
|
||
**注意**:
|
||
- 输入字符串必须是可编码为'utf-8'的字符串，否则在执行 `.encode('utf-8')` 时可能会抛出异常。
|
||
- MD5加密是不可逆的，意味着无法从加密后的字符串恢复原始数据。
|
||
- 虽然MD5在很多场合下仍然被广泛使用，但需要注意的是，由于其安全性在某些情况下可能不足，因此在处理高安全性要求的数据时应考虑使用更安全的加密算法。
|
||
|
||
**输出示例**:
|
||
调用 `calculate_md5("hello world")` 可能会返回如下字符串：
|
||
```
|
||
5eb63bbbe01eeed093cb22bb8f5acdc3
|
||
```
|
||
这是 "hello world" 这个字符串经过MD5加密后的结果。
|
||
## ClassDef BaiChuanWorker
|
||
**BaiChuanWorker**: BaiChuanWorker类是用于与百川AI接口进行交互的工作器。
|
||
|
||
**属性**:
|
||
- `controller_addr`: 控制器地址，用于与模型控制器进行通信。
|
||
- `worker_addr`: 工作器地址，标识当前工作器的网络位置。
|
||
- `model_names`: 模型名称列表，默认为["baichuan-api"]。
|
||
- `version`: 模型版本，默认为"Baichuan2-53B"。
|
||
- `context_len`: 上下文长度，默认为32768。
|
||
|
||
**代码描述**:
|
||
BaiChuanWorker类继承自ApiModelWorker，专门用于处理与百川AI接口的交互。在初始化过程中，该类接受控制器地址、工作器地址、模型名称列表、模型版本等参数，并通过`kwargs`传递给父类ApiModelWorker进行进一步的初始化。此外，BaiChuanWorker还设置了默认的上下文长度为32768。
|
||
|
||
该类重写了`do_chat`方法，用于实现与百川AI的聊天功能。在`do_chat`方法中，首先根据提供的参数构造请求数据，然后通过HTTP POST请求发送到百川AI的聊天接口，并处理响应数据。如果响应码为0，表示请求成功，将返回包含聊天内容的字典；如果响应码非0，表示请求失败，将返回包含错误信息的字典。
|
||
|
||
此外，BaiChuanWorker还提供了`get_embeddings`和`make_conv_template`方法，但这些方法在当前版本中未实现具体功能。
|
||
|
||
**注意**:
|
||
- 使用BaiChuanWorker进行聊天时，需要确保提供有效的API密钥和正确的请求参数。
|
||
- BaiChuanWorker的实现依赖于外部函数`calculate_md5`和`get_httpx_client`，这些函数需要在使用前正确定义。
|
||
- 在处理HTTP响应时，BaiChuanWorker采用了流式读取的方式，以适应可能的大量数据传输。
|
||
|
||
**输出示例**:
|
||
```json
|
||
{
|
||
"error_code": 0,
|
||
"text": "这是由百川AI生成的回复文本。"
|
||
}
|
||
```
|
||
此示例展示了一个成功的聊天请求返回值，其中`error_code`为0表示请求成功，`text`字段包含了百川AI生成的回复文本。
|
||
### FunctionDef __init__(self)
|
||
**__init__**: 该函数用于初始化BaiChuanWorker对象。
|
||
|
||
**参数**:
|
||
- `controller_addr`: 字符串类型，控制器地址，默认为None。
|
||
- `worker_addr`: 字符串类型，工作节点地址，默认为None。
|
||
- `model_names`: 字符串列表类型，模型名称，默认为["baichuan-api"]。
|
||
- `version`: 字面量类型，指定版本，默认为"Baichuan2-53B"。
|
||
- `**kwargs`: 接收可变数量的关键字参数。
|
||
|
||
**代码描述**:
|
||
此函数是`BaiChuanWorker`类的构造函数，用于初始化该类的实例。在初始化过程中，首先将`model_names`、`controller_addr`和`worker_addr`参数通过`kwargs`字典传递给父类的构造函数。此外，`kwargs`字典中的"context_len"键值对被设置为默认值32768，如果在`kwargs`中未指定"context_len"。然后，调用父类的`__init__`方法，将更新后的`kwargs`字典传递给它。最后，将`version`参数的值赋给实例变量`version`，以记录模型的版本信息。
|
||
|
||
**注意**:
|
||
- 在使用`BaiChuanWorker`类初始化对象时，需要注意`controller_addr`和`worker_addr`参数是可选的，如果在特定环境下这两个参数是必需的，则应在实例化时提供它们。
|
||
- `model_names`参数允许用户指定一个或多个模型名称，这对于在不同的工作场景中需要加载不同模型的情况非常有用。
|
||
- `version`参数默认值为"Baichuan2-53B"，这意味着如果没有特别指定，将使用这个版本的模型。如果需要使用不同版本的模型，应在实例化时明确指定。
|
||
- 通过`**kwargs`参数，此函数提供了高度的灵活性，允许用户根据需要传递额外的配置选项。但是，使用时应确保传递的关键字参数与父类构造函数或`BaiChuanWorker`类的其他方法兼容。
|
||
***
|
||
### FunctionDef do_chat(self, params)
|
||
**do_chat**: 该函数用于执行聊天操作，通过向百川AI的聊天API发送请求，并处理响应数据。
|
||
|
||
**参数**:
|
||
- `params`: `ApiChatParams`类型，包含了执行聊天所需的各种参数，如消息列表、模型版本和温度参数等。
|
||
|
||
**代码描述**:
|
||
`do_chat`函数首先通过`params.load_config`方法加载模型配置，这一步骤确保了聊天请求能够使用正确的模型参数。接着，函数构造了向百川AI聊天API发送请求所需的URL和数据体。数据体中包含了模型版本、消息列表以及其他参数（如温度参数）。
|
||
|
||
为了保证请求的安全性，函数计算了请求的MD5签名。这一过程涉及到`calculate_md5`函数，它将API的密钥、请求的JSON数据以及时间戳进行加密，生成签名。随后，这个签名被添加到请求的HTTP头中，作为请求认证的一部分。
|
||
|
||
函数使用`get_httpx_client`函数获取一个httpx客户端实例，用于发送HTTP请求。这一步骤中，`get_httpx_client`函数提供了对HTTP请求的详细配置，包括代理设置、超时时间等。
|
||
|
||
在发送请求并接收响应之后，函数通过迭代响应的每一行来处理返回的数据。对于每一行数据，函数首先检查其是否为空，然后解析JSON格式的响应内容。如果响应代码为0（表示成功），函数将累加消息内容并生成一个包含错误代码和文本消息的字典，然后通过`yield`返回这个字典。如果响应代码不为0（表示出错），函数同样生成一个包含错误信息的字典，并通过`yield`返回。
|
||
|
||
**注意**:
|
||
- 在使用`do_chat`函数时，需要确保传入的`params`参数已经包含了所有必要的聊天请求信息，包括但不限于消息列表、模型版本和温度参数。
|
||
- 该函数使用了`yield`关键字来逐行返回处理结果，这意味着它可以作为一个生成器使用。调用方需要通过迭代的方式来获取所有的响应数据。
|
||
- 函数中的错误处理机制确保了即使在请求失败的情况下，也能够以一种结构化的方式返回错误信息，便于调用方处理。
|
||
- 在构造HTTP请求头时，包含了多个自定义的字段，如`X-BC-Request-Id`和`X-BC-Signature`等，这些字段对于请求的成功执行至关重要。调用方需要确保这些字段被正确设置。
|
||
- 函数内部记录了详细的日志信息，这对于调试和监控请求的执行流程非常有帮助。开发者应当关注这些日志信息，以便于及时发现和解决问题。
|
||
***
|
||
### FunctionDef get_embeddings(self, params)
|
||
**get_embeddings**: 此函数的功能是打印嵌入信息和参数。
|
||
|
||
**参数**:
|
||
- `params`: 此参数用于接收传入的参数信息，其具体内容和格式依调用时的实际情况而定。
|
||
|
||
**代码描述**:
|
||
`get_embeddings` 函数是 `BaiChuanWorker` 类的一个方法，主要用于展示如何处理和打印传入的参数信息。当调用此函数时，它首先打印出字符串 "embedding"，随后打印出传入的 `params` 参数。这表明该函数可能是一个用于测试或演示如何接收和处理参数的示例函数。在实际的生产环境中，此函数可能会被进一步扩展，以实现更复杂的数据处理和嵌入向量的生成逻辑。
|
||
|
||
**注意**:
|
||
- 在使用此函数时，需要注意传入的 `params` 参数应该是符合预期格式和数据类型的，以确保函数能够正确地处理和打印参数信息。
|
||
- 目前，此函数的实现较为简单，主要用于演示目的。在实际应用中，可能需要根据具体需求对其进行相应的扩展和优化。
|
||
***
|
||
### FunctionDef make_conv_template(self, conv_template, model_path)
|
||
**make_conv_template**: 此函数的功能是创建一个会话模板。
|
||
|
||
**参数**:
|
||
- **conv_template**: 字符串类型，指定会话模板，此参数在当前实现中未使用。
|
||
- **model_path**: 字符串类型，指定模型路径，此参数在当前实现中未使用。
|
||
|
||
**代码描述**:
|
||
`make_conv_template` 函数是 `BaiChuanWorker` 类的一个方法，用于创建一个会话模板。该方法接受两个参数：`conv_template` 和 `model_path`，但在当前的实现中，这两个参数并未被使用。函数主要通过调用 `conv.Conversation` 构造函数来创建一个会话对象。在创建会话对象时，设置了以下几个关键属性：
|
||
- `name`: 使用 `self.model_names[0]` 作为会话的名称，这意味着会话名称将是模型名称列表中的第一个名称。
|
||
- `system_message`: 系统消息被设置为空字符串。
|
||
- `messages`: 消息列表被初始化为空列表。
|
||
- `roles`: 角色被设置为包含“user”和“assistant”的列表，表示会话中的用户角色和助手角色。
|
||
- `sep`: 设置为“\n### ”，这是消息之间的分隔符。
|
||
- `stop_str`: 设置为“###”，作为会话的终止字符串。
|
||
|
||
**注意**:
|
||
- 虽然 `conv_template` 和 `model_path` 参数在当前实现中未被直接使用，但它们的存在可能是为了未来的扩展性，允许根据不同的模板或模型路径创建不同的会话模板。
|
||
- 在使用此函数时，需要确保 `self.model_names` 至少包含一个元素，否则在尝试访问 `self.model_names[0]` 时会引发索引错误。
|
||
|
||
**输出示例**:
|
||
假设 `self.model_names` 包含一个元素 `"ModelA"`，则函数的返回值可能如下所示：
|
||
```python
|
||
Conversation(
|
||
name="ModelA",
|
||
system_message="",
|
||
messages=[],
|
||
roles=["user", "assistant"],
|
||
sep="\n### ",
|
||
stop_str="###",
|
||
)
|
||
```
|
||
这表示创建了一个名为 "ModelA" 的空会话模板，其中没有预设的系统消息或用户消息，定义了用户和助手的角色，并指定了消息分隔符和会话终止字符串。
|
||
***
|