모델 버전 승격(Promote Version Model) (V2)

기존 모델 버전을 대상 모델로 복사합니다. 복사본은 지정한 브랜치의 최신 버전이 되며 새로운 모델 버전 RID를 갖습니다. 원래 버전 RID와 반환된 버전 RID를 같은 값으로 처리하지 않습니다.

본문의 sourceModelVersionRid는 필수입니다. branch를 생략하면 대부분의 플랫폼 인스턴스에서 master를 사용합니다. 공개 API가 지원하지 않는 생성 출처의 버전은 UnsupportedModelSource 오류로 거부될 수 있습니다.

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

HTTP 요청

POST /api/v2/models/{modelRid}/promoteVersion

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

경로 매개변수

쿼리 매개변수

요청 본문

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

요청 본문 예시입니다.

{
  "sourceModelVersionRid": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee",
  "branch": "master"
}

응답

응답 형식은 ModelVersion입니다.

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

승격한 모델 버전의 응답 예시입니다.

{
  "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.0dd0405f-58ba-494b-98cd-0144fe1f1067"
}

개별 오류

요청 예제

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

원천 버전을 대상 모델의 master 브랜치로 승격하는 예제입니다. 반환 예시의 버전 RID는 원천과 다른 값입니다.

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/promoteVersion?preview=true" \
	-d '{"sourceModelVersionRid":"ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee","branch":"master"}'

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 = {
    "sourceModelVersionRid": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee",
    "branch": "master"
}

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 PromoteVersionModelExample.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 PromoteVersionModelExample {
    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/promoteVersion?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"sourceModelVersionRid\":\"ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee\",\"branch\":\"master\"}", 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/promoteVersion?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"sourceModelVersionRid":"ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee","branch":"master"}'
}).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/promoteVersion?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"sourceModelVersionRid`":`"ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee`",`"branch`":`"master`"}"

$response.content