在程序中的使用:
response: ChatCompletion = openai.client.chat.completions.create( )
ChatCompletion
`ChatCompletion`是OpenAI API中的一个类,用于表示API的响应。它包含了API的响应信息,包括生成的回复、工具调用信息等。下面是`ChatCompletion`的结构和各个字段的解释:
1. **`id`**:这是一个字符串,表示API响应的唯一标识符。这个ID通常由API自动生成,用于唯一标识每个API响应。
2. **`object`**:这是一个字符串,表示API响应的类型。在这个例子中,API响应的类型是`chat.completion`,表示这是一个聊天回复。
3. **`created`**:这是一个整数,表示API响应的创建时间,以Unix时间戳的形式表示。
4. **`model`**:这是一个字符串,表示生成API响应的模型。在这个例子中,模型是"gpt-3.5-turbo",表示使用了GPT-3.5 Turbo模型。
5. **`choices`**:这是一个列表,包含了API响应的多个选择。每个选择都是一个`ChatCompletionChoice`对象,表示一个可能的回复。
- **`index`**:这是一个整数,表示选择的索引。这个索引通常从0开始。
- **`message`**:这是一个`ChatCompletionMessage`对象,表示选择的回复。
- **`role`**:这是一个字符串,表示回复的角色。在这个例子中,角色是`assistant`,表示这是一个助手生成的回复。
- **`content`**:这是一个字符串,表示回复的内容。
6. **`usage`**:这是一个字典,包含了API响应的使用信息。
- **`prompt_tokens`**:这是一个整数,表示输入的提示令牌数。
- **`completion_tokens`**:这是一个整数,表示生成的回复令牌数。
- **`total_tokens`**:这是一个整数,表示总的令牌数。
**用途**:
`ChatCompletion`类用于表示API的响应,它包含了API的响应信息,包括生成的回复、工具调用信息等。通过这个类,可以获取API响应的ID、模型、回复、工具调用信息和使用信息等。
- `ChatCompletion`类通常由OpenAI的API自动生成,不需要手动创建。
-其中含有:`ChatCompletionMessage`
ChatCompletionMessage
`ChatCompletionMessage`是OpenAI API中的一个类,用于表示聊天回复的消息。它通常在`ChatCompletion`对象的`choices`属性中使用,用于表示一个可能的回复。下面是`ChatCompletionMessage`的结构和各个字段的解释:
1. **`role`**:这是一个字符串,表示消息的角色。在这个例子中,角色是`assistant`,表示这是一个助手生成的回复。其他可能的值包括`system`和`user`,分别表示系统消息和用户消息。
2. **`content`**:这是一个字符串,表示消息的内容。这个内容通常是聊天回复的文本。
3. **`tool_calls`**:这是一个列表,包含了消息的工具调用信息。每个工具调用都是一个`ChatCompletionMessageToolCall`对象,表示一个工具调用。
**用途**:
`ChatCompletionMessage`类用于表示聊天回复的消息,它通常在`ChatCompletion`对象的`choices`属性中使用,用于表示一个可能的回复。通过这个类,可以获取消息的角色、内容和工具调用信息。
-其中含有:`ChatCompletionMessageToolCall`
ChatCompletionMessageToolCall
`ChatCompletionMessageToolCall`是OpenAI API中的一个类,用于表示工具调用信息。它通常在`ChatCompletionMessage`对象的`tool_calls`属性中使用,用于表示一个工具调用。下面是`ChatCompletionMessageToolCall`的结构和各个字段的解释:
1. **`id`**:这是一个字符串,表示工具调用的唯一标识符。这个ID通常由API自动生成,用于唯一标识每个工具调用。
2. **`function`**:这是一个`Function`对象,表示工具调用的具体函数。`Function`对象包含了函数的名称和参数。
- **`name`**:这是一个字符串,表示函数的名称。这个名称通常是一个标识符,用于唯一标识函数。
- **`arguments`**:这是一个字符串,表示函数的参数。这个参数通常是一个JSON格式的字符串,包含了函数的输入数据。
3. **`type`**:这是一个字符串,表示工具调用的类型。在这个例子中,工具调用的类型是`function`,表示这是一个函数调用。
**用途**:
`ChatCompletionMessageToolCall`类用于表示工具调用信息,它通常在`ChatCompletionMessage`对象的`tool_calls`属性中使用,用于表示一个工具调用。通过这个类,可以获取工具调用的ID、函数名称、函数参数和类型等信息,从而更好地理解和处理工具调用。
- `ChatCompletionMessageToolCall`类通常由OpenAI的API自动生成,不需要手动创建。
ChatCompletionMessageToolCall的使用参见:
更新API响应中的工具调用信息:`ChatCompletionMessageToolCall`和`Function`类
和openai.ChatCompletion.create调用工具函数:ChatCompletionMessageToolCall,functions=[tool_call]


3071

被折叠的 条评论
为什么被折叠?



