IBM watsonx.ai REST API

IBM watsonx.ai REST API 개요

watsonx.ai에서 파운데이션 모델을 프로그래밍 방식으로 쓰려면 REST API를 호출해야 해요. 이 페이지에서는 REST API가 어떤 일을 할 수 있는지, 요청을 보내기 전에 준비해야 할 것들을 하나씩 정리해요.

출처: IBM watsonx.ai REST API - IBM 공식 문서

REST API로 할 수 있는 일

REST API를 통해 파운데이션 모델을 실행하고, 부가 작업까지 이어서 할 수 있어요.

  • 파운데이션 모델 정보 조회 — 사용 가능한 모델 목록과 모델 ID를 가져와요.
  • 추론(Inference) — 파운데이션 모델에 프롬프트를 보내 텍스트를 생성해요.
  • 문서에서 텍스트 추출 — 문서에서 텍스트를 뽑아내요.
  • 텍스트 벡터화 — 문장을 벡터로 바꾸는 임베딩을 수행해요.
  • 문서 구절 재랭킹 — 검색된 문서 구절의 순서를 다시 매겨요.
  • — 파운데이션 모델과 대화형 워크플로를 만들 수 있어요.
  • 에이전트형 챗 — 도구 호출을 활용한 에이전트형 대화 워크플로를 만들어요.
  • 모델 튜닝 — 파운데이션 모델을 튜닝할 수 있어요.
  • 시계열 예측 — 미래 값을 예측해요.

요청 전에 준비할 것

REST 호출을 보내기 전에 다음 정보가 필요해요. 대부분 프로젝트나 스페이스의 Developer access 페이지에서 빠르게 확인할 수 있어요.

  • 베이스 URL — API 엔드포인트의 기본 주소예요.
  • 프로젝트 또는 스페이스 ID — 자원이 속한 작업 공간의 식별자예요.
  • Bearer token — 인증 토큰으로, 자격 증명 페이지를 참고해 발급받아요.
  • {model_id} — 사용할 파운데이션 모델의 ID예요. 파운데이션 모델 정보 조회에서 확인할 수 있어요.
  • 버전(version) 파라미터 — 코드를 만들고 테스트한 날짜를 각 요청에 version=YYYY-MM-DD 형식으로 넣어요. 예: version=2025-02-06.

일부 작업은 데이터 연결로 제공되는 파일을 참조해야 해요. 파일을 추가하고 API에서 참조하는 방법은 "Adding files to reference from the API" 문서를 참고해요.

팁: Prompt Lab에서 요청 형식 확인하기

추론 요청의 문법이 헷갈릴 때는 Prompt Lab에서 같은 요청을 먼저 실행해 볼 수 있어요. Prompt Lab의 코드 패널에 생성된 cURL 요청을 보면, API에 보낼 정확한 형식을 그대로 확인할 수 있답니다.

더 알아보기