Attribution AIでのスコアのダウンロード
このドキュメントは、Attribution AIのスコアをダウンロードするためのガイドとして機能します。
はじめに
Attribution AIを使用すると、スコアを Parquet ファイル形式でダウンロードできます。 このチュートリアルでは、 はじめにガイドのAttribution AIスコアのダウンロードの節を読み、完了している必要があります。
さらに、Attribution AIのスコアにアクセスするには、実行ステータスが成功したサービスインスタンスが必要です。 新しいサービス インスタンスを作成するには、Attribution AI ユーザーガイドを参照してください。 サービスインスタンスを作成したばかりで、まだトレーニングとスコア測定を行っている場合は、実行が終了するまで 24 時間お待ちください。
データセット ID の検索 dataset-id
Attribution AIインサイトのサービスインスタンス内で、右上のナビゲーションにある その他のアクション ドロップダウンをクリックし、「スコアにアクセス」を選択します。
新しいダイアログが表示され、スコアのダウンロードに関するドキュメントへのリンクと、現在のインスタンスのデータセット ID が示されます。データセット ID をクリップボードにコピーして、次の手順に進みます。
バッチ ID を取得する retrieve-your-batch-id
前の手順のデータセット ID を使用する場合、バッチ ID を取得するには、Catalog API を呼び出す必要があります。 この API 呼び出しには、追加のクエリパラメーターが使用され、組織に属するバッチのリストではなく、成功した最新のバッチが返されます。 追加のバッチを返すには、limit
クエリパラメーターの数値を、返したい金額に増やします。 使用可能なクエリパラメーターの種類について詳しくは、クエリパラメーターを使用したカタログデータのフィルタリングに関するガイドを参照してください。
API 形式
GET /batches?&dataSet={DATASET_ID}&createdClient=acp_foundation_push&status=success&orderBy=desc:created&limit=1
{DATASET_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 呼び出しで使用します。
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 を使用して、次のリクエストを実行します。
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}
リクエスト
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
data
配列内のファイルオブジェクトの href
値をコピーして、次の手順に進みます。
ファイルデータをダウンロードする
ファイルデータをダウンロードするには、前の手順(ファイルの取得)でコピーした "href"
値に対して GET リクエストを実行します。
--output {FILENAME.FILETYPE}
を使用しています。API 形式
GET files/{DATASETFILE_ID}?path={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'
応答
現在のディレクトリにある、要求したファイルがダウンロードされます。この例では、ファイル名は「file.parquet」です。
ダウンロードされたスコアは Parquet 形式になり、スコアを表示するには Spark シェルまたは Parquet リーダーが必要になります。 生のスコア表示の場合は、Apache Parquet ツールを使用できます。 Parquet ツールは、Spark でデータを分析できます。
次の手順
このドキュメントでは、Attribution AIスコアのダウンロードに必要な手順について説明しました。 スコア出力について詳しくは、 属性 AI 入力および出力ドキュメントを参照してください。
Snowflakeを使用したスコアへのアクセス
Snowflakeを通じて集計Attribution AIスコアにアクセスできます。 現在、Snowflake のリーダーアカウントを設定して、その資格情報を受け取るには、アドビサポート(attributionai-support@adobe.com)に電子メールでお問い合わせいただく必要があります。
アドビサポートがリクエストを処理すると、Snowflake のリーダーアカウントの URL と、それに対応する資格情報が提供されます(以下を参照)。
- Snowflake URL
- ユーザー名
- パスワード
資格情報と URL を取得したら、タッチポイント日またはコンバージョン日によって集計されたモデルテーブルをクエリできます。
Snowflake でスキーマを探す
提供された資格情報を使用して、Snowflake にログインします。左上のメインナビゲーションの「Worksheets」タブをクリックし、左パネルのデータベースディレクトリに移動します。
次に、画面右上の「Select Schema」をクリックします。表示されるポップオーバーで、適切なデータベースが選択されていることを確認します。次に、「スキーマ」ドロップダウンをクリックし、リストからいずれかのスキーマを選択します。選択したスキーマの下に表示されるスコアテーブルから直接照会できます。
PowerBI を Snowflake に接続する(オプション)
Snowflake の資格情報を使用して、PowerBI Desktop と Snowflake データベース間の接続を設定できます。
まず、「サーバー」ボックスに、Snowflake の URL を入力します。次に、「Warehouse」に「XSMALL」と入力します。ユーザー名とパスワードを入力します。
接続が確立されたら、Snowflake データベースを選択し、適切なスキーマを選択します。これで、すべてのテーブルを読み込むことができます。