文档 Experience Platform Intelligent Services 指南

在Attribution AI中下载分数

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
归因人工智能

创建对象：

用户

本文档可用作下载Attribution AI得分的指南。

快速入门

Attribution AI允许您以Parquet文件格式下载得分。本教程要求您已阅读并完成快速入门指南中的Attribution AI得分下载部分。

此外，要访问Attribution AI得分，您需要具有成功运行状态的服务实例。要创建新的服务实例，请访问Attribution AI用户指南。如果您最近创建了一个服务实例，但该实例仍在训练和评分中，请留出24小时以使它完成运行。

查找您的数据集ID dataset-id

在用于Attribution AI分析的服务实例中，单击右上角导航中的 更多操作 下拉列表，然后选择 访问得分。

更多操作

此时将显示一个新对话框，其中包含指向下载得分文档的链接以及当前实例的数据集ID。将数据集ID复制到剪贴板中，然后继续执行下一步。

数据集ID

检索您的批次ID retrieve-your-batch-id

使用上一步中的数据集ID，您需要调用目录API以检索批次ID。此API调用使用附加查询参数来返回最新的成功批次，而不是返回属于您组织的批次列表。要返回其他批次，请将limit查询参数的数字增加到您希望返回的所需数量。有关可用查询参数类型的详细信息，请访问有关使用查询参数筛选目录数据的指南。

API格式

GET /batches?&dataSet={DATASET_ID}&createdClient=acp_foundation_push&status=success&orderBy=desc:created&limit=1

参数

描述

{DATASET_ID}

“访问得分”对话框中可用的数据集ID。

请求

curl -X GET 'https://platform.adobe.io/data/foundation/catalog/batches?&dataSet=5e8f81ce7a4ecb18a8d25b22&createdClient=acp_foundation_push&status=success&orderBy=desc:created&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功的响应会返回包含批次ID对象的有效负载。在此示例中，返回对象的键值是批次ID 01E5QSWCAASFQ054FNBKYV6TIQ。复制您的批次ID以用于下一个API调用。

NOTE

以下响应已重新构建tags对象以提高可读性。

{
    "01E5QSWCAASFQ054FNBKYV6TIQ": {
        "status": "success",
        "tags": {
            "Tags": [ ... ],
        },
        "relatedObjects": [
            {
                "type": "dataSet",
                "id": "5e8f81cf7a4ecb28a8d85b22"
            }
        ],
        "id": "01E5QSWCAASFQ054FNBKYV6TIQ",
        "externalId": "01E5QSWCAASFQ054FNBKYV6TIQ",
        "replay": {
            "predecessors": [
                "01E5N7EDQQP4JHJ93M7C3WM5SP"
            ],
            "reason": "Replacing for 2020-04-09",
            "predecessorListingType": "IMMEDIATE"
        },
        "inputFormat": {
            "format": "parquet"
        },
        "imsOrg": "412657965Y566A4A0A495D4A@AdobeOrg",
        "started": 1586715571808,
        "metrics": {
            "partitionCount": 1,
            "outputByteSize": 2380339,
            "inputFileCount": -1,
            "inputByteSize": 2381007,
            "outputRecordCount": 24340,
            "outputFileCount": 1,
            "inputRecordCount": 24340
        },
        "completed": 1586715582735,
        "created": 1586715571217,
        "createdClient": "acp_foundation_push",
        "createdUser": "sensei_exp_attributionai@AdobeID",
        "updatedUser": "acp_foundation_dataTracker@AdobeID",
        "updated": 1586715583582,
        "version": "1.0.5"
    }
}

使用您的批次ID检索下一个API调用 retrieve-the-next-api-call-with-your-batch-id

获得批次ID后，您便能够向/batches发出新的GET请求。该请求会返回用作下一个API请求的链接。

API格式

GET batches/{BATCH_ID}/files

参数

描述

{BATCH_ID}

在上一步中检索的批次ID 检索您的批次ID。

请求

使用您自己的批次ID提出以下请求。

curl -X GET 'https://platform.adobe.io/data/foundation/export/batches/01E5QSWCAASFQ054FNBKYV6TIQ/files' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功的响应返回包含_links对象的有效负载。在_links对象中，有一个值为新API调用的href。复制此值以继续执行下一步。

{
    "data": [
        {
            "dataSetFileId": "01E5QSWCAASFQ054FNBKYV6TIQ-1",
            "dataSetViewId": "5e8f81cf7a4ecb28a8d85b22",
            "version": "1.0.0",
            "created": "1586715582571",
            "updated": "1586715582571",
            "isValid": false,
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/files/01E5QSWCXXYFQ054FNBKYV2BAQ-1"
                }
            }
        }
    ],
    "_page": {
        "limit": 100,
        "count": 1
    }
}

检索文件 retrieving-your-files

使用上一步中获取的href值作为API调用，发出新的GET请求以检索文件目录。

API格式

GET files/{DATASETFILE_ID}

参数

描述

{DATASETFILE_ID}

从上一步的href值中返回了dataSetFile ID。它也可以在data数组中的对象类型dataSetFileId下访问。

请求

curl -X GET 'https://platform.adobe.io/data/foundation/export/files/01E5QSWCAASFQ054FNBKYV6TIQ-1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

响应包含一个数据数组，该数据数组可能有一个条目或属于该目录的文件列表。以下示例包含文件列表，并且已经过压缩以提高可读性。在此方案中，您需要跟踪每个文件的URL才能访问该文件。

{
    "data": [
        {
            "name": "part-00000-tid-5614147572541837832-908bd66a-d856-47fe-b7da-c8e7d22a4097-1370467-1.c000.snappy.parquet",
            "length": "2380211",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/files/01E5QSWCXXYFQ054FNBKYV2BAQ-1?path=part-00000-trd-5714147572541837832-938bd66a-d556-41fe-b7da-c8e7d22a4097-1320467-1.c000.snappy.parquet"
                }
            }
        }
    ],
    "_page": {
        "limit": 100,
        "count": 1
    }
}

参数

描述

_links.self.href

用于下载目录中文件的GET请求URL。

复制data数组中任何文件对象的href值，然后继续执行下一步。

下载您的文件数据

要下载文件数据，请对您在上一步中复制的"href"值检索文件发出GET请求。

NOTE

如果您直接在命令行中发出此请求，则可能会提示您在“请求标头”后添加输出。以下请求示例使用--output {FILENAME.FILETYPE}。

API格式

GET files/{DATASETFILE_ID}?path={FILE_NAME}

参数

描述

{DATASETFILE_ID}

从上一步的href值中返回了dataSetFile ID。

{FILE_NAME}

文件的名称。

请求

curl -X GET 'https://platform.adobe.io:443/data/foundation/export/files/01E5QSWCXXYFQ054FNBKYV2BAQ-1?path=part-00000-trd-5714147572541837832-938bd66a-d556-41fe-b7da-c8e7d22a4097-1320467-1.c000.snappy.parquet' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -O 'file.parquet'