データセットファイルのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
paidataset:ListDatasetFileMetas |
list |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v1/datasets/{DatasetId}/datasetfilemetas HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DatasetId |
string |
必須 |
データセットの ID。データセット ID を取得する方法については、「 ListDatasets 」を参照してください。 |
d-rbvg5*****jhc9ks92 |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DatasetVersion |
string |
必須 |
データセットのバージョン名。 |
v1 |
| WorkspaceId |
string |
必須 |
データセットのワークスペース ID。ワークスペース ID を取得する方法については、「 ListWorkspaces 」を参照してください。 |
105173 |
| QueryType |
string |
任意 |
取得タイプ。有効な値:
列挙値:
|
MIX |
| QueryText |
string |
任意 |
検索するテキストコンテンツ。 |
A fallen water |
| TopK |
integer |
任意 |
返される結果の最大値。上位 K 件の結果のみが返されます。 説明
このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。 |
100 |
| ScoreThreshold |
number |
任意 |
類似度スコアのしきい値。ScoreThreshold より大きいスコアを持つ結果のみが返されます。 説明
このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。 |
0.6 |
PageSize
deprecated
|
integer |
任意 |
1 ページあたりのエントリ数。MaxResults も指定されている場合は、MaxResults が優先されます。 説明
このパラメーターはまもなく廃止されます。ページングクエリを実行するには、NextToken と MaxResults を使用してください。 |
10 |
| NextToken |
string |
任意 |
ページネーショントークン。 説明
このパラメーターが指定されていない場合は、データの最初のページが返されます。このパラメーターに対して値が返された場合は、さらにページが存在します。返された NextToken 値をリクエストパラメーターとして渡して次のページを取得します。NextToken 値が返されなくなるまでこれを繰り返すと、すべてのデータが取得されたことを示します。 |
90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000 |
| SortBy |
string |
任意 |
ページングクエリのソートフィールド。デフォルトでは、結果は取得の関連性に基づいて降順でソートされます。その他の有効な値:
列挙値:
|
FileCreateTime |
| Order |
string |
任意 |
ページングクエリで指定されたソートフィールドのソート順序。SortBy と一緒に使用します。デフォルト値: DESC。有効な値:
列挙値:
|
DESC |
| EndFileUpdateTime |
string |
任意 |
クエリのファイル更新時間の範囲の開始時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。 |
2025-01-12T14:36:01.000Z |
| StartFileUpdateTime |
string |
任意 |
クエリのファイル更新時間の範囲の終了時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。 |
2025-01-12T14:36:01.000Z |
| QueryImage |
string |
任意 |
イメージ検索用のイメージ情報。
説明
このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。 |
oss://test-xxx-oss/car/0001.png |
| ThumbnailMode |
string |
任意 |
イメージのサムネイルモード。現在、サムネイルをサポートしているのは OSS ファイルのみです:
|
w_100 |
| DatasetFileMetaIds |
array |
任意 |
クエリ対象のメタデータ ID のリスト。 |
|
|
string |
任意 |
メタデータ ID。 |
5dc037c8ec0a6fc4e15741328e531bbee036exxxxxxxxx722eff66c38a90e08c |
|
| QueryTagsIncludeAll |
array |
任意 |
「以下のすべてのタグを含む」の検索条件。複数のタグを選択でき、クエリ結果はすべてのタグと一致する必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。 説明
このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。QueryType が TAG に設定されている場合、QueryText の値がこの条件に追加されます。 |
|
|
string |
任意 |
タグ名。 |
Lane line |
|
| QueryTagsIncludeAny |
array |
任意 |
「以下のいずれかのタグを含む」の検索条件。複数のタグを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。 説明
このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。 |
|
|
string |
任意 |
タグ名。 |
Lane line |
|
| QueryTagsExclude |
array |
任意 |
「以下のタグを除外する」の検索条件。複数のタグを選択でき、クエリ結果にはそのいずれも含めることはできません。このパラメーターが空の場合、この条件は適用されません。 説明
このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。 |
|
|
string |
任意 |
タグ名。 |
Lane line |
|
| QueryFileName |
string |
任意 |
ファイル名の検索条件。あいまい一致がサポートされています。 |
car |
| QueryFileDir |
string |
任意 |
ファイルディレクトリの検索条件。あいまい一致がサポートされています。 |
cars/20250221/ |
| QueryFileTypeIncludeAny |
array |
任意 |
「以下のいずれかのファイルタイプを含む」の検索条件。複数のファイルタイプを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。 |
|
|
string |
任意 |
ファイルタイプ。 |
イメージ |
|
| QueryContentTypeIncludeAny |
array |
任意 |
「以下のいずれかのコンテンツタイプを含む」の検索条件。複数のコンテンツタイプを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。 |
|
|
string |
任意 |
ファイルコンテンツタイプ。 |
イメージ/jpeg |
|
| StartTagUpdateTime |
string |
任意 |
クエリのタグ最終更新時間の範囲の開始時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。 |
2025-01-12T14:36:01.000Z |
| EndTagUpdateTime |
string |
任意 |
クエリのタグ最終更新時間の範囲の終了時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。 |
2025-01-12T14:36:01.000Z |
| MaxResults |
integer |
任意 |
NextToken ベースのページングを使用する場合の、リクエストごとに返される結果の最大値。有効な値: 1 から 100。デフォルト値: 10。 |
10 |
| QueryExpression |
string |
任意 |
検索文 (DSL) は、複雑な取得条件を表現するためのレルム固有の言語です。グループ化、ブール値論理 (AND/OR/NOT)、範囲の比較 (>, >=, <, <=)、プロパティの存在チェック (HAS/NOT HAS)、トークン一致 (:)、完全に一致 (=) をサポートしており、高度な取得シナリオに適しています。 このパラメーターは、通常、複雑な高度な取得の条件文に使用されます。 重要 競合を避けるため、この検索文を設定した後は、他のクエリパラメーターと一緒に使用しないでください。 |
(FileUpdateTime > '2025-02-28T00:00:00Z' AND FileUpdateTime < '2025-05-30T09:27:29Z') AND FileDir:'blue_car' AND NOT FileName="toyota.jpg" AND (( Tags.all='lane line' AND Tags.all='barrier gate') OR NOT Tags.user='rainy days' ) AND HAS SemanticIndexJobId AND Content:'a fallen water horse' AND TopK=100 AND SignMode='PUBLIC' |
| Status |
string |
任意 |
クエリ対象のメタデータステータス。有効な値:
列挙値:
|
ACTIVE |
| QueryVideo |
string |
任意 |
動画ベースの検索用の動画ファイル情報。
説明
このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。 |
oss://test-xxx-oss/car/0001.mp4 |
DSL クエリ構文
| キーワード | 説明 | 例 |
| : | トークン一致 | FileName:'lane line'トークン化後にファイル名に "lane line" を含むデータを検索します。 |
| NOT : | トークン除外 | NOT FileName : 'lane line'トークン化後にファイル名に "lane line" を含まないデータを検索します。 |
| = | 完全に一致 | FileType='image'ファイルタイプが完全に "image" であるデータを検索します。 |
| NOT = | 完全除外 | NOT FileType = 'video'FileType が "video" ではないすべてのデータを検索します。 |
| HAS | 存在 | HAS SemanticIndexJobIdSemanticIndexJobId プロパティを持つすべてのデータを検索します。 |
| NOT HAS | 非存在 | NOT HAS SemanticIndexJobIdSemanticIndexJobId プロパティを持たないすべてのデータを検索します。 |
| "" | 文字列値を囲む | 単一引用符と二重引用符は同じ効果を持ちます。 |
| () | グループ化 | (FileName:'black' AND ContentType='image/jpeg') OR (FileName:'white' AND ContentType='image/png')FileName が "black" にあいまい一致し、ContentType が "image/jpeg" であるデータ、または FileName が "white" にあいまい一致し、ContentType が "image/png" であるデータを検索します。 |
| > | 範囲クエリ: より大きい | FileUpdateTime> '2025-01-16T11:52:56.000Z' AND DataSize >= 12345最終変更済み時間が 2025-01-16T11:52:56.000Z 以降で、ファイルサイズが 12345 バイト以上のファイルを検索します。 |
| >= | 範囲クエリ: 以上 | 上記と同じ。 |
| < | 範囲クエリ: より小さい | FileUpdateTime < '2025-01-16T11:52:56.000Z' AND DataSize <= 12345最終変更済み時間が 2025-01-16T11:52:56.000Z 以前で、ファイルサイズが 12345 バイト以下のファイルを検索します。 |
| <= | 範囲クエリ: 以下 | 上記と同じ。 |
| AND | 論理 AND。 大文字と小文字は区別されません。 | FileType='image' AND ContentType:'image/png'ファイルタイプが "image" で、コンテンツフォーマットが "png" のイメージを検索します。 |
| OR | 論理 OR。 大文字と小文字は区別されません。 | FileType='image' OR FileType='video'ファイルタイプが "image" または "video" のデータを検索します。 |
DSL クエリプロパティリファレンス
次の基本ファイルメタデータプロパティ、タグプロパティ、AISearch プロパティ、および一般取得プロパティがサポートされています。 すべてのプロパティは、クエリ条件ではオプションです。
タイプの説明:
KEYWORD: 等しい、等しくない、存在する、存在しないの 1 つ以上をサポートします。
TEXT: トークン一致、トークン除外、等しい、等しくない、存在する、存在しないの 1 つ以上をサポートします。
NUMBER: 範囲クエリ、等しい、存在する、存在しないの 1 つ以上をサポートします。
DATE: 範囲クエリ、存在する、存在しないの 1 つ以上をサポートします。
基本メタデータプロパティ
| プロパティ | 内部タイプ | トークン一致 | トークン除外 | 等しい | 等しくない | 存在する/存在しない | 範囲クエリ | AND 論理 | OR 論理 |
| DatasetFileMetaId | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| FileName | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| FileDir | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| FileType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| ContentType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| DataSize | NUMBER | - | - | ✅ | - | ✅ | ✅ | ✅ | ✅ |
| FileUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |
| SyncTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |
| TagUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |
| SemanticIndexUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |
| Status | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
タグプロパティ
| プロパティ | 内部タイプ | トークン一致 | トークン除外 | 等しい | 等しくない | 存在する/存在しない | 範囲クエリ | AND 論理 | OR 論理 |
| Tags.ai | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| Tags.user | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
| Tags.all | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |
ベクター検索プロパティ
| プロパティ | 内部タイプ | トークン一致 | トークン除外 | 等しい | 等しくない | 存在する/存在しない | 範囲クエリ | AND 論理 | OR 論理 |
| Content | TEXT | ✅ | - | ❌ | ❌ | ❌ | - | ✅ | ❌ |
| TopK | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |
| ScoreThreshold | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |
一般検索プロパティ
| プロパティ | 内部タイプ | トークン一致 | トークン除外 | 等しい | 等しくない | 存在する/存在しない | 範囲クエリ | AND 論理 | OR 論理 |
| QueryType | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| SignMode | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| ThumbnailMode | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| SortBy | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| Order | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| NextToken | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |
| MaxResults | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| TotalCount |
integer |
返されるエントリの総数。 |
123 |
PageSize
deprecated
|
integer |
現在のページサイズ。 |
30 |
| NextToken |
string |
ページネーショントークン。クエリ条件に一致する結果の数がページサイズを超える場合、このページネーショントークンが返されます。データの次のページを取得するには、トークン値が返されなくなるまで、返されたトークン値をリクエストパラメーターとして渡します。トークン値が返されなくなった場合、すべてのデータが取得されたことを示します。 |
90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000 |
| DatasetFileMetas |
array |
データセットファイルメタデータ詳細のリスト。 |
|
| DatasetFileMeta |
データセットファイルメタデータの詳細。 |
||
| DatasetId |
string |
データセットの ID。 |
d-rbvg5*****jhc9ks92 |
| WorkspaceId |
string |
ワークスペースの ID。 |
105173 |
| DatasetVersion |
string |
データセットのバージョン名。 |
v1 |
| MaxResults |
integer |
NextToken ベースのページングを使用する場合の、リクエストごとに返される結果の最大値。 |
10 |
例
成功レスポンス
JSONJSON
{
"TotalCount": 123,
"PageSize": 30,
"NextToken": "90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000",
"DatasetFileMetas": [
{
"DatasetFileMetaId": "07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6",
"Uri": "oss://test-bucket/dataset/cat.png",
"FileName": "cat.png",
"DownloadUrl": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D",
"Score": 0.6,
"DataSize": 120000,
"FileFingerPrint": "D41D8CD98F*****E9800998ECF8",
"FileUpdateTime": "2025-01-12T14:36:01Z",
"Tags": "{\n \"ai\":\n [\n \"Lane line\",\n \"Water horse\",\n \"Sunny day\"\n ],\n \"user\":\n [\n \"Everett\",\n \"Intelligent driving Dataset 1\",\n \"Cloudy day\"\n ],\n \"user-delete-ai-tags\":\n [\n \"Sunny day\"\n ]\n}",
"ThumbnailUrl": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D",
"MetaAttributes": "{ \"ImageHeight\": 400, \"ImageWidth\": 800 }",
"SemanticIndexJobId": "dsjob-klfwtjto****scvt3",
"SemanticIndexUpdateTime": "2021-01-12T14:36:01.000Z",
"FileCreateTime": "2021-01-12T14:36:01.000Z",
"FileType": "イメージ",
"ContentType": "image/jpeg",
"Status": "ACTIVE"
}
],
"DatasetId": "d-rbvg5*****jhc9ks92",
"WorkspaceId": "105173",
"DatasetVersion": "v1",
"MaxResults": 10
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。