币游国际平台

API搜索法

最新更新时间:Nov-06-2023

管理员API搜索方法允许您精密控制过滤并检索产品环境内所有资产的信息,同时帮助查询表达式使用类似Luceen查询语言几个例子说明使用搜索API方法包括:

  • 通过描述性属性搜索,如公共标识文件名、文件夹、标签、上下文等
  • 文件细节搜索,如类型、格式、文件大小、维度等
  • 通过嵌入式数据搜索,如Exif、XMP等
  • 通过分析数据搜索,如表情数、主色数、自动机标签等
  • 请求汇总计数指定参数,例如按文件格式发现的资产数

快速示例

查找图片标签上贴上shirt,这些图片在最后一天上传,尺寸大于1MB响应中按结果排序公共标识下移顺序并限制返回结果为30项资产

cloudinary 1.x
cloudinary.v2.search
  .expression('resource_type:image AND tags=shirt AND uploaded_at>1d AND bytes>1m')
  .sort_by('public_id','desc')
  .max_results(30)
  .execute()
  .then(result=>console.log(result));

阶梯

搜索API能力划分为2级

  • 级位一:包括使用支持搜索方法大选择字段、运算符和搜索语法

  • 二级包括额外搜索功能,包括支持基于图像分析的搜索表达式和嵌入元数据字段以及支持响应中汇总计数信息功能性限二级

权激活和定价

  • 二级搜索API功能自动启动所有产品环境,资产可达1,000万产品环境有或接近一千万资产联系支持.

  • 二级可应请求调用高级计划并高二级提供高级规划额外成本面向企业规划二级功能包含在包价中最多1,000万件资产中(并可用附加成本超过1,000万件资产)。不论账号计划如何,你都必须联系支持请求二级选项

搜索方法

上头币游平台网页版官方查找资源方法管理员API允许您查找产品环境中符合指定标准的具体资产执行搜索使用搜索方法提供参数类精练搜索

所有参数搜索方法可选性,但在多数情况下你至少想添加表达式参数描述查询字符串用Luceen相似查询语言过滤资产查询字符串包含搜索条件,可与布尔运算符合并组成复杂查询也可以限制搜索到特定字段或在所有字段运行查询学习建房查询搜索表达式向导

如果您不包含查找方法调用中的任何参数, 则会按创建时间下降顺序返回最近创建的50项资产 。

注解

搜索示例

  1. 币游平台网页版官方查找所有字段中含有short的资产(属性),包括上下文元数据和标签,并限制返回结果为10项资源:

    cloudinary 1.x
    cloudinary.v2.search
      .expression('shirt')
      .with_field('context')
      .with_field('tags')
      .max_results(10)
      .execute()
      .then(result=>console.log(result));
  2. 查找所有字段中包含shle但标签字段中不包含Blue的资产,按下游排序结果,并计算基于格式字段值的汇总计数:

    cloudinary 1.x
    cloudinary.v2.search
      .expression('shirt AND -tags:blue')
      .sort_by('public_id','desc')
      .aggregate('format')
      .execute()
      .then(result=>console.log(result));
  3. 查找500结果下一页,使用前一调用(b16b8b80426f43a107f260348)中的'ext_cursor',搜索贴有she公共标识下游顺序 :

    cloudinary 1.x
    cloudinary.v2.search
      .expression('resource_type:image AND tags=shirt AND uploaded_at>1d')
      .sort_by('public_id','desc')
      .max_results(500)
      .next_cursor('b16b8bd80426df43a107f26b0348')
      .execute()
      .then(result=>console.log(result));

小技巧
更多例子见 表达式示例文档记录

搜索响应

响应包括全计数匹配查找条件的资产时间轴取处理请求聚合式计数请求(仅二级)和细节币游平台网页版官方)发现

样本JSON响应:

注解
样本响应反映产品环境使用 固定文件夹模式.产品环境使用 动态文件夹模式, 资产文件夹显示名键还包含响应中 。
JSON
{
  "total_count": 32,
  "time": 30,
  "aggregations": {
    "format": {
      "png": 4,
      "jpg": 21,
      "mp4": 3,
      "doc": 4
    }
  },
  "next_cursor": "b16b8bd80426df43a107f26b0348",
  "resources": [
  {
    "asset_id": "5f9d30acd36ac3c4f48a82241a37a299",
    "public_id": "sample",
    "folder": "",
    "filename": "sample",
    "format": "png",
    "version": 1492606756,
    "resource_type": "image",
    "type": "upload",
    "created_at": "2017-04-03T09:56:49+00:00",
    "uploaded_at": "2017-04-19T12:59:16+00:00",
    "bytes": 3381,
    "backup_bytes": 16905,
    "width": 241,
    "height": 51,
    "aspect_ratio": 4.7254901960784315,
    "pixels": 12291,
    "access_control": [       
     { access_type: "token" },
     { access_type: "anonymous", start: "2017-12-15T12:00Z", end: "2018-01-20T12:00Z" }],
    "context": {},
    "image_analysis": { 
      "face_count": 0,
      "faces": [],
      "grayscale": true,
      "illustration_score": 1,
      "transparent": false,
      "colors": {
        "gray": 96.7
      }
    },
    "url": "http://res.www.agrosoland.com/demo/image/upload/v1492606756/sample.png",
    "secure_url": "https://res.www.agrosoland.com/demo/image/upload/v1492606756/sample.png",
    "status": "active",
    "access_mode": "public",
    "last_updated": {
      "access_control_updated_at": "2022-10-13T03:49:21Z",
      "context_updated_at": "2022-11-10T06:05:21Z",
      "metadata_updated_at": "2022-10-14T06:49:13Z",
      "public_id_updated_at": "2022-12-11T05:41:21Z",
      "tags_updated_at": "2022-12-14T06:49:21Z", 
      "updated_at": "2022-12-14T06:49:21Z"
    }
  },
  {
    "public_id": "dog",
     …
     …
  }
}

小技巧
上头 状态响应字段表示资产是否 活动化并随工作交付URL或 未发现if it's删除 并 备份.

反馈发送