0Pricing
AI Agents · 강의

도구 스키마 정의(JSON Schema)

유형, 설명, 열거형 및 필수 필드를 포함해 도구 매개변수의 JSON Schema 정의를 작성해보세요.

도구 스키마 정의(JSON Schema)은(는) CoddyKit의 무료 AI Agents 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 AI Agents 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. AI Agents 강의에는 총 4개의 강의가 포함되어 있습니다.

도구 스키마는 JSON 스키마입니다

OpenAI, Anthropic과 대부분의 다른 제공업체는 도구 매개변수에 JSON 스키마를 사용합니다.

OpenAPI / Swagger를 사용해 본 적이 있다면 이 내용의 90%는 이미 알고 있는 셈입니다.

필수 필드 세 가지

모든 도구 정의에는 다음이 포함됩니다:

  1. name — 고유 식별자(snake_case)
  2. description — 도구의 기능과 사용 시점
  3. parameters — 입력의 JSON 스키마

최소 스키마

필수 문자열 필드 하나를 가진 객체입니다:

schema = {
    'name': 'search_orders',
    'description': 'Find orders by customer email',
    'parameters': {
        'type': 'object',
        'properties': {
            'email': {
                'type': 'string',
                'description': 'Customer email address'
            }
        },
        'required': ['email']
    }
}
import json
print(json.dumps(schema, indent=2))

JSON 스키마 타입

  • string — 텍스트
  • integer, number — 숫자
  • boolean — 참/거짓
  • array — 목록(items도 필요)
  • object — 딕셔너리(properties도 필요)

닫힌 집합에는 열거형 사용하기

허용되는 값이 정확히 N개일 때 enum을 사용합니다:

unit_param = {
    'unit': {
        'type': 'string',
        'enum': ['C', 'F'],
        'description': 'Temperature unit'
    }
}
# The model will only ever output C or F
print(unit_param)
print("Allowed values:", unit_param['unit']['enum'])

배열 매개변수

목록 입력에는 items를 설정합니다:

tags_param = {
    'tags': {
        'type': 'array',
        'items': {'type': 'string'},
        'description': 'List of tags to filter by'
    }
}
print(tags_param)

중첩 객체

객체를 중첩할 수 있지만 모델의 안정성을 위해 스키마를 얕게 유지하세요(최대 2~3단계):

filter_param = {
    'filter': {
        'type': 'object',
        'properties': {
            'min_price': {'type': 'number'},
            'in_stock': {'type': 'boolean'}
        }
    }
}
print(filter_param)

설명 필드는 중요합니다

모델은 description을 바탕으로 도구를 선택하고 인수를 채웁니다. 설명을 API 문서처럼 다루세요:

# Bad
bad = {'description': 'gets data'}

# Good
good = {'description': 'Fetch the most recent 50 orders for the given customer email. Returns order_id, status, total. Use this when the user asks about their order history or order status.'}
print("Bad description:", bad['description'])
print("Good description:", good['description'])

required 배열

필수 필드를 명시적으로 표시하세요. 모델은 이 필드를 항상 채우며, 선택적 필드는 관련이 있을 때만 채웁니다:

tool_params = {
    'parameters': {
        'properties': {
            'city': {'type': 'string'},
            'unit': {'type': 'string', 'enum': ['C', 'F']}
        },
        'required': ['city']
    }
}
print(tool_params)
print("Required fields:", tool_params['parameters']['required'])

Pydantic -> JSON 스키마

Pydantic 모델에서 스키마를 자동으로 생성할 수 있습니다:

from pydantic import BaseModel, Field

class SearchArgs(BaseModel):
    email: str = Field(description='Customer email')
    limit: int = Field(50, description='Max orders to return')

schema = SearchArgs.model_json_schema()

엄격한 모드(OpenAI 구조화된 출력)

strict: true와 additionalProperties: false를 추가하면 모델 출력이 스키마와 정확히 일치하도록 보장됩니다:

tools = [{
    'type': 'function',
    'function': {
        'name': 'get_weather',
        'strict': True,
        'parameters': {
            'type': 'object',
            'properties': {'city': {'type': 'string'}},
            'required': ['city'],
            'additionalProperties': False
        }
    }
}]
import json
print(json.dumps(tools, indent=2))

설명의 중요성

도구의 description은 왜 그렇게 중요한가요?

복습

스키마가 모델을 이끕니다. 좋은 설명, 닫힌 집합을 위한 열거형, required 배열, 엄격한 모드가 안정성을 높이는 핵심 수단입니다.

자주 묻는 질문

“도구 스키마 정의(JSON Schema)” 강의는 무료인가요?

네 — “도구 스키마 정의(JSON Schema)” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 AI Agents 강의 전체를 잠금 해제할 수 있습니다. AI Agents 강의에는 총 4개의 강의가 포함되어 있습니다.

“도구 스키마 정의(JSON Schema)”에서 뭘 배우나요?

유형, 설명, 열거형 및 필수 필드를 포함해 도구 매개변수의 JSON Schema 정의를 작성해보세요. 브라우저에서 직접 실행하는 실습 코드로 AI Agents을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

AI Agents을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 AI Agents은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.

“도구 스키마 정의(JSON Schema)” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 AI Agents 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 AI Agents 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

  1. 함수 호출 작동 방식
  2. 도구 스키마 정의(JSON Schema)
  3. 실행 중 도구 선택
  4. 모델에 결과 반환
← AI Agents(으)로 돌아가기