검색 결과

This feature is eligible for Zero Data Retention (ZDR). When your organization has a ZDR arrangement, data sent through this feature is not stored after the API response is returned.

검색 결과 콘텐츠 블록은 적절한 소스 속성을 통해 자연스러운 인용을 활성화하여 웹 검색 품질의 인용을 사용자 정의 애플리케이션에 제공합니다. 이 기능은 Claude가 소스를 정확하게 인용해야 하는 RAG(검색 증강 생성) 애플리케이션에서 특히 강력합니다.

검색 결과 기능은 다음 모델에서 사용 가능합니다:

Claude Opus 4.7 (claude-opus-4-7)
Claude Opus 4.6 (claude-opus-4-6)
Claude Sonnet 4.6 (claude-sonnet-4-6)
Claude Sonnet 4.5 (claude-sonnet-4-5-20250929)
Claude Opus 4.5 (claude-opus-4-5-20251101)
Claude Opus 4.1 (claude-opus-4-1-20250805)
Claude Opus 4 (deprecated) (claude-opus-4-20250514)
Claude Sonnet 4 (deprecated) (claude-sonnet-4-20250514)
Claude Sonnet 3.7 (deprecated) (claude-3-7-sonnet-20250219)
Claude Haiku 4.5 (claude-haiku-4-5-20251001)
Claude Haiku 3.5 (deprecated) (claude-3-5-haiku-20241022)

주요 이점

자연스러운 인용 - 모든 콘텐츠에 대해 웹 검색과 동일한 인용 품질 달성
유연한 통합 - 동적 RAG를 위한 도구 반환이나 미리 가져온 데이터를 위한 최상위 콘텐츠로 사용
적절한 소스 속성 - 각 결과에는 명확한 속성을 위한 소스 및 제목 정보 포함
문서 해결 방법 불필요 - 문서 기반 해결 방법의 필요성 제거
일관된 인용 형식 - Claude의 웹 검색 기능의 인용 품질 및 형식과 일치

작동 방식

검색 결과는 두 가지 방식으로 제공될 수 있습니다:

도구 호출에서 - 사용자 정의 도구가 검색 결과를 반환하여 동적 RAG 애플리케이션 활성화
최상위 콘텐츠로 - 미리 가져온 또는 캐시된 콘텐츠를 위해 사용자 메시지에서 직접 검색 결과 제공

두 경우 모두 Claude는 적절한 소스 속성을 통해 검색 결과의 정보를 자동으로 인용할 수 있습니다.

검색 결과 스키마

검색 결과는 다음 구조를 사용합니다:

{
  "type": "search_result",
  "source": "https://example.com/article", // 필수: 소스 URL 또는 식별자
  "title": "Article Title", // 필수: 결과의 제목
  "content": [
    // 필수: 텍스트 블록의 배열
    {
      "type": "text",
      "text": "The actual content of the search result..."
    }
  ],
  "citations": {
    // 선택사항: 인용 구성
    "enabled": true // 이 결과에 대한 인용 활성화/비활성화
  }
}

필수 필드

필드	유형	설명
`type`	string	`"search_result"`이어야 함
`source`	string	콘텐츠의 소스 URL 또는 식별자
`title`	string	검색 결과에 대한 설명적 제목
`content`	array	실제 콘텐츠를 포함하는 텍스트 블록의 배열

선택사항 필드

필드	유형	설명
`citations`	object	`enabled` 부울 필드가 있는 인용 구성
`cache_control`	object	캐시 제어 설정 (예: `{"type": "ephemeral"}`)

content 배열의 각 항목은 다음을 포함하는 텍스트 블록이어야 합니다:

type: "text"이어야 함
text: 실제 텍스트 콘텐츠 (비어있지 않은 문자열)

방법 1: 도구 호출에서의 검색 결과

가장 강력한 사용 사례는 사용자 정의 도구에서 검색 결과를 반환하는 것입니다. 이는 도구가 관련 콘텐츠를 가져오고 자동 인용과 함께 반환하는 동적 RAG 애플리케이션을 활성화합니다.

예: 지식 기반 도구

