Skip to content

Commit

Permalink
修改README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ide-rea committed Mar 20, 2024
1 parent a80dc44 commit 8bfee14
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions appbuilder/core/console/agent_builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ os.environ["APPBUILDER_TOKEN"] = "bce-YOURTOKEN"

### 初始化参数

- `app_id`: 线上AgentBuilder应用ID,可在[console](https://console.bce.baidu.com/ai_apaas/app)上查看和获取,示例如图
- `app_id`: 线上AgentBuilder应用ID,可在[百度智能云千帆AppBuilder](https://cloud.baidu.com/product/AppBuilder)我的应用中查看应用ID,示例如图

<img width="768" alt="image" src="./image/agentbuilder.png">

Expand All @@ -71,7 +71,7 @@ os.environ["APPBUILDER_TOKEN"] = "bce-YOURTOKEN"
| content | AgentBuilderAnswer | 对话返回结果 | |
| +code | Int | 错误码,0代码成功,非0表示失败 | 0 |
| +message | String | 错误具体消息 | |
| +answer | String | 智能体返回的回答 | |
| +answer | String | 智能体应用返回的回答 | |
| +events | List[Event] | 事件列表 | |
| +events[0] | Event | 具体事件内容 | |
| ++code | String | 错误码 | |
Expand All @@ -90,7 +90,7 @@ os.environ["APPBUILDER_TOKEN"] = "bce-YOURTOKEN"
### 响应示例

```
Message(name=msg, content=北京市的面积是16410.54平方公里^[2]^。, mtype=dict, extra={'search_baidu': [{'id': '1', 'content': '北京,简称“京”,是中华人民共和国的首都,是全国的政治中心、文化中心,是世界著名古都和现代化国际...', 'type': 'web', 'from': 'search_baidu', 'title': '北京概况_首都之窗_北京市人民政府门户网站', 'url': 'https://www.beijing.gov.cn/renwen/bjgk/?eqid=b987a5f000085b6700000002642e204d'}, 'id', 'content', 'type', 'from', 'title', 'url']}, conversation_id=5a247540-e8cf-402a-a630-8015c24904f5)
Message(name=msg, content=code=0 message='' answer='模型识别结果为:\n类别: 黑松 置信度: 0.599807\n根据植物识别工具的识别结果,图中的植物很可能是黑松,置信度为0.599807。需要注意的是,置信度并不是特别高,因此这个结果仅供参考。如果你需要更准确的识别结果,可以尝试提供更多的图片信息或者使用更专业的植物识别工具。如果你还有其他问题或者需要进一步的帮助,请随时告诉我。' events=[Event(code=0, message='', status='done', event_type='function_call', content_type='function_call', detail={'text': {'thought': '', 'name': 'plant_rec', 'arguments': {'img_path': 'tree.png'}, 'component': 'PlantRecognition', 'name_cn': '植物识别'}}), Event(code=0, message='', status='preparing', event_type='PlantRecognition', content_type='status', detail={}), Event(code=0, message='', status='done', event_type='PlantRecognition', content_type='text', detail={'text': '模型识别结果为:\n类别: 黑松 置信度: 0.599807\n'}), Event(code=0, message='', status='success', event_type='PlantRecognition', content_type='status', detail={}), Event(code=0, message='', status='done', event_type='function_call', content_type='function_call', detail={'text': {'thought': '', 'name': 'chat_agent', 'arguments': {}, 'component': 'ChatAgent', 'name_cn': '聊天助手'}}), Event(code=0, message='', status='preparing', event_type='ChatAgent', content_type='status', detail={}), Event(code=0, message='', status='done', event_type='ChatAgent', content_type='text', detail={'text': '根据植物识别工具的识别结果,图中的植物很可能是黑松,置信度为0.599807。需要注意的是,置信度并不是特别高,因此这个结果仅供参考。如果你需要更准确的识别结果,可以尝试提供更多的图片信息或者使用更专业的植物识别工具。如果你还有其他问题或者需要进一步的帮助,请随时告诉我。'}), Event(code=0, message='', status='success', event_type='ChatAgent', content_type='status', detail={})], mtype=AgentBuilderAnswer)
```

## 高级用法
Expand All @@ -104,7 +104,7 @@ import os
# 请前往千帆AppBuilder官网创建密钥,流程详见:https://cloud.baidu.com/doc/AppBuilder/s/Olq6grrt6#1%E3%80%81%E5%88%9B%E5%BB%BA%E5%AF%86%E9%92%A5
# 设置环境变量
os.environ["APPBUILDER_TOKEN"] = '...'
app_id = '...' # 已发布AgentBuilder应用ID,可在console端查看
app_id = '...' # 已发布AgentBuilder应用的ID
# 初始化智能体
agent = appbuilder.AgentBuilder(app_id)
# 创建会话
Expand All @@ -115,12 +115,12 @@ file_id = agent.upload_local_file(conversation_id, "/path/to/pdf/file")
# 开始对话,引用上传的文档
message = agent.run(conversation_id, "北京天气怎么样", file_ids=[file_id, ], stream=True)

# 打印会话结果

answer = ""

# 每次迭代返回AgentBuilderAnswer结构,内可能包括多个事件内容
for content in message.content:
# 流式场景下,answer内容流式返回,需要将每次返回的answer拼接起来才是完整的对话结果
# stream=True时,将answer拼接起来才是完整的的对话结果
answer += content.answer
for event in content.events:
content_type = event.content_type
Expand Down Expand Up @@ -151,6 +151,8 @@ for content in message.content:
data_class.StatusDetail(**detail)
else:
print(detail)

# 打印完整的answer结果
print(answer)
```

Expand Down

0 comments on commit 8bfee14

Please sign in to comment.