API 標準および多言語対応の SDK
本製品 (bailian/2023-12-29) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
- RAM ユーザー
- RAM ユーザー用の AccessKey ペア
データ接続 (旧アプリケーションデータ)
API | タイトル | 説明 |
|---|---|---|
| AddCategory | AddCategory | 指定されたワークスペースにカテゴリを作成し、ファイルを分類・管理します。各ワークスペースは最大 500 個のカテゴリをサポートします。 |
| ListCategory | ListCategory | 指定されたワークスペースにある、1 つ以上のカテゴリの詳細を取得します。 |
| DeleteCategory | カテゴリを削除します | 指定されたカテゴリを完全に削除します。 |
| ApplyFileUploadLease | ファイルアップロードリースを申請します | ナレッジベースファイルまたはエージェントアプリケーションの会話インタラクション用ファイルをアップロードするためのアップロードリースをリクエストします。 |
| AddFile | ファイルを追加します。 | Alibaba Cloud Model Studio の一時ストレージからファイルを Alibaba Cloud Model Studio データ接続 (旧アプリケーションデータ) にインポートします。 |
| AddFilesFromAuthorizedOss | 承認済みの OSS バケットからファイルをインポートします。 | 承認済みの OSS バケットから Alibaba Cloud Model Studio アプリケーションデータにファイルをインポートします。 |
| ListFile | ファイルリスト | 指定されたカテゴリ内の 1 つ以上のドキュメントの詳細を取得します。 |
| DescribeFile | ファイルステータスを照会します | アプリケーションデータ内のファイルの基本情報（ファイル名、タイプ、ステータスなど）を照会します。 |
| UpdateFileTag | ファイルタグの更新 | 指定されたファイルのタグを更新します。 |
| BatchUpdateFileTag | BatchUpdateFileTag | この API は、データ接続内のドキュメントタグを一括で更新します。 |
| DeleteFile | DeleteFile | アプリケーションデータから指定されたファイルを完全に削除します。API を介したデータテーブルの削除はサポートされていません。詳細については、以下の API ガイドをご参照ください。 |
| DeleteFiles | ファイルをバッチで削除します | 1 回のリクエストで複数のファイルを削除します。 |
| GetParseSettings | GetParseSettings | 指定されたカテゴリのデータ解析設定を照会します。 |
| GetAvailableParserTypes | GetAvailableParserTypes | 入力ファイルタイプ (ファイル拡張子) に基づいて、サポートされているすべてのパーサタイプを一覧表示します。 |
| ChangeParseSetting | カテゴリ解析設定の変更。 | 特定のファイルタイプの解析メソッドを設定します。たとえば、.pdf ファイルに large モデルドキュメント解析を指定したり、.jpg ファイルに Qwen VL 解析を指定したりできます。 |
| AddTable | AddTable | テーブルデータコネクタにテーブルを追加します。 |
| UpdateTableFromAuthorizedOss | UpdateTableFromAuthorizedOss | 権限を付与された OSS バケットのファイルを使用して、Alibaba Cloud Model Studio データコネクタのテーブルを更新します。 |
| AddConnector | AddConnector | コネクタを作成します。現在、この API はファイルコネクタのみをサポートしています。 |
| GetConnector | GetConnector | コネクタの詳細を取得します。現在、この操作はファイルコネクタにのみ対応しています。 |
| UpdateConnector | UpdateConnector | コネクタを更新します。 |
ナレッジベース
API | タイトル | 説明 |
|---|---|---|
| CreateIndex | ナレッジベースを作成します。 | ドキュメントまたは音声/動画に基づく非構造化ナレッジベース、あるいはデータクエリやイメージベースの Q&A 用の構造化ナレッジベースを作成します。 |
| GetIndexJobStatus | ナレッジベースタスクのステータスを照会します。 | 指定されたナレッジベース作成タスクまたはナレッジベースドキュメント追加タスクの現在のステータスを照会します。 |
| SubmitIndexJob | ナレッジベース作成タスクを送信します | 指定された CreateIndex タスクを送信して、ナレッジベースの作成を完了します。 |
| SubmitIndexAddDocumentsJob | SubmitIndexAddDocumentsJob | 解析されたファイルを指定のナレッジベースに追加します。 |
| Retrieve | Retrieve | 指定されたナレッジベースから情報を取得します。 |
| ListIndexDocuments | ナレッジベース内のファイルを照会します。 | 指定されたナレッジベースからファイルとそのまとめ情報を取得します。 |
| ListIndexFileDetails | ナレッジベース内のファイルの詳細を照会します。 | 指定されたナレッジベース内のファイルとその詳細を取得します。 |
| DeleteIndexDocument | ナレッジベースからファイルを削除します | 指定されたナレッジベースからファイルを完全に削除します。 |
| ListIndices | ナレッジベースのリストを取得します | 指定されたワークスペース内のナレッジベースのリストを取得します。 |
| DeleteIndex | ナレッジベースを削除します | 指定されたナレッジベースを完全に削除します。 |
| ListChunks | インデックス配下のチャンクリストを照会します | テキストチャンクのリストと情報を照会します。 |
| UpdateChunk | チャンクの更新 | ナレッジベース内の指定されたテキストチャンクの内容とタイトルを変更し、そのチャンクがナレッジベースの検索に参加するかどうかを指定します。 |
| DeleteChunk | チャンクを削除します | ナレッジベースから指定されたテキストチャンクを削除します。削除されたテキストチャンクは取得または呼び出しできません。 |
プロンプトエンジニアリング
API | タイトル | 説明 |
|---|---|---|
| CreatePromptTemplate | プロンプトテンプレートの作成 | プロンプトテンプレートを作成します。 |
| GetPromptTemplate | GetPromptTemplate | テンプレート ID に基づいてプロンプトテンプレートを取得します。 |
| UpdatePromptTemplate | UpdatePromptTemplate | テンプレート ID に基づいてプロンプトテンプレートを更新します。 |
| DeletePromptTemplate | DeletePromptTemplate | テンプレート ID に基づいてプロンプトテンプレートを削除します。 |
| ListPromptTemplates | ListPromptTemplates | プロンプトテンプレートのリストを取得します。 |
その他
API | タイトル | 説明 |
|---|---|---|
| CreateMemory | 長期メモリを作成します | 長期メモリを作成します。 |
| GetMemory | 長期メモリの取得 | 指定された長期メモリの説明を取得します。 |
| UpdateMemory | 長期メモリを更新します | 指定された長期メモリの説明を更新します。 |
| DeleteMemory | long-term メモリを削除します | 指定された long-term メモリを完全に削除します。 |
| ListMemories | long-term メモリのリストを取得します | 指定されたワークスペース内の 1 つ以上の long-term メモリエンティティの詳細を取得します。 |
| CreateMemoryNode | メモリノードを作成します | メモリノードを作成します。 |
| GetMemoryNode | メモリフラグメントの取得 | メモリフラグメントを取得します。 |
| UpdateMemoryNode | メモリフラグメントの更新 | メモリフラグメントを更新します。 |
| DeleteMemoryNode | メモリフラグメントを削除します | メモリフラグメントを削除します。 |
| ListMemoryNodes | メモリノードリストを取得します | メモリノードのリストを取得します。 |
| ApplyTempStorageLease | ApplyTempStorageLease | このインターフェイスはプロコードデプロイメント専用です。他のシナリオは現在サポートされていません。このインターフェイスは、一時的なファイルアップロードリースを申請するために使用されます。リースを取得した後、手動でファイルをアップロードする必要があります。 |
Others
API | タイトル | 説明 |
|---|---|---|
| AddChunk | チャンクの追加。 | ドキュメント検索 (document)、データクエリ (table)、またはイメージ Q&A (image) のナレッジベースにチャンクを追加します。 |