Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

객체 집합 집계(Aggregate Object Set) (V2)

ObjectSet 정의로 선택한 객체를 집계합니다. aggregation으로 지표를, groupBy로 그룹을 지정합니다. 정확도가 중요하면 요청의 accuracy 조건과 응답의 accuracy 및 excludedItems를 확인합니다.

집계 함수와 그룹 형식은 객체 유형 집계와 같습니다. includeComputeUsage는 현재 OSDK 애플리케이션 전용이며 운영 환경에서는 권장하지 않습니다.

HTTP 요청

POST /api/v2/ontologies/{ontology}/objectSets/aggregate

작업 식별자는 v2.aggregateObjectSetV2입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:ontologies-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
ontologystring필수온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다.palantir

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
sdkPackageRidstring선택생성된 SDK 패키지의 RID입니다.
sdkVersionstring선택생성된 SDK 패키지의 버전입니다.
branchstring선택집계할 객체를 읽을 Foundry 브랜치입니다. 생략하면 기본 브랜치를 사용합니다. 브랜치는 실험적 기능이며 일부 작업 경로는 지원하지 않습니다.ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252
transactionIdstring선택읽을 온톨로지 트랜잭션 ID입니다. 트랜잭션은 실험적 기능이며 일부 작업 경로는 지원하지 않을 수 있습니다.
scenarioRidstring선택객체를 집계할 온톨로지 시나리오의 RID입니다.ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890
executeInMemoryOnlyboolean선택true이면 메모리 안에서 계산할 수 없는 요청을 오류로 종료합니다. 더 무거운 계산이 필요한 요청을 빠르게 실패시키는 옵션이며 기본값은 false입니다.

요청 본문

본문 형식은 AggregateObjectSetRequestV2이며 필수입니다.

이름자료형필수 여부의미와 조건예시 값
aggregationlist<AggregationV2>선택
objectSetObjectSet필수온톨로지의 객체 집합 정의입니다.
groupBylist<AggregationGroupByV2>선택
accuracyenum선택REQUIRE_ACCURATE는 정확성을 보장할 수 있을 때만 결과를 반환하며, 보장할 수 없으면 AggregationAccuracyNotSupported 오류가 발생합니다. ALLOW_APPROXIMATE는 정확한 계산이 어려울 때 근사 결과를 허용하며 기본 동작입니다. 허용값: REQUIRE_ACCURATE, ALLOW_APPROXIMATE.
includeComputeUsageboolean선택계산 사용량을 응답에 포함할지 지정합니다. 현재 OSDK 애플리케이션에서만 사용할 수 있으며 성능을 낮출 수 있어 운영 환경에서는 권장하지 않습니다.

aggregation의 구조

배열 항목은 AggregationV2이며 자료형은 AggregationV2입니다.

집계 함수입니다.

8개 함수의 필드는 집계 함수를 따릅니다.

objectSet의 구조

전체 정의는 객체 집합 형식을 따릅니다.

groupBy의 구조

배열 항목은 AggregationGroupByV2이며 자료형은 AggregationGroupByV2입니다.

집계 결과의 그룹 구분 방식입니다.

4개 그룹 방식은 그룹 구분을 따릅니다.

Employee 객체 집합을 그룹으로 나누고 tenure의 최솟값과 평균을 계산하는 요청 본문입니다.

{
  "objectSet": {
    "objectType": "Employee",
    "type": "base"
  },
  "aggregation": [
    {
      "field": "tenure",
      "name": "min_tenure",
      "type": "min"
    },
    {
      "field": "tenure",
      "name": "avg_tenure",
      "type": "avg"
    }
  ],
  "groupBy": [
    {
      "field": "startDate",
      "ranges": [
        {
          "endValue": "2020-06-01",
          "startValue": "2020-01-01"
        }
      ],
      "type": "ranges"
    },
    {
      "field": "city",
      "type": "exact"
    }
  ]
}

응답

응답 형식은 AggregateObjectsResponseV2입니다.

전체 응답 구조는 집계 응답을 따릅니다.

그룹별 집계 결과의 응답 예시입니다.

{
  "data": [
    {
      "metrics": [
        {
          "name": "min_tenure",
          "value": 1
        },
        {
          "name": "avg_tenure",
          "value": 3
        }
      ],
      "group": {
        "startDate": {
          "startValue": "2020-01-01",
          "endValue": "2020-06-01"
        },
        "city": "New York City"
      }
    },
    {
      "metrics": [
        {
          "name": "min_tenure",
          "value": 2
        },
        {
          "name": "avg_tenure",
          "value": 3
        }
      ],
      "group": {
        "startDate": {
          "startValue": "2020-01-01",
          "endValue": "2020-06-01"
        },
        "city": "San Francisco"
      }
    }
  ],
  "accuracy": "ACCURATE"
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

온톨로지와 유형 이름, 속성 및 식별자, 브랜치와 시나리오 값은 실제 대상에 맞게 바꿉니다. 기본 브랜치를 사용할 때는 branch를 생략합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
	-d '{"objectSet":{"objectType":"Employee","type":"base"},"aggregation":[{"field":"tenure","name":"min_tenure","type":"min"},{"field":"tenure","name":"avg_tenure","type":"avg"}],"groupBy":[{"field":"startDate","ranges":[{"endValue":"2020-06-01","startValue":"2020-01-01"}],"type":"ranges"},{"field":"city","type":"exact"}]}'

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {'objectSet': {'objectType': 'Employee', 'type': 'base'}, 'aggregation': [{'field': 'tenure', 'name': 'min_tenure', 'type': 'min'}, {'field': 'tenure', 'name': 'avg_tenure', 'type': 'avg'}], 'groupBy': [{'field': 'startDate', 'ranges': [{'endValue': '2020-06-01', 'startValue': '2020-01-01'}], 'type': 'ranges'}, {'field': 'city', 'type': 'exact'}]}

response = requests.post('https://{}/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AggregateObjectSetV2Example.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class AggregateObjectSetV2Example {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"objectSet\":{\"objectType\":\"Employee\",\"type\":\"base\"},\"aggregation\":[{\"field\":\"tenure\",\"name\":\"min_tenure\",\"type\":\"min\"},{\"field\":\"tenure\",\"name\":\"avg_tenure\",\"type\":\"avg\"}],\"groupBy\":[{\"field\":\"startDate\",\"ranges\":[{\"endValue\":\"2020-06-01\",\"startValue\":\"2020-01-01\"}],\"type\":\"ranges\"},{\"field\":\"city\",\"type\":\"exact\"}]}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"objectSet":{"objectType":"Employee","type":"base"},"aggregation":[{"field":"tenure","name":"min_tenure","type":"min"},{"field":"tenure","name":"avg_tenure","type":"avg"}],"groupBy":[{"field":"startDate","ranges":[{"endValue":"2020-06-01","startValue":"2020-01-01"}],"type":"ranges"},{"field":"city","type":"exact"}]}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"objectSet`":{`"objectType`":`"Employee`",`"type`":`"base`"},`"aggregation`":[{`"field`":`"tenure`",`"name`":`"min_tenure`",`"type`":`"min`"},{`"field`":`"tenure`",`"name`":`"avg_tenure`",`"type`":`"avg`"}],`"groupBy`":[{`"field`":`"startDate`",`"ranges`":[{`"endValue`":`"2020-06-01`",`"startValue`":`"2020-01-01`"}],`"type`":`"ranges`"},{`"field`":`"city`",`"type`":`"exact`"}]}"

$response.content