모델 실험 검색(Search Experiments) (V2)

실험 메타데이터, 매개변수, 시계열과 요약 지표를 중첩 필터로 검색합니다. 조건을 생략하면 해당 모델의 모든 실험이 대상입니다.

pageSize의 기본값은 50이며 페이지당 최대 100개입니다. 첫 요청에서 본문의 pageToken을 생략하고 다음 응답의 토큰을 이후 요청에 전달합니다. 정렬을 생략하면 관련도 순서이며 orderBy를 지정할 때는 필드와 방향을 모두 제공합니다.

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

HTTP 요청

POST /api/v2/models/{modelRid}/experiments/search

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

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`modelRid`	`string`	필수	모델의 RID입니다.	`ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`preview`	`boolean`	선택	미리보기 기능 사용을 활성화합니다.	`true`

요청 본문

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

이름	자료형	필수 여부	의미와 조건	예시 값
`where`	`union`	선택	실험 검색 조건입니다. 생략하면 해당 모델의 모든 실험을 대상으로 합니다.
`orderBy`	`object`	선택	정렬할 필드입니다. 기본 정렬은 관련도 순서입니다.	본문 예시 참조
`pageSize`	`integer`	선택	반환할 결과 수의 상한입니다. 기본값은 50이며 최대값은 100입니다.
`pageToken`	`string`	선택	다음 페이지 토큰입니다. 첫 요청에서는 생략합니다.

`where`의 구조

9가지 분기의 전체 필드와 연산자 조건은 실험 검색 필터를 따릅니다.

`orderBy`의 구조

이름	자료형	필수 여부	의미와 조건	예시 값
`field`	`enum`	필수	실험 검색 결과의 정렬 필드입니다. 허용값: `EXPERIMENT_NAME`, `CREATED_TIME`.	`EXPERIMENT_NAME`
`direction`	`enum`	필수	오름차순 또는 내림차순 정렬 방향입니다. 허용값: `ASC`, `DESC`.	`ASC`

요청 본문 예시입니다.

{
  "orderBy": {
    "field": "EXPERIMENT_NAME",
    "direction": "ASC"
  },
  "pageSize": 100
}

응답

응답 형식은 SearchExperimentsResponse입니다.

실험 검색 결과입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`data`	`list<Experiment>`	선택	검색 조건과 일치하는 실험 목록입니다.
`nextPageToken`	`string`	선택	다음 페이지를 요청할 때 `pageToken`에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

`data`의 구조

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

모든 매개변수, 집계와 산출물 필드는 실험 메타데이터를 따릅니다.

실험 검색 결과의 응답 예시입니다.

{
  "data": [
    {
      "source": {
        "type": "codeWorkspace",
        "containerRid": "ri.foundry-container-service.main.container.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "deploymentRid": "ri.foundry-container-service.main.deployment.b2c3d4e5-f6a7-8901-bcde-f12345678901"
      },
      "rid": "ri.models.main.experiment.abc123",
      "branch": "master",
      "summaryMetrics": [
        {
          "seriesName": "loss",
          "aggregation": "LAST",
          "value": 0.07
        }
      ],
      "tags": [
        "production"
      ],
      "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "series": [
        {
          "name": "loss",
          "length": 100,
          "value": {
            "type": "double",
            "min": 0.05,
            "max": 1.5,
            "last": 0.07
          }
        }
      ],
      "linkedModelVersion": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee",
      "createdTime": "2003-05-06T12:34:56.789Z",
      "jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448",
      "parameters": [
        {
          "name": "learning_rate",
          "value": {
            "type": "double",
            "value": 0.001
          }
        }
      ],
      "modelRid": "ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9",
      "status": "RUNNING",
      "artifacts": {
        "predictions_table": {
          "name": "predictions_table",
          "description": "Test set predictions",
          "sizeBytes": 4096,
          "details": {
            "type": "table",
            "rowCount": 100
          }
        }
      }
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름	오류 코드	HTTP	의미와 조건	추가 매개변수
`InvalidExperimentSearchFilter`	`INVALID_ARGUMENT`	400	검색 필터가 올바르지 않습니다. 지원하지 않는 매개변수 연산자와 값 유형 조합, 지원하지 않는 상태 또는 잘못된 필터 형식 등이 원인일 수 있습니다.	`reason`
`SearchExperimentsPermissionDenied`	`PERMISSION_DENIED`	403	실험을 검색할 권한이 없습니다.	`modelRid`

요청 예제

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

모델의 실험을 이름 오름차순으로 최대 100개 요청하는 첫 페이지 예제입니다. 필터가 필요하면 where에 조건을 추가합니다. 다음 페이지를 요청할 때는 응답의 nextPageToken 값을 요청 본문의 pageToken에 전달합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/search?preview=true" \
	-d '{"orderBy":{"field":"EXPERIMENT_NAME","direction":"ASC"},"pageSize":100}'

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 = {'orderBy': {'field': 'EXPERIMENT_NAME', 'direction': 'ASC'}, 'pageSize': 100}

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 SearchExperimentsExample.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 SearchExperimentsExample {
    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/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/search?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"orderBy\":{\"field\":\"EXPERIMENT_NAME\",\"direction\":\"ASC\"},\"pageSize\":100}", 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/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/search?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"orderBy":{"field":"EXPERIMENT_NAME","direction":"ASC"},"pageSize":100}'
}).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/search?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"orderBy`":{`"field`":`"EXPERIMENT_NAME`",`"direction`":`"ASC`"},`"pageSize`":100}"

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설