Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

온라인 모델 JSON 추론(Transform JSON Live Deployment) (V2)

온라인 배포에 추론을 요청합니다. input의 각 키는 모델 API의 입력 이름이고 각 값은 해당 입력 구조에 맞는 데이터입니다. 응답의 output도 출력 이름에서 결과 데이터로 대응하는 맵입니다.

호출에는 api:models-execute 권한 범위를 사용합니다. 입력 검증은 오류 상세 유형을 확인합니다. 모델 실행 오류인 InferenceFailure는 HTTP 400이고, 응답 시간이 5분을 초과한 InferenceTimeout은 TIMEOUT 코드와 HTTP 500입니다.

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

HTTP 요청

POST /api/v2/models/liveDeployments/{liveDeploymentRid}/transformJson

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
liveDeploymentRidstring필수Live Deployment의 RID입니다.ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9

쿼리 매개변수

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

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
inputmap<string, any>선택모델 추론에 전달할 데이터입니다. 각 키는 모델 API의 입력 이름이며 값은 그 입력의 데이터 구조와 일치해야 합니다.본문 예시 참조

요청 본문 예시입니다.

{
  "input": {
    "input_df": [
      {
        "feature_1": 1.0,
        "feature_2": 2
      }
    ]
  }
}

응답

응답 형식은 TransformLiveDeploymentResponse입니다.

Live Deployment에서 입력을 처리한 결과입니다.

이름자료형필수 여부의미와 조건예시 값
outputmap<string, any>선택모델 추론의 출력입니다. 각 키는 모델 API의 출력 이름이며 값의 구조는 해당 출력 명세에 따릅니다.

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
LiveDeploymentNotFoundNOT_FOUND404지정한 Live Deployment를 찾을 수 없습니다.liveDeploymentRid
InferenceTimeoutTIMEOUT500추론 요청에 응답하기까지 5분을 초과했습니다. 모델 실행 시간이 길거나 배포에 부하가 큰 경우 등이 해당합니다.liveDeploymentRid
InferenceInvalidInputINVALID_ARGUMENT400입력이 모델 API 명세에 맞지 않습니다. errorType에서 구체적인 검증 오류를 확인합니다.liveDeploymentRid, errorType
InferenceFailureINVALID_ARGUMENT400모델 실행 오류나 예상하지 못한 내부 문제로 추론 요청이 실패했습니다. 보통 입력값보다 모델 자체의 문제와 관련됩니다.liveDeploymentRid, errorMessage
TransformJsonLiveDeploymentPermissionDeniedPERMISSION_DENIED403LiveDeployment에서 추론할 권한이 없습니다.liveDeploymentRid

요청 예제

FOUNDRY_HOST에는 https://를 제외한 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다. 예시 식별자는 실제 작업 대상과 생성 응답에서 받은 값으로 바꿉니다.

이 예제는 모델의 input_df라는 표 입력에 double형 feature_1과 integer형 feature_2 열이 있다고 가정합니다. 실제 배포의 Model API에 맞는 입력 이름, 열과 값을 사용합니다. 결과 JSON은 텍스트로 출력합니다.

cURL

curl --fail -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true" \
	-d '{"input":{"input_df":[{"feature_1":1.0,"feature_2":2}]}}'

Python

Requests 라이브러리가 필요합니다.

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 = {
    "input": {
        "input_df": [
            {
                "feature_1": 1.0,
                "feature_2": 2
            }
        ]
    }
}

response = requests.post('https://{}/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
response.raise_for_status()
print(response.text)

Java

Apache HttpClient 4.5 API를 사용하는 TransformJsonLiveDeploymentExample.java 예제입니다.

import java.io.IOException;
import org.apache.http.util.EntityUtils;
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 TransformJsonLiveDeploymentExample {
    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/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"input\":{\"input_df\":[{\"feature_1\":1.0,\"feature_2\":2}]}}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                int status = response.getStatusLine().getStatusCode();
                if (status < 200 || status >= 300) throw new IOException("HTTP " + status);
                System.out.println(EntityUtils.toString(response.getEntity(), "UTF-8"));
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js에서 사용합니다. import 또는 최상위 await를 사용하는 예제는 ES 모듈(.mjs)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

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

fetch(`https://${HOSTNAME}/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"input":{"input_df":[{"feature_1":1.0,"feature_2":2}]}}'
}).then(async (response) => {
    if (!response.ok) {
        await response.body?.cancel();
        throw new Error(`HTTP ${response.status}`);
    }
    console.log(await response.text())
});

PowerShell

오류가 발생하면 스크립트를 중단합니다.

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

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"input`":{`"input_df`":[{`"feature_1`":1.0,`"feature_2`":2}]}}"

$response.content