Alibaba Cloud Model Studio に渡されるパラメーター - Intelligent Media Services

このトピックでは、AI リアルタイムインタラクションから Alibaba Cloud Model Studio に渡されるパラメーターについて説明します。開発者がエージェントオーケストレーションアプリケーションのパラメーターを設定および渡すのに役立ちます。

パラメーター

パラメーター	タイプ	説明	例
biz_params	オブジェクト	ワークフローアプリケーションとエージェントオーケストレーションアプリケーションのカスタムパラメーターです。プラグインにパラメーターを渡すには、`user_defined_params` を追加します。詳細については、「アプリケーションのパラメーターパススルー」をご参照ください。説明 Alibaba Cloud は、次のエージェント関連のパラメーターを渡します。これらのパラメーターを設定する必要はありません。 instanceId: エージェントインスタンスの ID です。 channelId: RTC チャンネルの ID です。	プラグインの場合 `{ "user_defined_params": { "city":"Singapore" } }` ワークフローの場合 `{ "city":"Singapore" }`
memory_id	文字列	長期メモリの固有識別子。このパラメーターを使用すると、履歴情報を効率的に保存および呼び出すことができます。	YOUR_MEMORY_ID
image_list	配列	現在の操作に関連する視覚情報を提供する、関連付けられた画像への URL です。	["https://example.com/images/example.jpg"]
rag_options	オブジェクト	Retrieval-Augmented Generation（RAG）に関連するパラメーター。これには、指定されたナレッジベースまたはドキュメントの取得などが含まれます。
pipeline_ids	配列	ナレッジベース ID。指定した場合、指定されたナレッジベース内のすべてのドキュメントが取得されます。	["ナレッジベース ID1", "ナレッジベース ID2"]
file_ids	配列	処理対象の非構造化ドキュメントの ID です。	["ドキュメント ID1", "ドキュメント ID2"]
metadata_filter	オブジェクト	非構造化ドキュメントのメタデータ。指定した場合、メタデータを含むドキュメントが取得されます。	{ "name": "Zhang San" }
structured_filter	オブジェクト	構造化ドキュメントをフィルタリングするために使用される列名と対応する値。	{ "key1": "value1", "key2": "value2" }
tags	配列	非構造化ドキュメントに関連付けられたタグ。指定した場合、タグを含む非構造化ドキュメントが取得されます。	["タグ 1", "タグ 2"]

詳細については、「API を使用してアプリケーションを呼び出す」をご参照ください。

パラメーターの例

プラグイン

bailianParamsJson = {
    "biz_params": {
        "user_defined_params": 
        {
            "your_plugin_id":  // あなたのプラグイン ID
            {
                "article_index": 2
            }
        }
    },
    "memory_id": "your_memory_id", // あなたのメモリ ID
    "image_list": [
        "https://your_image_url"  # 画像への URL
    ],
    "rag_options": {
        "pipeline_ids": [
            "your_id",  # ナレッジベース ID
        ],
        "file_ids": [
            "Document ID1",  # ドキュメント ID
            "Document ID2"   # ドキュメント ID
        ],
        "metadata_filter": {
            "name": "Zhang San"  # メタデータのフィルター条件
        },
        "structured_filter": {
            "key1": "value1",  # 構造化ドキュメントのフィルター条件
            "key2": "value2"   # 構造化ドキュメントのフィルター条件
        },
        "tags": [
            "Tag 1",  # タグ
            "Tag 2"   # タグ
        ]
    }
}
bailianParams = json.dumps(bailianParamsJson)

ワークフロー


bailianParamsJson = {
    "biz_params": {
        "key1": "value1"
    },
    "memory_id": "your_memory_id", // あなたのメモリ ID
    "image_list": [
        "https://your_image_url"  # 画像への URL
    ],
    "rag_options": {
        "pipeline_ids": [
            "your_id"  # ナレッジベース ID
        ],
        "file_ids": [
            "Document ID1",  # ドキュメント ID
            "Document ID2"  # ドキュメント ID
        ],
        "metadata_filter": {
            "name": "Zhang San"  # メタデータのフィルター条件
        },
        "structured_filter": {
            "key1": "value1",  # 構造化ドキュメントのフィルター条件
            "key2": "value2"  # 構造化ドキュメントのフィルター条件
        },
        "tags": [
            "Tag 1",  # タグ
            "Tag 2"  # タグ
        ]
    }
}
bailianParams = json.dumps(bailianParamsJson)