방법 2: 최상위 콘텐츠로서의 검색 결과

사용자 메시지에서 직접 검색 결과를 제공할 수도 있습니다. 이는 다음의 경우에 유용합니다:

검색 인프라에서 미리 가져온 콘텐츠
이전 쿼리의 캐시된 검색 결과
외부 검색 서비스의 콘텐츠
테스트 및 개발

예시: 직접 검색 결과

Claude의 인용과 함께 제공되는 응답

검색 결과가 어떻게 제공되든 Claude는 검색 결과의 정보를 사용할 때 자동으로 인용을 포함합니다:

{
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "To authenticate API requests, you need to include an API key in the Authorization header",
      "citations": [
        {
          "type": "search_result_location",
          "source": "https://docs.company.com/api-reference",
          "title": "API Reference - Authentication",
          "cited_text": "All API requests must include an API key in the Authorization header",
          "search_result_index": 0,
          "start_block_index": 0,
          "end_block_index": 0
        }
      ]
    },
    {
      "type": "text",
      "text": ". You can generate API keys from your dashboard",
      "citations": [
        {
          "type": "search_result_location",
          "source": "https://docs.company.com/api-reference",
          "title": "API Reference - Authentication",
          "cited_text": "Keys can be generated from the dashboard",
          "search_result_index": 0,
          "start_block_index": 0,
          "end_block_index": 0
        }
      ]
    },
    {
      "type": "text",
      "text": ". The rate limits are 1,000 requests per hour for the standard tier and 10,000 requests per hour for the premium tier.",
      "citations": [
        {
          "type": "search_result_location",
          "source": "https://docs.company.com/api-reference",
          "title": "API Reference - Authentication",
          "cited_text": "Rate limits: 1000 requests per hour for standard tier, 10000 for premium",
          "search_result_index": 0,
          "start_block_index": 0,
          "end_block_index": 0
        }
      ]
    }
  ]
}

인용 필드

각 인용에는 다음이 포함됩니다:

필드	유형	설명
`type`	string	검색 결과 인용의 경우 항상 `"search_result_location"`
`source`	string	원본 검색 결과의 출처
`title`	string 또는 null	원본 검색 결과의 제목
`cited_text`	string	인용되는 정확한 텍스트
`search_result_index`	integer	검색 결과의 인덱스 (0부터 시작)
`start_block_index`	integer	콘텐츠 배열의 시작 위치

참고: search_result_index는 검색 결과가 어떻게 제공되었는지(도구 호출 또는 최상위 콘텐츠)와 관계없이 검색 결과 콘텐츠 블록의 인덱스(0부터 시작)를 나타냅니다.

여러 콘텐츠 블록

검색 결과는 content 배열에 여러 텍스트 블록을 포함할 수 있습니다:

{
  "type": "search_result",
  "source": "https://docs.company.com/api-guide",
  "title": "API Documentation",
  "content": [
    {
      "type": "text",
      "text": "Authentication: All API requests require an API key."
    },
    {
      "type": "text",
      "text": "Rate Limits: The API allows 1000 requests per hour per key."
    },
    {
      "type": "text",
      "text": "Error Handling: The API returns standard HTTP status codes."
    }
  ]
}

Claude는 start_block_index 및 end_block_index 필드를 사용하여 특정 블록을 인용할 수 있습니다.

고급 사용법

두 방법 결합

동일한 대화에서 도구 기반 및 최상위 검색 결과를 모두 사용할 수 있습니다:

from anthropic.types import MessageParam, SearchResultBlockParam, TextBlockParam

# First message with top-level search results
messages = [
    MessageParam(
        role="user",
        content=[
            SearchResultBlockParam(
                type="search_result",
                source="https://docs.company.com/overview",
                title="Product Overview",
                content=[
                    TextBlockParam(
                        type="text", text="Our product helps teams collaborate..."
                    )
                ],
                citations={"enabled": True},
            ),
            TextBlockParam(
                type="text",
                text="Tell me about this product and search for pricing information",
            ),
        ],
    )
]

# Claude might respond and call a tool to search for pricing
# Then you provide tool results with more search results

