基于 ChatGPT 构建电商客服问答系统

2.3.2 调用 API

因为要和 ChatGPT 聊天，所以在定义这个函数的时候需要用到创建 chat completion，在最新版的示例如下：

还有审查 API。

三、具体代码

3.1 封装聊天函数

主要是通过调用 OpenAI API 来实现和模型的对话，并返回模型的对话，封装为 get_completion_from_messages，并保存在 tool.py 文件中。

tool.py

from openai import OpenAI

#此处换成自己的 API Key
API_SECRET_KEY = "sk-..."

#因为我用的第三方要求，直接用 OpenAI 申请下的 key 的话这行可不要
BASE_URL = "https://flag.smarttrot.com/v1/"

client = OpenAI(api_key=API_SECRET_KEY, base_url=BASE_URL)


'''
封装一个支持更多参数的自定义访问 OpenAI GPT3.5 的函数
参数:
messages: 这是一个消息列表，每个消息都是一个字典，包含 role(角色）和 content(内容)。角色可以是'system'、'user'或 'assistant'，内容是角色的消息。
model: 调用的模型，默认为 gpt-3.5-turbo(ChatGPT)，有内测资格的用户可以选择 gpt-4
temperature: 这决定模型输出的随机程度，默认为 0，表示输出将非常确定。增加温度会使输出更随
机。
max_tokens: 这决定模型输出的最大的 token 数。
'''
def get_completion_from_messages(messages,
                                 model='gpt-3.5-turbo',
                                 temperature=0,
                                 max_tokens=500):

    response = client.chat.completions.create(
        model=model,
        messages=messages,
        temperature=temperature,
        max_tokens=max_tokens,
    )

    return response.choices[0].message.content

3.2 封装文件处理函数

主要是封装一系列用于处理文件的函数，如获取产品、获取分类等，保存为 utils_zh.py 文件。

utils_zh.py

import json
from tool import get_completion_from_messages
from collections import defaultdict

with open("products.json", "r") as file:
    products = json.load(file)
    
delimiter = "####"

system_message = f"""
您将获得客户服务查询。
客户服务查询将使用{delimiter}字符作为分隔符。
请仅输出一个可解析的 Python 列表，列表每一个元素是一个 JSON 对象，每个对象具有以下格式：
'category': <包括以下几个类别：Computers and Laptops、Smartphones and Accessories、
Televisions and Home Theater Systems、Gaming Consoles and Accessories、Audio
Equipment、Cameras and Camcorders>,
以及
'products': <必须是下面的允许产品列表中找到的产品列表>

类别和产品必须在客户服务查询中找到。
如果提到了某个产品，它必须与允许产品列表中的正确类别关联。
如果未找到任何产品或类别，则输出一个空列表。
除了列表外，不要输出其他任何信息！

允许的产品：
Computers and Laptops category:
TechPro Ultrabook
BlueWave Gaming Laptop
PowerLite Convertible
TechPro Desktop
BlueWave Chromebook

Smartphones and Accessories category:
SmartX ProPhone
MobiTech PowerCase
SmartX MiniPhone
MobiTech Wireless Charger
SmartX EarBuds

Televisions and Home Theater Systems category:
CineView 4K TV
SoundMax Home Theater
CineView 8K TV
SoundMax Soundbar
CineView OLED TV

Gaming Consoles and Accessories category:
GameSphere X
ProGamer Controller
GameSphere Y
ProGamer Racing Wheel
GameSphere VR Headset

Audio Equipment category:
AudioPhonic Noise-Canceling Headphones
WaveSound Bluetooth Speaker
AudioPhonic True Wireless Earbuds
WaveSound Soundbar
AudioPhonic Turntable

Cameras and Camcorders category:
FotoSnap DSLR Camera
ActionCam 4K
FotoSnap Mirrorless Camera
ZoomMaster Camcorder
FotoSnap Instant Camera

只输出对象列表，不包含其他内容。
"""

## 检索详细信息
def get_product_by_name(name):

    """
    根据产品名称获取产品
    参数:
    name: 产品名称
    """
    return products.get(name, None)

def get_products_by_category(category):
    """
    根据类别获取产品
    参数:
    category: 产品类别
    """
    return [product for product in products.values() if product["category"] == category]

## 解析输入字符串
def read_string_to_list(input_string):
    """
将输入的字符串转换为 Python 列表。
参数:
input_string: 输入的字符串，应为有效的 JSON 格式。
返回:
list 或 None: 如果输入字符串有效，则返回对应的 Python 列表，否则返回 None。
    """

    if input_string is None:
        return None
    
    try:
        # 将输入字符串中的单引号替换为双引号，以满足 JSON 格式的要求
        input_string = input_string.replace("'", '"')
        data = json.loads(input_string)
        return data
    except json.JSONDecodeError:
        print("Error: Invalid JSON string")
        return None
    

