Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

실험 시계열 JSON 조회(JSON Experiment Series) (V2)

시계열 하나의 원시 값들을 JSON으로 조회합니다. 기본 페이지 크기는 200개이며 최대 1,000개입니다. offset은 처음부터 건너뛸 값의 개수이며 기본값은 0입니다.

응답의 type은 doubleV1입니다. 각 항목에는 double value, Unix epoch 기준 밀리초인 timestamp, 스텝 번호인 step이 있습니다. 타임스탬프와 스텝 번호는 long 형식의 정수입니다. 스텝 번호를 타임스탬프나 고정된 시작 번호로 대신 해석하지 않습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
modelRidstring필수모델의 RID입니다.ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9
experimentRidstring필수실험의 RID입니다.ri.models.main.experiment.abc123
experimentSeriesNamestring필수시간에 따라 기록한 지표 시계열의 이름입니다.loss

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
pageSizeinteger선택페이지마다 반환할 값의 최대 개수입니다. 기본값은 200이며 최대값은 1000입니다.
offsetinteger선택처음부터 건너뛸 값의 개수이며 기본값은 0입니다.
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 Series입니다.

시간에 따라 기록한 값의 시계열입니다.

분기 doubleV1

double 값의 시계열입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: doubleV1.doubleV1
serieslist<DoubleSeriesValueV1>선택
series의 구조

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

시계열에 기록된 double 값 하나입니다.

이름자료형필수 여부의미와 조건예시 값
valuedouble필수
timestamplong필수Unix epoch부터 경과한 밀리초입니다.1715212800000
steplong필수스텝 번호입니다.

실험 지표 시계열의 응답 예시입니다.

{
  "type": "doubleV1",
  "series": [
    {
      "value": 0.42,
      "timestamp": 1715212800000,
      "step": 1
    }
  ]
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ExperimentSeriesNotFoundNOT_FOUND404실험에서 요청한 시계열을 찾을 수 없습니다.modelRid, experimentRid, seriesName
ModelExperimentNotFoundNOT_FOUND404실험을 찾을 수 없거나 사용자에게 접근 권한이 없습니다.modelRid, experimentRid
JsonExperimentSeriesPermissionDeniedPERMISSION_DENIED403실험 시계열을 JSON으로 조회할 권한이 없습니다.experimentSeriesName, experimentRid, modelRid

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class JsonExperimentSeriesExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            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/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).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/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true" `
	-Headers $headers

$response.content