다른 콘텐츠 유형과 결합

두 방법 모두 검색 결과를 다른 콘텐츠와 혼합하는 것을 지원합니다:

from anthropic.types import SearchResultBlockParam, TextBlockParam

# In tool results
tool_result = [
    SearchResultBlockParam(
        type="search_result",
        source="https://docs.company.com/guide",
        title="User Guide",
        content=[TextBlockParam(type="text", text="Configuration details...")],
        citations={"enabled": True},
    ),
    TextBlockParam(
        type="text", text="Additional context: This applies to version 2.0 and later."
    ),
]

# In top-level content
user_content = [
    SearchResultBlockParam(
        type="search_result",
        source="https://research.com/paper",
        title="Research Paper",
        content=[TextBlockParam(type="text", text="Key findings...")],
        citations={"enabled": True},
    ),
    {
        "type": "image",
        "source": {"type": "url", "url": "https://example.com/chart.png"},
    },
    TextBlockParam(
        type="text", text="How does the chart relate to the research findings?"
    ),
]

캐시 제어

더 나은 성능을 위해 캐시 제어를 추가합니다:

{
  "type": "search_result",
  "source": "https://docs.company.com/guide",
  "title": "User Guide",
  "content": [{ "type": "text", "text": "..." }],
  "cache_control": {
    "type": "ephemeral"
  }
}

인용 제어

기본적으로 검색 결과에 대해 인용이 비활성화됩니다. citations 구성을 명시적으로 설정하여 인용을 활성화할 수 있습니다:

{
  "type": "search_result",
  "source": "https://docs.company.com/guide",
  "title": "User Guide",
  "content": [{ "type": "text", "text": "Important documentation..." }],
  "citations": {
    "enabled": true // Enable citations for this result
  }
}

citations.enabled이 true로 설정되면 Claude는 검색 결과의 정보를 사용할 때 인용 참조를 포함합니다. 이를 통해 다음이 가능합니다:

사용자 정의 RAG 애플리케이션에 대한 자연스러운 인용
독점 지식 기반과 인터페이스할 때 출처 속성
검색 결과를 반환하는 모든 사용자 정의 도구에 대한 웹 검색 품질의 인용

citations 필드를 생략하면 기본적으로 인용이 비활성화됩니다.

인용은 전부 아니면 무(all-or-nothing)입니다: 요청의 모든 검색 결과에 인용이 활성화되거나 모두 비활성화되어야 합니다. 다른 인용 설정을 가진 검색 결과를 혼합하면 오류가 발생합니다. 일부 출처에 대해 인용을 비활성화해야 하는 경우 해당 요청의 모든 검색 결과에 대해 인용을 비활성화해야 합니다.

모범 사례

도구 기반 검색의 경우 (방법 1)

동적 콘텐츠: 실시간 검색 및 동적 RAG 애플리케이션에 사용
오류 처리: 검색이 실패할 때 적절한 메시지 반환
결과 제한: 컨텍스트 오버플로우를 피하기 위해 가장 관련성 높은 결과만 반환

최상위 검색의 경우 (방법 2)

사전 가져온 콘텐츠: 이미 검색 결과가 있을 때 사용
배치 처리: 여러 검색 결과를 한 번에 처리하기에 이상적
테스트: 알려진 콘텐츠로 인용 동작을 테스트하기에 좋음

일반 모범 사례

결과를 효과적으로 구조화
- 명확하고 영구적인 출처 URL 사용
- 설명적인 제목 제공
- 긴 콘텐츠를 논리적 텍스트 블록으로 나누기
일관성 유지
- 애플리케이션 전체에서 일관된 출처 형식 사용
- 제목이 콘텐츠를 정확하게 반영하는지 확인
- 형식을 일관되게 유지

오류를 우아하게 처리

def search_with_fallback(query):
    try:
        results = perform_search(query)
        if not results:
            return {"type": "text", "text": "No results found."}
        return format_as_search_results(results)
    except Exception as e:
        return {"type": "text", "text": f"Search error: {str(e)}"}

제한 사항