##进行检索
def generate_output_string(data_list):

    """
根据输入的数据列表生成包含产品或类别信息的字符串。
参数:
data_list: 包含字典的列表，每个字典都应包含 "products" 或 "category" 的键。
返回:
output_string: 包含产品或类别信息的字符串。
    """
    output_string = ""
    if data_list is None:
        return output_string
    
    for data in data_list:
        try:
            if "products" in data and data["products"]:
                products_list = data["products"]
                for product_name in products_list:
                    product = get_product_by_name(product_name)
                if product:
                    output_string += json.dumps(product, indent=4, ensure_ascii=False) + "\n"
                else:
                    print(f"Error: Product '{product_name}' not found")
            elif "category" in data:
                category_name = data["category"]
                category_products = get_products_by_category(category_name)
                for product in category_products:
                    output_string += json.dumps(product, indent=4, ensure_ascii=False) + "\n"      
            else:
                print("Error: Invalid object format")
        except Exception as e:
            print(f"Error: {e}")

    return output_string

def find_category_and_product_only(user_input, products_and_category):
    delimiter = "####"
    system_message = f"""
您将获得客户服务查询。
客户服务查询将使用{delimiter}字符作为分隔符。
请仅输出一个可解析的 Python 列表，列表每一个元素是一个 JSON 对象，每个对象具有以下格式：
'category': <包括以下几个类别：Computers and Laptops、Smartphones and Accessories、
Televisions and Home Theater Systems、Gaming Consoles and Accessories、Audio
Equipment、Cameras and Camcorders>,
以及
'products': <必须是下面的允许产品列表中找到的产品列表>

类别和产品必须在客户服务查询中找到。
如果提到了某个产品，它必须与允许产品列表中的正确类别关联。
如果未找到任何产品或类别，则输出一个空列表。
除了列表外，不要输出其他任何信息！

允许的产品：
Computers and Laptops category:
TechPro Ultrabook
BlueWave Gaming Laptop
PowerLite Convertible
TechPro Desktop
BlueWave Chromebook

Smartphones and Accessories category:
SmartX ProPhone
MobiTech PowerCase
SmartX MiniPhone
MobiTech Wireless Charger
SmartX EarBuds

Televisions and Home Theater Systems category:
CineView 4K TV
SoundMax Home Theater
CineView 8K TV
SoundMax Soundbar
CineView OLED TV

Gaming Consoles and Accessories category:
GameSphere X
ProGamer Controller
GameSphere Y
ProGamer Racing Wheel
GameSphere VR Headset

Audio Equipment category:
AudioPhonic Noise-Canceling Headphones
WaveSound Bluetooth Speaker
AudioPhonic True Wireless Earbuds
WaveSound Soundbar
AudioPhonic Turntable

Cameras and Camcorders category:
FotoSnap DSLR Camera
ActionCam 4K
FotoSnap Mirrorless Camera
ZoomMaster Camcorder
FotoSnap Instant Camera

只输出对象列表，不包含其他内容。
"""
    messages = [
    {'role':'system', 'content': system_message},    
    {'role':'user', 'content': f"{delimiter}{user_input}{delimiter}"},  
    ] 
    return get_completion_from_messages(messages)

def get_products_and_category():
    """
    Used in L5
    """
    products = get_products()
    products_by_category = defaultdict(list)
    for product_name, product_info in products.items():
        category = product_info.get('category')
        if category:
            products_by_category[category].append(product_info.get('name'))
    
    return dict(products_by_category)


products_file = 'products.json'
def get_products():
    with open(products_file, 'r') as file:
        products = json.load(file)
    return products

3.3 封装链式提问函数

主要是完成之前的整个提问、审核流程思路，保存为 qa.py 文件。

qa.py

from openai import OpenAI

import utils_zh
from tool import get_completion_from_messages

API_SECRET_KEY = "sk-..."
BASE_URL = "https://flag.smarttrot.com/v1/"

client = OpenAI(api_key=API_SECRET_KEY, base_url=BASE_URL)

