모델 버전 목록(List Model Versions) (V2)

모델에 속한 버전을 브랜치별로 조회합니다. branch를 생략하면 대부분의 플랫폼 인스턴스에서 master를 사용합니다.

첫 요청에는 pageToken을 넣지 않습니다. 다음 페이지가 있으면 반환한 nextPageToken을 다음 요청의 pageToken에 전달합니다. 공개 API가 지원하지 않는 생성 출처가 있으면 UnsupportedModelSource가 발생할 수 있습니다.

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

HTTP 요청

GET /api/v2/models/{modelRid}/versions

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

응답 형식은 ListModelVersionsResponse입니다.

data의 구조

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

전체 필드와 생성 출처 분기는 모델 버전 구조를 따릅니다.

모델 버전 목록의 응답 예시입니다.

{
  "data": [
    {
      "backingRepositories": [
        "ri.stemma.main.repository.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "condaRequirements": [
        "numpy==1.24.0",
        "pandas==2.0.0"
      ],
      "linkedExperiment": "ri.models.main.experiment.abc123",
      "modelApi": {
        "inputs": [
          {
            "name": "input_df",
            "required": true,
            "type": "tabular",
            "columns": [
              {
                "name": "feature_1",
                "required": true,
                "dataType": {
                  "type": "double"
                }
              },
              {
                "name": "feature_2",
                "required": true,
                "dataType": {
                  "type": "integer"
                }
              }
            ],
            "format": "PANDAS"
          }
        ],
        "outputs": [
          {
            "name": "output_df",
            "required": true,
            "type": "tabular",
            "columns": [
              {
                "name": "prediction",
                "required": true,
                "dataType": {
                  "type": "double"
                }
              }
            ],
            "format": "SPARK"
          }
        ]
      },
      "createdTime": "2003-05-06T12:34:56.789Z",
      "rid": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

요청 예제

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/versions?branch=master&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/versions?branch=master&preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListModelVersionsExample.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 ListModelVersionsExample {
    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/versions?branch=master&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/versions?branch=master&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/versions?branch=master&preview=true" `
	-Headers $headers

$response.content