AI Q&A 用 ContextualAnswer API の呼び出し - IMM

操作説明

注意事項

このインターフェイスを使用する前に、Intelligent Media Management プロダクトの課金方法と料金を十分に理解していることを確認してください。
このインターフェイスを呼び出す前に、バインディング (CreateBinding) またはアクティブなインデックス化 (IndexFileMeta または BatchIndexFileMeta) を通じて、ファイルをデータセットにインデックス化していることを確認してください。
返される結果は単なる例です。ワークフローテンプレート構成によっては、取得されるファイルメタデータ情報のカテゴリとコンテンツが例と異なる場合があります。ご不明な点がある場合は、DingTalk でグループ番号 21714099 を検索して DingTalk グループに参加してください。

使用制限

会話履歴の最大長は、ユーザーメッセージとアシスタントメッセージを含めて 100 です。
各メッセージは中国語文字で 1000 文字を超えないようにしてください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:ContextualAnswer

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectName	string	必須	プロジェクト名。取得方法については、「プロジェクトの作成」をご参照ください。	test-project
Messages	array	必須	はい、会話とツール呼び出しの履歴です。最新のメッセージは末尾 (インデックス n-1) にあり、最も古いメッセージは先頭 (インデックス 0) にあります。ユーザーとアシスタントのペアの形式である必要があり、合計数は 2*n+1 で、最新の質問の長さは 1000 文字を超えてはなりません。会話履歴の長さは 100 に制限されています。
	ContextualMessage	任意	会話メッセージのリスト
Files	array	任意	現在の Q&A に関連するファイルのコンテンツ。ContextualRetrieval インターフェイスの戻り値を入力として使用することを推奨します。
	ContextualFile	任意	Q&A に関連するファイルのリスト

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	現在のリクエストのリクエストID。	22F081FB-90D7-525A-BFE4-D28DC906A28F
Answer	Answer	大規模モデルからの応答コンテンツ。
Code	string	エラーコード。	ResourceNotFound
Message	string	エラーメッセージ。	The specified resource project is not found.

例

成功レスポンス

JSONJSON

{
  "RequestId": "22F081FB-90D7-525A-BFE4-D28DC906A28F",
  "Answer": {
    "Content": "你好",
    "References": [
      {
        "ProjectName": "test-project",
        "DatasetName": "test-dataset",
        "ObjectId": "75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7",
        "URI": "oss://test-bucket/test-object.jpg"
      }
    ]
  },
  "Code": "ResourceNotFound",
  "Message": "The specified resource project is not found."
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。