def process_user_message_ch(user_input, all_messages, debug=True):
    """
对用户信息进行预处理
参数:
user_input : 用户输入
all_messages : 历史信息
debug : 是否开启 DEBUG 模式，默认开启
"""

    # 分隔符
    delimiter = "```"

    #第一步：使用 OpenAI 的 Moderation API 对用户输入进行审核，判断是否包含敏感信息
    response = client.moderations.create(
        input=user_input
    )
    moderation_output = response.results[0]

    # 经过检查，发现包含敏感信息，则直接返回提示语
    if moderation_output.flagged:
        print("第一步：输入被 Moderation API 检测到敏感信息，直接返回提示语")
        return "你的输入被检测到包含敏感信息，请重新输入！"
    
    #如果开启了 DEBUG 模式，则打印出 Moderation API 检测到的敏感信息
    if debug: print("第一步：输入通过 Moderation API 检测")

    # 第二步：抽取出商品和对应的目录
    category_and_product_response = utils_zh.find_category_and_product_only(user_input, utils_zh.get_products_and_category())

    #将抽取出来的字符串转化为 list
    category_and_product_list = utils_zh.read_string_to_list(category_and_product_response)

    if debug: print("第二步：抽取出商品和对应的目录")

    #第三步：查找商品对应信息
    product_information = utils_zh.generate_output_string(category_and_product_list)
    if debug: print("第三步：查找抽取出的商品信息")

    #第四步：回答用户问题
    system_message = f"""
您是一家大型电子商店的客户服务助理。\
请以友好和乐于助人的语气回答问题，并提供简洁明了的答案。\
请确保向用户提出相关的后续问题。
"""
    
    #插入 message
    messages = [
        {"role": "system", "content": system_message},
        {"role": "user", "content": f"{delimiter}{user_input}{delimiter}"},
        {'role': 'assistant', 'content': f"相关商品信息:\n{product_information}"}
    ]

    #获取 GPT-3.5 的回答
    #通过附加 all_messages 来实现多轮对话
    final_response = get_completion_from_messages(all_messages+messages)
    if debug:print("第四步，生成用户回答")

    # 将该轮信息加入到历史信息中
    all_messages = all_messages + messages[1:]

    # 第五步：基于 Moderation API 检查输出是否合规
    response = client.moderations.create(input=final_response)
    moderation_output = response.results[0]

    # 输出不合规
    if moderation_output.flagged:
        if debug: print("第五步：输出被 Moderation 拒绝")
        return "抱歉，我们不能提供该信息"
    
    if debug: print("第五步：输出经过 Moderation 检查")

    # 第六步：模型检查是否很好地回答了用户问题
    user_message = f"""
    用户信息：{delimiter}{user_input}{delimiter}
    代理回复：{delimiter}{final_response}{delimiter}

    回复是否足够回答问题
    如果足够，回答 Y
    如果不足够，回答 N
    仅回答上述字母即可
    """

    # print(final_response)
    messages = [
        {'role': 'system', 'content': system_message},
        {'role': 'user', 'content': user_message}
    ]

    # 要求模型评估回答
    evaluation_response = get_completion_from_messages(messages)

    # print(evaluation_response)
    if debug: print("第六步：模型评估该回答")


    # 第七步：如果评估为 Y，输出回答；如果评估为 N，反馈将由人工修正答案
    if "Y" in evaluation_response: # 使用 in 来避免模型可能生成 Yes
        if debug: print("第七步：模型赞同了该回答.")
        return final_response, all_messages
    else:
        if debug: print("第七步：模型不赞成该回答.")
        neg_str = "很抱歉，我无法提供您所需的信息。我将为您转接到一位人工客服代表以获取进一步帮助。"
        return neg_str, all_messages

3.4 可视化调用

使用 panel 库将整个流程在可视化界面上进行可交互操作，保存为 window.py。

window.py

import panel as pn
from qa import process_user_message_ch

def collect_messages_ch(debug=True):
    """
用于收集用户的输入并生成助手的回答
参数：
debug: 用于觉得是否开启调试模式
    """
    user_input = inp.value
    if debug: print(f"User Input = {user_input}")
    if user_input == "":
        return
    inp.value = ''
    global context
    # 调用 process_user_message 函数
    #response, context = process_user_message(user_input, context,utils.get_products_and_category(),debug=True)
    response, context = process_user_message_ch(user_input, context, debug=False)
    # print(response)
    context.append({'role':'assistant', 'content':f"{response}"})
    panels.append(
        pn.Row('User:', pn.pane.Markdown(user_input, width=600)))
    panels.append(
        pn.Row('Assistant:', pn.pane.Markdown(response, width=600, style={'background-color': '#F6F6F6'})))
    return pn.Column(*panels) # 包含了所有的对话信息

pn.extension()
panels = [] # collect display
# 系统信息
context = [ {'role':'system', 'content':"You are Service Assistant"} ]
inp = pn.widgets.TextInput( placeholder='Enter text here…')
button_conversation = pn.widgets.Button(name="Service Assistant")
interactive_conversation = pn.bind(collect_messages_ch, button_conversation)
dashboard = pn.Column(
    inp,
    pn.Row(button_conversation),
    pn.panel(interactive_conversation, loading_indicator=True, height=300),
)
dashboard

pn.serve(dashboard, show=True)

此程序执行，即在浏览器打开页面，测试使用结果如下。

可以看出在提出价格是多少的时候，是有报因为模型评估不赞同答案而给出的提示语，这里我没有去深入调试，造成原因有可能是中文理解或者是文件读取等导致的，有兴趣的小伙伴可以自行尝试。

总结

本文介绍了如何基于 ChatGPT 构建一个简单的电商客服问答系统。通过链式调用语言模型，结合多个 Prompt 实现复杂的问答与推理功能。主要涉及了环境配置、API 调用封装、数据处理以及可视化界面的搭建。在实际应用中，可以根据具体需求调整 Prompt 策略和优化模型参数。