Method: projects.locations.corpora.indexes.viewAssets

列出索引中的资产列表。

HTTP 请求

GET https://visionai.googleapis.com/v1/{index=projects/*/locations/*/corpora/*/indexes/*}:viewAssets

网址采用 gRPC 转码语法。

路径参数

参数
index

string

必需。拥有此素材资源集合的索引。格式:projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

查询参数

参数
pageSize

integer

要返回的资产数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个素材资源。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

pageToken

string

从之前的 indexes.viewAssets 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 indexes.viewAssets 的所有其他参数必须与提供页面令牌的调用匹配。

filter

string

应用于返回列表的过滤条件。仅支持以下过滤条件:“assetId = xxxx”,用于返回指定 ID 的素材资源。“assetId = xxxx, yyyy, zzzz”,用于返回具有指定 ID 的素材资源。

请求正文

请求正文必须为空。

响应正文

indexes.viewAssets 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "indexedAssets": [
    {
      object (IndexedAsset)
    }
  ],
  "nextPageToken": string
}
字段
indexedAssets[]

object (IndexedAsset)

指定索引中的素材资源。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

IAM 权限

需要拥有 index 资源的以下 IAM 权限:

  • visionai.indexes.viewAssets

如需了解详情,请参阅 IAM 文档

IndexedAsset

IndexedAsset 是索引的构建基础。

JSON 表示法
{
  "index": string,
  "asset": string,
  "createTime": string,
  "updateTime": string
}
字段
index

string

必需。此编入索引的素材资源所属的索引。格式:projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

asset

string

必需。资源的资源名称。格式:projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}

createTime

string (Timestamp format)

仅限输出。创建时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。更新时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"