API 標準および多言語対応の SDK
本製品 (imm/2020-09-30) の API は、RPC 標準に準拠した 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 |
タイトル |
説明 |
| ListRegions | List of Regions Supporting IMM Service | リージョン一覧の取得 |
メタデータ管理
|
API |
タイトル |
説明 |
| メタデータインデックス | メタデータインデックス | |
| IndexFileMeta | IndexFileMeta | ラベル検出、顔検出、位置検出などのタスクのために、入力ファイルに対してデータ処理を実行します。この操作は、オブジェクトのメタデータを抽出し、インデックスを作成します。これにより、データセットからデータを取得できます。 |
| BatchIndexFileMeta | BatchIndexFileMeta | この操作は、ラベル検出、顔検出、位置検出などのタスクの入力ファイルを処理することで、オブジェクトのメタデータを一括でインデックス化します。オブジェクトのメタデータはデータセットにインデックス付けされ、さまざまなデータ検索方法をサポートします。 |
| UpdateFileMeta | UpdateFileMeta | データセット内のインデックス済みファイルのメタデータの一部を更新します。 |
| BatchUpdateFileMeta | BatchUpdateFileMeta | データセットにインデックス化されたファイルの一部のメタデータ項目を更新します。 |
| GetFileMeta | GetFileMeta | データセットにインデックスされたファイルのメタデータを照会します。 |
| BatchGetFileMeta | BatchGetFileMeta | 指定されたデータセット内の複数のオブジェクトまたはファイルのメタデータを照会します。 |
| DeleteFileMeta | DeleteFileMeta | データセットからファイルのメタデータを削除します。 |
| BatchDeleteFileMeta | BatchDeleteFileMeta | データセットから複数のファイルのメタデータを削除します。 |
| クエリと統計 | クエリと統計 | |
| SimpleQuery | SimpleQuery | データセット内のファイルにシンプルなクエリ操作を実行します。この操作は論理式をサポートしています。 |
| SemanticQuery | SemanticQuery | 自然言語を入力して、データセット内のメタデータをクエリします。 |
| FuzzyQuery | FuzzyQuery | ファイル名、ラベル、パス、カスタムタグなどの抽出済みファイルメタデータをクエリします。ファイルのメタデータフィールドの値が指定された文字列と一致する場合、そのファイルのメタデータが返されます。 |
| インテリジェント管理 | インテリジェント管理 | |
| 顔クラスタリング | 顔クラスタリング | |
| CreateFigureClusteringTask | CreateFigureClusteringTask | 人物クラスタリングタスクを作成します。このタスクは、インテリジェントアルゴリズムを使用して、データセットにインデックス化されたイメージ内のさまざまな人物の顔をグループ化します。 |
| CreateFigureClustersMergingTask | CreateFigureClustersMergingTask | 2 つ以上の人物クラスターグループを 1 つの人物クラスターグループにマージします。 |
| GetFigureCluster | GetFigureCluster | 顔クラスタリングに関する基本情報を取得します。これには、作成時刻、画像数、カバー情報などが含まれます。 |
| QueryFigureClusters | QueryFigureClusters | 指定された条件に基づいて顔グループをクエリします。 |
| BatchGetFigureCluster | BatchGetFigureCluster | 顔クラスターを照会します。 |
| UpdateFigureCluster | UpdateFigureCluster | フェイス クラスターについての情報を更新します（クラスター名やラベルなど）。 |
| SearchImageFigureCluster | SearchImageFigureCluster | 画像内の特定の顔を含む顔クラスターを照会します。各顔クラスターには、バウンディングボックスや類似度などの情報が含まれます。 |
| CreateFacesSearchingTask | CreateFacesSearchingTask | 指定された画像または顔 ID に最も類似する上位 N 個の画像をメディアセットから検索します。この操作は、対応する顔 ID とバウンディングボックスを類似度の降順でソートして返します。 |
| 時空間クラスタリング | 時空間クラスタリング | |
| CreateLocationDateClusteringTask | CreateLocationDateClusteringTask | 時空間クラスタリング機能は、データセット内のファイルを撮影時刻と位置情報に基づいて分類します。この機能は、撮影時刻と位置情報を含む画像や動画などのインデックス済みファイルに対して動作します。これらの分類結果は、ユーザーの旅行中に撮影された、類似したタイムスタンプと位置情報をもつファイル群を表すことができます。また、ユーザーが居住または勤務している複数の場所で撮影されたコンテンツを表すことも可能です。これらの分類結果の位置情報と時間範囲を分析することで、メディアファイルのカテゴリ分け、ハイライト動画の作成、写真・動画ストーリーの生成が可能になります。 |
| QueryLocationDateClusters | QueryLocationDateClusters | 指定された条件に基づいて、時空間クラスターのリストをクエリします。 |
| UpdateLocationDateCluster | UpdateLocationDateCluster | 時空間クラスターを更新します。 |
| DeleteLocationDateCluster | DeleteLocationDateCluster | 時空間クラスターを削除します。 |
| ストーリー | ストーリー | |
| CreateStory | CreateStory | ストーリーを作成します。 |
| QueryStories | QueryStories | 指定された条件に基づいてストーリーを照会します。 |
| GetStory | GetStory | ストーリーを照会します。 |
| CreateCustomizedStory | CreateCustomizedStory | 指定された画像および動画に基づいてストーリーを作成します。 |
| UpdateStory | UpdateStory | ストーリー名やカバーイメージなど、ストーリーに関する情報を更新します。 |
| AddStoryFiles | AddStoryFiles | ストーリーにオブジェクトを追加します。 |
| RemoveStoryFiles | RemoveStoryFiles | ストーリーからファイルを削除します。 |
| DeleteStory | DeleteStory | ストーリーを削除します。 |
| 画像クラスタリング | 画像クラスタリング | |
| CreateSimilarImageClusteringTask | CreateSimilarImageClusteringTask | 類似画像クラスタリング機能は、データセットにインデックスされた画像を視覚的な類似性に基づいてクラスターにグループ化します。この機能は、画像の重複排除やベストショットの選定などのシナリオに役立ちます。たとえば、アルバム内のバースト写真をフィルターする際に使用できます。 |
| QuerySimilarImageClusters | QuerySimilarImageClusters | この操作を呼び出して、類似画像クラスターの一覧を取得できます。 |
| データバインディング | データバインディング | |
| CreateBinding | CreateBinding | データセットと Object Storage Service (OSS) バケット間のバインディング関係を作成します。これにより、増分データと完全データの自動同期とインデックス作成が可能になります。 |
| GetBinding | GetBinding | 特定のデータセットと Object Storage Service (OSS) バケット間の紐付け関係をクエリします。 |
| ListBindings | バインディングのリストを照会します | データセットと Object Storage サービス (OSS) バケット間のバインディングのリストを照会します。 |
| DeleteBinding | DeleteBinding | データセットと Object Storage Service (OSS) バケット間のバインディングを削除します。 |
| AttachOSSBucket | AttachOSSBucket | 指定されたプロジェクトに Object Storage Service (OSS) バケットをバインドします。このバインドにより、x-oss-process パラメーターを用いて Intelligent Media Management (IMM) の機能を利用できるようになります。 |
| DetachOSSBucket | DetachOSSBucket | 対応するプロジェクトから Object Storage Service (OSS) バケットをバインド解除します。 |
| GetOSSBucketAttachment | OSS バケットのバインド情報を取得します | 同じリージョン内の指定された OSS バケットにバインドされたプロジェクトのプロジェクト名を取得します。 |
画像処理
|
API |
タイトル |
説明 |
| EncodeBlindWatermark | EncodeBlindWatermark | ブラインドウォーターマークとして、特定のテキスト情報をイメージに埋め込みます。このウォーターマークは視覚的に認識できず、イメージの美観や元データの完全性には影響しません。ウォーターマークは、CreateDecodeBlindWatermarkTask 操作を使用して抽出できます。 |
| CreateDecodeBlindWatermarkTask | CreateDecodeBlindWatermarkTask | ブラインドウォーターマークを抽出します。 |
| GetDecodeBlindWatermarkResult | GetDecodeBlindWatermarkResult | 不可視ウォーターマーク解析タスクの結果を照会します。 |
| DetectImageLabels | DetectImageLabels | 画像内のシーン、オブジェクト、およびイベントに関する情報を検出します。シーン情報には、自然景観、日常生活、災害などが含まれます。イベント情報には、タレントショー、オフィスイベント、パフォーマンス、制作イベントなどが含まれます。オブジェクト情報には、食器、電子機器、家具、交通機関などが含まれます。DetectImageLabels 操作は、30 以上のカテゴリおよび数千のラベルをサポートしています。 |
| DetectImageScore | DetectImageScore | 構図、輝度、コントラスト、色、解像度などのメトリックに基づいて、画像の美的品質スコアを計算します。この操作は 0 から 1 の範囲のスコアを返します。スコアが高いほど、画質が良いことを示します。 |
| DetectImageCodes | DetectImageCodes | 画像内のバーコードおよび QR コードを検出します。 |
| DetectImageFaces | DetectImageFaces | この API は、画像から顔を検出し、顔の境界情報、属性、および品質情報を取得します。境界情報には、頂点の y 座標から画像上端までの距離（Top）、頂点の x 座標から画像左端までの距離（Left）、高さ（Height）、幅（Width）が含まれます。顔の属性には、年齢（Age）、年齢の標準偏差（AgeSD）、性別（Gender）、感情（Emotion）、口の開閉状態（Mouth）、ひげの有無（Beard）、帽子の着用有無（Hat）、マスクの着用有無（Mask）、眼鏡の着用有無（Glasses）、頭部の向き（HeadPose）、魅力度（Attractive）、および各属性に対する信頼度（Confidence）が含まれます。品質情報には、顔品質スコア（FaceQuality）および解像度（Sharpness）が含まれます。 |
| DetectImageCropping | AI モデル機能を使用して最適なイメージクロッピングリージョンを検出します | AI モデル機能を使用して、指定された縦横比でイメージ内の視覚的に最適なクロッピングリージョンを検出します。 |
| AddImageMosaic | AddImageMosaic | 画像内の1つ以上の領域にモザイク、ガウスぼかし、または単色図形を追加してプライバシー保護のためにぼかしをかけ、出力画像を Object Storage Service (OSS) の指定されたパスに保存します。 |
| CreateImageToPDFTask | CreateImageToPDFTask | 複数の画像を 1 つの PDF ファイルに変換し、指定された OSS オブジェクトとして保存します。 |
| CreateImageSplicingTask | CreateImageSplicingTask | 指定されたルールに基づいて複数の画像を 1 つの画像に連結し、出力を指定された OSS オブジェクトに保存します。 |
| CompareImageFaces | CompareImageFaces | 2 枚の画像に含まれる最大の顔同士の類似度を比較します。ここで「最大の顔」とは、顔検出後に得られる画像内の最も大きな顔フレームを指します。 |
| DetectImageBodies | DetectImageBodies | 画像内の信頼度レベルや人体バウンディングボックスなどの人体情報を検出します。 |
| DetectImageCars | DetectImageCars | 画像内の車両の輪郭データ、属性、およびナンバープレート情報を検出します。車両属性には、車両の色 (CarColor) と車両タイプ (CarType) が含まれます。ナンバープレート情報には、認識内容 (Content) とプレートフレーム (Boundary) が含まれます。 |
| DetectImageTexts | DetectImageTexts | イメージからテキストコンテンツを認識し、抽出します。 |
メディア処理
|
API |
タイトル |
説明 |
| CreateMediaConvertTask | Create Media Transcoding Task | 非同期のメディアトランスコーディングタスクを作成します。このタスクは、メディアトランスコーディング、メディア連結、ビデオフレームキャプチャ、およびアニメーション GIF 生成のために、音声ファイルと動画ファイルを処理します。 |
| DetectMediaMeta | DetectMediaMeta | メディアのフォーマットやストリーム情報などのメディアメタデータを照会します。 |
| CreateVideoLabelClassificationTask | CreateVideoLabelClassificationTask | 動画コンテンツ内のシナリオ、オブジェクト、イベントのラベルを検出します。この機能は、30 以上のカテゴリと数千のラベルをサポートしています。シナリオラベルには、自然風景、生活シーン、災害シーンなどがあります。イベントラベルには、タレントショー、オフィスワーク、パフォーマンス、制作などがあります。オブジェクトラベルには、食器、電子製品、家具、車両などがあります。 |
| GetVideoLabelClassificationResult | 動画ラベル検出タスクを取得します | 動画ラベル検出タスクの結果を取得します。 |
| GenerateVideoPlaylist | GenerateVideoPlaylist | ビデオファイルからライブトランスコーディング用のプレイリストを生成します。出力は M3U8 ファイルで、再生の進行状況に基づいて即時再生とオンデマンドトランスコーディングを可能にします。オフラインのトランスコーディングと比較して、このメソッドはトランスコーディングの待機時間を大幅に短縮し、トランスコーディングとストレージのオーバーヘッドを削減します。 |
| CreateHighlightTask | 動画ハイライトクリッピングタスクを作成します | 動画ハイライトタスクを作成します。この特徴は招待プレビュー中です。 |
ドキュメント処理
|
API |
タイトル |
説明 |
| GenerateWebofficeToken | Weboffice 認証情報を取得します | ドキュメントのプレビューおよび編集の認証情報を取得します。 |
| RefreshWebofficeToken | Weboffice トークンをリフレッシュします | Weboffice アクセストークンをリフレッシュします。Weboffice アクセストークンの有効期間は 30 分です。有効期限が切れると、Weboffice にアクセスできなくなります。Weboffice へのアクセスを継続するには、この操作を呼び出して Weboffice アクセストークンをリフレッシュし、同様に 30 分間有効な新しいトークンを取得します。 |
| CreateOfficeConversionTask | CreateOfficeConversionTask | Object Storage Service (OSS) に保存されている Word、PowerPoint、Excel、PDF などのドキュメントを、画像、テキストファイル、または PDF ファイルに変換するドキュメント変換タスクを作成します。 |
| ExtractDocumentText | Extract Document Text | ドキュメントからテキストを抽出します |
ファイル処理
|
API |
タイトル |
説明 |
| 圧縮と展開 | 圧縮と展開 | |
| CreateFileCompressionTask | CreateFileCompressionTask | パッケージダウンロード API |
| CreateArchiveFileInspectionTask | CreateArchiveFileInspectionTask | ファイルを解凍せずに圧縮ファイルを検査し、その内容のリストを取得するタスクを作成します。 |
| CreateFileUncompressionTask | CreateFileUncompressionTask | ファイル解凍タスクを使用すると、特定のファイルまたは圧縮パッケージ全体を指定した場所に解凍できます。サポートされているフォーマットは、Zip、RAR、7z です。 |
| 点群圧縮 | 点群圧縮 | |
| CreateCompressPointCloudTask | CreateCompressPointCloudTask | 点群圧縮機能は、Object Storage Service (OSS) 内の点群データを圧縮します。これにより、ネットワーク経由のデータ伝送量を削減できます。 |
コンテンツセキュリティ
|
API |
タイトル |
説明 |
| DetectTextAnomaly | DetectTextAnomaly | 指定されたテキストに、ポルノ、広告、過剰なジャンクコンテンツ、政治的にデリケートなコンテンツ、罵倒などの異常が含まれているかどうかを検出します。 |
| CreateImageModerationTask | CreateImageModerationTask | ポルノ、テロ、不適切なシーン、ロゴ、画像内テキスト違反などの違反コンテンツを画像から検出します。 |
| CreateVideoModerationTask | CreateVideoModerationTask | 動画内の脅威やコンプライアンス違反のコンテンツを検出します。 この操作は、ポルノ検出、テロ・政治的に敏感なコンテンツの検出、テキスト・画像違反の検出、不快なシーンの検出、ロゴ検出などのシナリオで使用できます。 |
| GetImageModerationResult | イメージコンテンツモデレーションタスクを取得します | イメージコンテンツモデレーションタスクを取得します。 |
| GetVideoModerationResult | 動画コンテンツモデレーションタスクの取得 | 動画コンテンツモデレーションタスクを取得します。 |
タスク管理
|
API |
タイトル |
説明 |
| GetTask | タスク情報を取得します | 指定された非同期タスクの情報をクエリします。Intelligent Media Management (IMM) はさまざまな非同期データ処理機能をサポートしており、それぞれに独自のタスク作成操作があります。例えば、人物クラスタリングタスクを作成する CreateFigureClusteringTask や、ファイル圧縮タスクを作成する CreateFileCompressionTask などがあります。この操作は、タスク ID とタイプによって非同期タスクの詳細をクエリできる汎用操作です。 |
| ListTasks | ListTasks | 時間範囲やタグなど、特定の条件に基づいてタスクをリスト表示します。 |
| トリガー | トリガー | |
| CreateTrigger | CreateTrigger | Intelligent Media Management (IMM) でのデータ処理を開始するためのトリガーを作成します。このトリガーは、Object Storage Service (OSS) などのイベントソースによってアクティブ化され、データ処理テンプレートを使用して、イメージ、ビデオ、ドキュメントなどのメディアファイルを処理します。 |
| SuspendTrigger | SuspendTrigger | 実行中のトリガーを一時停止します。 |
| ResumeTrigger | ResumeTrigger | 一時停止または失敗状態のトリガーを再開します。 |
| UpdateTrigger | UpdateTrigger | トリガーの情報（例：入力データソース、データ処理設定、カスタムタグなど）を更新します。 |
| GetTrigger | GetTrigger | トリガーの情報を照会します。 |
| ListTriggers | ListTriggers | タグまたは状態別にトリガーを照会します。 |
| DeleteTrigger | DeleteTrigger | トリガーを削除します。 |
| バッチ処理 | バッチ処理 | |
| CreateBatch | CreateBatch | 複数の既存ファイルに対して、トランスコードやフォーマット変換などの指定された操作を実行するバッチ処理タスクを作成します。 |
| SuspendBatch | SuspendBatch | バッチ処理タスクを一時停止します。 |
| ResumeBatch | ResumeBatch | 一時停止中または失敗状態にあるバッチ処理タスクを再開します。 |
| UpdateBatch | UpdateBatch | データソース構成、データ処理構成、タグなどのバッチ処理タスクの情報を更新します。 |
| ListBatches | ListBatches | バッチ処理タスクをクエリします。タスクのタグやステータスなどの条件に基づいてバッチ処理タスクをクエリでき、結果をソートすることも可能です。 |
| GetBatch | GetBatch | バッチ処理タスクの情報を照会します。 |
| DeleteBatch | DeleteBatch | バッチ処理タスクを削除します。 |
その他
|
API |
タイトル |
説明 |
| ContextualAnswer | Q\&A API in AI Assistant | AI Assistant の Phase II、Q&A API |
| ContextualRetrieval | ContextualRetrieval | 意味的に類似したドキュメントを取得します。この操作はマルチターン対話向けに設計されており、過去の会話のメッセージ入力を処理できます。コンテキストコンテンツを深く理解することで、現在の会話に密接に関連する結果を返します。マルチターン対話において、一貫性のある効率的な情報取得を実現します。 |
| CreateDataset | Create Dataset | データセットを作成します。 |
| CreateProject | プロジェクトの作成 | プロジェクトを作成します。 |
| DeleteDataset | DeleteDataset | データセットを削除します。 |
| DeleteProject | DeleteProject | プロジェクトを削除します。 |
| GetDataset | GetDataset | データセットをクエリします。 |
| GetProject | プロジェクト情報を照会します。 | 指定されたプロジェクトの情報（基本情報やデータセットおよびファイルに関連する統計情報を含む）を照会します。 |
| ListAttachedOSSBuckets | List OSS Bucket Binding Relationships | 紐付けられた添付ファイルの一覧 |
| ListDatasets | ListDatasets | データセットのリストを照会します。データセットのプレフィックスを指定して照会することもできます。 |
| ListProjects | すべてのプロジェクト情報を照会します | データセットやファイルに関する基本情報および統計情報を含む、すべてのプロジェクトの情報を照会します。 |
| UpdateDataset | Update Dataset | データセットの情報を更新します。 |
| UpdateProject | プロジェクトを更新します | 作成済みプロジェクトの情報を更新します。 |