Content and Commerce AI 是测试版。 文档可能会发生更改。
当给定图像时,视觉相似性服务会自动从目录中查找视觉上相似的图像。
本文档中显示的示例请求使用了下图:
API格式
POST /services/v1/predict
请求
以下请求基于有效负载中提供的输入参数从目录中检索视觉上相似的图像。 有关所示输入参数的更多信息,请参阅有效负载示例下表。
analyzer_id
确定 Sensei Content Framework 中,将使用。 请检查您是否拥有 analyzer_id
之前。 请联系内容和商务AI测试版团队,以接收您的 analyzer_id
为此服务。
curl -i -X POST https://sensei.adobe.io/services/v1/predict \
-H 'Authorization: Bearer $API_TOKEN' \
-H 'Content-Type: multipart/form-data' \
-H 'cache-control: no-cache,no-cache' \
-H 'x-api-key: $API_KEY' \
-F file=@test_image.jpg \
-F 'contentAnalyzerRequests={
"enable_diagnostics":"true",
"requests":[
{
"analyzer_id": "Feature:cintel-deep-product-search:Service-316a8cf750c6440396061c8f73a7a585",
"parameters": {
"application-id": "1234",
"content-type": "inline",
"encoding": "jpeg",
"threshold": "0",
"top-N": "0",
"custom": {},
"data": [{
"content-id": "0987",
"content": "inline-image",
"content-type": "inline",
"encoding": "jpeg",
"threshold": "0",
"top-N": "0",
"historic-metadata": [],
"custom": {}
}]
}
}
]
}'
属性 | 描述 | 必需 |
---|---|---|
analyzer_id |
的 Sensei 请求部署在下的服务ID。 此ID确定 Sensei Content Frameworks 中,将使用。 对于自定义服务,请联系内容和商务AI团队以设置自定义ID。 | 是 |
application-id |
创建的应用程序的ID。 | 是 |
data |
一个数组,其中包含一个JSON对象,该对象在数组中的每个对象都表示一个图像。 作为此数组的一部分传递的任何参数都会覆盖在 data 数组。 下表中列出的任何其余属性都可以从中覆盖 data . |
是 |
content-id |
响应中返回的数据元素的唯一ID。 如果未传递,则会分配一个自动生成的ID。 | 否 |
content |
要由视觉相似性服务分析的内容。 如果图像是请求正文的一部分,请使用 -F file=@<filename> 在用于传递图像的curl命令中,将此参数保留为空字符串。 如果图像是S3上的文件,请传递带签名的url。 当内容是请求正文的一部分时,数据元素列表应该只有一个对象。 如果传递了多个对象,则仅处理第一个对象。 |
是 |
content-type |
用于指示输入是请求正文的一部分还是S3存储段的带符号的url。 此属性的默认值为 inline . |
否 |
encoding |
输入图像的文件格式。 当前只能处理JPEG和PNG图像。 此属性的默认值为 jpeg . |
否 |
threshold |
需要返回结果的分数阈值(0到1)。 使用值 0 返回所有结果。 此属性的默认值为 0 . |
否 |
top-N |
要返回的结果数(不能是负整数)。 使用值 0 返回所有结果。 与 threshold ,则返回的结果数是任一限制集中的较小者。 此属性的默认值为 0 . |
否 |
custom |
要传递的任何自定义参数。 | 否 |
historic-metadata |
可以传递元数据的数组。 | 否 |
响应
成功的响应会返回 response
包含 feature_value
和 feature_name
目录中找到的每个视觉上相似的图像。
在以下示例响应中返回了以下视觉上相似的图像:
{
"status": 200,
"content_id": "test_image.jpg",
"cas_responses": [
{
"status": 200,
"analyzer_id": "Feature:cintel-deep-product-search:Service-316a8cf750c6440396061c8f73a7a585",
"content_id": "test_image.jpg",
"result": {
"response_type": "feature",
"response": [
{
"feature_value": [
{
"feature_value": "678",
"feature_name": "G34WS945.F1"
},
{
"feature_value": "678",
"feature_name": "1431RDM JANELLE RAW JACKE"
},
{
"feature_value": "657",
"feature_name": "GF4045877841 CARLA FLR"
},
{
"feature_name": "1707-686-SGU PATCH XYZ",
"feature_value": "657"
},
{
"feature_name": "5495MJT AJA BLK",
"feature_value": "646"
},
{
"feature_name": "IDEAL",
"feature_value": "645"
},
{
"feature_value": "644",
"feature_name": "HCAJRA439 CALI JEAN"
},
{
"feature_name": "KT279RK-ONL",
"feature_value": "644"
},
{
"feature_name": "SP190404-ELLIS",
"feature_value": "642"
},
{
"feature_name": "GF4174848718 KENDALL DIS",
"feature_value": "640"
}
],
"feature_name": "visual_similarity"
}
]
}
}
],
"error": []
}