모델 함수 생성 또는 갱신(Create Model Function) (V2)

모델을 온톨로지 함수로 호출할 수 있도록 ModelFunction을 만듭니다. 해당 모델에 함수가 이미 있으면 기존 함수를 갱신합니다.

apiName, isRowWise, displayName은 필수입니다. ontologyBinding은 요청 스키마에서 선택 필드이지만 생성 작업에는 바인딩 요구 조건이 있으므로 실제 온톨로지 RID를 제공합니다. 온톨로지는 List Ontologies 또는 Ontology Manager에서 확인할 수 있습니다.

모델 API의 자료형은 함수 생성에서 지원하는 유형이어야 합니다. 지원되지 않는 경우 ModelApiTypeUnsupportedForFunction의 fieldName과 unsupportedType을 확인합니다.

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

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

요청 본문

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

요청 본문 예시입니다.

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

응답

응답 형식은 ModelFunction입니다.

반환된 모델 함수입니다.

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

{
  "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"
}

개별 오류

요청 예제

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

지정한 모델과 온톨로지에 myModelFunction을 연결하는 예제입니다. Core.DisplayName은 예시 표시 이름이며 실제 이름으로 바꿉니다. isRowWise는 false로 명시되어 있습니다. 요청은 함수를 생성하거나 기존 함수를 갱신합니다.

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

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,
    "displayName": "Core.DisplayName"
}

response = requests.post('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를 사용합니다. 클래스 이름에 맞는 CreateModelFunctionExample.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 CreateModelFunctionExample {
    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/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,\"displayName\":\"Core.DisplayName\"}", 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: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"apiName":"myModelFunction","ontologyBinding":"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890","isRowWise":false,"displayName":"Core.DisplayName"}'
}).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 Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"apiName`":`"myModelFunction`",`"ontologyBinding`":`"ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890`",`"isRowWise`":false,`"displayName`":`"Core.DisplayName`"}"

$response.content