Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

모델 함수 교체(Replace Model Function) (V2)

모델의 함수 구성을 교체합니다. apiName과 isRowWise를 명시하며 바인딩 요구 조건에 맞게 실제 ontologyBinding을 제공합니다.

이 요청 본문에는 생성 요청과 달리 displayName 필드가 없습니다. 함수 API나 행 단위 설정을 바꾸면 소비자의 호출 형태도 해당 함수 계약에 맞춥니다. 게시와 버전 관리의 조건은 모델 함수 가이드를 따릅니다.

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

HTTP 요청

PUT /api/v2/models/{modelRid}/function

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
apiNamestring필수myModelFunction
ontologyBindingstring선택온톨로지의 고유 RID입니다. List Ontologies 또는 Ontology Manager에서 확인할 수 있습니다.ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890
isRowWiseboolean필수false

요청 본문 예시입니다.

{
  "apiName": "myModelFunction",
  "ontologyBinding": "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "isRowWise": false
}

응답

응답 형식은 ModelFunction입니다.

교체한 모델 함수입니다.

이름자료형필수 여부의미와 조건예시 값
functionRidstring필수ri.function-registry.main.function.a1b2c3d4-e5f6-7890-abcd-ef1234567890
functionVersionstring필수0.0.1
displayNamestring필수Core.DisplayName
apiNamestring필수myModelFunction
isRowWiseboolean필수false
ontologyBindingstring선택온톨로지의 고유 RID입니다. List Ontologies 또는 Ontology Manager에서 확인할 수 있습니다.ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890

교체한 모델 함수의 응답 예시입니다.

{
  "apiName": "myModelFunction",
  "ontologyBinding": "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "isRowWise": false,
  "functionVersion": "0.0.1",
  "displayName": "Core.DisplayName",
  "functionRid": "ri.function-registry.main.function.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ModelApiTypeUnsupportedForFunctionINVALID_ARGUMENT400모델 API에 온톨로지 함수 생성에서 지원하지 않는 자료형이 있습니다.fieldName, unsupportedType
InvalidFunctionApiNameINVALID_ARGUMENT400함수 API 이름이 유효하지 않습니다.apiName
OntologyBindingRequiredINVALID_ARGUMENT400모델 함수를 생성하거나 교체할 때 온톨로지 바인딩이 필요합니다.
OntologyNotFoundNOT_FOUND404지정한 온톨로지를 찾을 수 없습니다.ontologyRid
ReplaceModelFunctionPermissionDeniedPERMISSION_DENIED403모델 함수를 교체할 권한이 없습니다.modelRid
ModelNotFoundNOT_FOUND404모델을 찾을 수 없습니다.modelRid
ModelFunctionNotFoundNOT_FOUND404모델 함수를 찾을 수 없습니다.modelRid

요청 예제

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

함수 API 이름과 온톨로지 바인딩을 지정하고 isRowWise=false로 설정하는 교체 예제입니다. 실제 대상과 소비자의 호출 계약을 확인합니다.

cURL

curl -X PUT \
	-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/function?preview=true" \
	-d '{"apiName":"myModelFunction","ontologyBinding":"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890","isRowWise":false}'

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 = {
    "apiName": "myModelFunction",
    "ontologyBinding": "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "isRowWise": False
}

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

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
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 ReplaceModelFunctionExample {
    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()) {
            HttpPut request = new HttpPut("https://" + HOSTNAME + "/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/function?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"apiName\":\"myModelFunction\",\"ontologyBinding\":\"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\"isRowWise\":false}", 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/function?preview=true`, {
    method: 'PUT',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"apiName":"myModelFunction","ontologyBinding":"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890","isRowWise":false}'
}).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/function?preview=true" `
	-Method Put `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"apiName`":`"myModelFunction`",`"ontologyBinding`":`"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890`",`"isRowWise`":false}"

$response.content