검색 결과 콘텐츠 블록은 Claude API, Amazon Bedrock 및 Google Cloud의 Vertex AI에서 사용 가능합니다
검색 결과 내에서는 텍스트 콘텐츠만 지원됩니다(이미지 또는 기타 미디어 없음)
content 배열은 최소한 하나의 텍스트 블록을 포함해야 합니다

from anthropic.types import (
    MessageParam,
    TextBlockParam,
    SearchResultBlockParam,
    ToolResultBlockParam,
)

client = Anthropic()

# 지식 기반 검색 도구 정의
knowledge_base_tool = {
    "name": "search_knowledge_base",
    "description": "Search the company knowledge base for information",
    "input_schema": {
        "type": "object",
        "properties": {"query": {"type": "string", "description": "The search query"}},
        "required": ["query"],
    },
}


# 도구 호출을 처리하는 함수
def search_knowledge_base(query):
    # 검색 로직은 여기에
    # 올바른 형식의 검색 결과 반환
    return [
        SearchResultBlockParam(
            type="search_result",
            source="https://docs.company.com/product-guide",
            title="Product Configuration Guide",
            content=[
                TextBlockParam(
                    type="text",
                    text="To configure the product, navigate to Settings > Configuration. The default timeout is 30 seconds, but can be adjusted between 10-120 seconds based on your needs.",
                )
            ],
            citations={"enabled": True},
        ),
        SearchResultBlockParam(
            type="search_result",
            source="https://docs.company.com/troubleshooting",
            title="Troubleshooting Guide",
            content=[
                TextBlockParam(
                    type="text",
                    text="If you encounter timeout errors, first check the configuration settings. Common causes include network latency and incorrect timeout values.",
                )
            ],
            citations={"enabled": True},
        ),
    ]


# 도구를 사용하여 메시지 생성
response = client.messages.create(
    model="claude-opus-4-7",  # Works with all supported models
    max_tokens=1024,
    tools=[knowledge_base_tool],
    messages=[
        MessageParam(role="user", content="How do I configure the timeout settings?")
    ],
)

# Claude가 도구를 호출할 때 검색 결과 제공
if response.content[0].type == "tool_use":
    tool_result = search_knowledge_base(response.content[0].input["query"])

    # 도구 결과 다시 전송
    final_response = client.messages.create(
        model="claude-opus-4-7",  # Works with all supported models
        max_tokens=1024,
        messages=[
            MessageParam(
                role="user", content="How do I configure the timeout settings?"
            ),
            MessageParam(role="assistant", content=response.content),
            MessageParam(
                role="user",
                content=[
                    ToolResultBlockParam(
                        type="tool_result",
                        tool_use_id=response.content[0].id,
                        content=tool_result,  # Search results go here
                    )
                ],
            ),
        ],
    )

from anthropic.types import MessageParam, TextBlockParam, SearchResultBlockParam

client = Anthropic()

# Provide search results directly in the user message
response = client.messages.create(
    model="claude-opus-4-7",
    max_tokens=1024,
    messages=[
        MessageParam(
            role="user",
            content=[
                SearchResultBlockParam(
                    type="search_result",
                    source="https://docs.company.com/api-reference",
                    title="API Reference - Authentication",
                    content=[
                        TextBlockParam(
                            type="text",
                            text="All API requests must include an API key in the Authorization header. Keys can be generated from the dashboard. Rate limits: 1000 requests per hour for standard tier, 10000 for premium.",
                        )
                    ],
                    citations={"enabled": True},
                ),
                SearchResultBlockParam(
                    type="search_result",
                    source="https://docs.company.com/quickstart",
                    title="Getting Started Guide",
                    content=[
                        TextBlockParam(
                            type="text",
                            text="To get started: 1) Sign up for an account, 2) Generate an API key from the dashboard, 3) Install our SDK using pip install company-sdk, 4) Initialize the client with your API key.",
                        )
                    ],
                    citations={"enabled": True},
                ),
                TextBlockParam(
                    type="text",
                    text="Based on these search results, how do I authenticate API requests and what are the rate limits?",
                ),
            ],
        )
    ],
)

print(response.model_dump_json(indent=2))