百炼应用中心参数

本篇文档将详细阐述AI实时互动透传至百炼应用中心各参数的功能与用途,以帮助开发者在智能体编排应用中进行有效的配置与传递。

参数描述

参数名

参数类型

描述

参数示例

biz_params

Object

工作流应用和智能体编排应用自定义参数透传字段。

说明

我们会额外传入智能体实例相关参数,您无需再次传入:

  • instanceId:AI实时互动智能体实例Id

  • channelId:AI实时互动RTC房间号

{

"user_defined_params": {

"city":"杭州"

}

}

memory_id

String

用于指向长期记忆的唯一标识符。此参数能够有效地保存和调用历史信息。

YOUR_MEMORY_ID

image_list

Array

关联图片链接列表,能够提供与当前操作相关的视觉信息。

["https://example.com/images/example.jpg"]

rag_options

Object

知识库检索配置,用于指定智能体从知识库中检索信息时的具体选项。

  • pipeline_ids

Array

知识库ID,用以识别和调用特定的知识库。

["知识库ID1", "知识库ID2"]

  • file_ids

Array

非结构文档ID,用于指定需要处理的非结构化文档。

["文档ID1", "文档ID2"]

  • metadata_filter

Object

非结构化文档的元数据,用于过滤和找到特定的文档。

{

"name": "张三"

}

  • structured_filter

Object

用于过滤结构化文档的列名及其对应的值。

{

"key1": "value1",

"key2": "value2"

}

  • tags

Array

非结构化文档的标签,方便进行分类和检索。

["标签1", "标签2"]

更多详情,请参见百炼应用

参数示例

bailianParamsJson = {
    "biz_params": {
        "user_defined_params": 
        {
            "your_plugin_id":
            {
                "article_index": 2
            }
        }
    },
    "memory_id": "your_memory_id",
    "image_list": [
        "https://your_image_url"  # 示例图片链接
    ],
    "rag_options": {
        "pipeline_ids": [
            "your_id",  # 替换为实际知识库ID
        ],
        "file_ids": [
            "文档ID1",  # 替换为实际文档ID
            "文档ID2"   # 替换为实际文档ID
        ],
        "metadata_filter": {
            "name": "张三"  # 替换为所需的元数据过滤条件
        },
        "structured_filter": {
            "key1": "value1",  # 示例过滤条件
            "key2": "value2"   # 示例过滤条件
        },
        "tags": [
            "标签1",  # 替换为实际标签
            "标签2"   # 替换为实际标签
        ]
    }
}
bailianParams = json.dumps(bailianparams)