Citações

O Claude é capaz de fornecer citações detalhadas ao responder perguntas sobre documentos, ajudando você a rastrear e verificar fontes de informação nas respostas.

O recurso de citações está atualmente disponível no Claude 3.7 Sonnet, Claude 3.5 Sonnet (novo) e 3.5 Haiku.

Aqui está um exemplo de como usar citações com a API de Mensagens:

​

Como funcionam as citações

Integre citações com o Claude nestes passos:

​

Conteúdo citável vs não citável

• Texto encontrado dentro do conteúdo source de um documento pode ser citado.
• title e context são campos opcionais que serão passados para o modelo, mas não serão usados para o conteúdo citado.
• title é limitado em comprimento, então você pode achar o campo context útil para armazenar quaisquer metadados do documento como texto ou json em forma de string.

​

Índices de citação

• Os índices de documentos são indexados a partir de 0 da lista de todos os blocos de conteúdo de documentos na solicitação (abrangendo todas as mensagens).
• Os índices de caracteres são indexados a partir de 0 com índices finais exclusivos.
• Os números de página são indexados a partir de 1 com números de página finais exclusivos.
• Os índices de blocos de conteúdo são indexados a partir de 0 com índices finais exclusivos da lista content fornecida no documento de conteúdo personalizado.

​

Custos de tokens

• A ativação das citações implica um ligeiro aumento nos tokens de entrada devido às adições de prompt do sistema e à divisão de documentos.
• No entanto, o recurso de citações é muito eficiente com tokens de saída. Internamente, o modelo está gerando citações em um formato padronizado que são então analisadas em texto citado e índices de localização do documento. O campo cited_text é fornecido por conveniência e não conta para os tokens de saída.
• Quando passado de volta em turnos subsequentes de conversa, cited_text também não é contado para os tokens de entrada.

​

Compatibilidade de recursos

Citações funciona em conjunto com outros recursos da API, incluindo cache de prompt, contagem de tokens e processamento em lote.

​

Tipos de Documento

​

Escolhendo um tipo de documento

Suportamos três tipos de documento para citações:

​

Documentos de texto simples

Os documentos de texto simples são automaticamente divididos em frases:

{
    "type": "document",
    "source": {
        "type": "text",
        "media_type": "text/plain",
        "data": "Plain text content..."
    },
    "title": "Document Title", # opcional
    "context": "Context about the document that will not be cited from", # opcional
    "citations": {"enabled": True}
}

{
    "type": "char_location",
    "cited_text": "The exact text being cited", # não contado para tokens de saída
    "document_index": 0,
    "document_title": "Document Title",
    "start_char_index": 0,    # indexado a partir de 0
    "end_char_index": 50      # exclusivo
}

​

Documentos PDF

Os documentos PDF são fornecidos como dados codificados em base64. O texto do PDF é extraído e dividido em frases. Como as citações de imagens ainda não são suportadas, PDFs que são digitalizações de documentos e não contêm texto extraível não serão citáveis.

{
    "type": "document",
    "source": {
        "type": "base64",
        "media_type": "application/pdf",
        "data": base64_encoded_pdf_data
    },
    "title": "Document Title", # opcional
    "context": "Context about the document that will not be cited from", # opcional
    "citations": {"enabled": True}
}

{
    "type": "page_location",
    "cited_text": "The exact text being cited", # não contado para tokens de saída
    "document_index": 0,     
    "document_title": "Document Title", 
    "start_page_number": 1,  # indexado a partir de 1
    "end_page_number": 2     # exclusivo
}

​

Documentos de conteúdo personalizado

Documentos de conteúdo personalizado dão a você controle sobre a granularidade da citação. Nenhuma divisão adicional é feita e os pedaços são fornecidos ao modelo de acordo com os blocos de conteúdo fornecidos.

{
    "type": "document",
    "source": {
        "type": "content",
        "content": [
            {"type": "text", "text": "First chunk"},
            {"type": "text", "text": "Second chunk"}
        ]
    },
    "title": "Document Title", # opcional
    "context": "Context about the document that will not be cited from", # opcional
    "citations": {"enabled": True}
}

{
    "type": "content_block_location",
    "cited_text": "The exact text being cited", # não contado para tokens de saída
    "document_index": 0,
    "document_title": "Document Title",
    "start_block_index": 0,   # indexado a partir de 0
    "end_block_index": 1      # exclusivo
}

​

Estrutura de Resposta

Quando as citações estão ativadas, as respostas incluem vários blocos de texto com citações:

{
    "content": [
        {
            "type": "text",
            "text": "According to the document, "
        },
        {
            "type": "text",
            "text": "the grass is green",
            "citations": [{
                "type": "char_location",
                "cited_text": "The grass is green.",
                "document_index": 0,
                "document_title": "Example Document",
                "start_char_index": 0,
                "end_char_index": 20
            }]
        },
        {
            "type": "text",
            "text": " and "
        },
        {
            "type": "text",
            "text": "the sky is blue",
            "citations": [{
                "type": "char_location",
                "cited_text": "The sky is blue.",
                "document_index": 0,
                "document_title": "Example Document",
                "start_char_index": 20,
                "end_char_index": 36
            }]
        }
    ]
}

​

Suporte a Streaming

Para respostas de streaming, adicionamos um tipo citations_delta que contém uma única citação a ser adicionada à lista citations no bloco de conteúdo text atual.

event: message_start
data: {"type": "message_start", ...}

event: content_block_start
data: {"type": "content_block_start", "index": 0, ...}

event: content_block_delta
data: {"type": "content_block_delta", "index": 0, 
       "delta": {"type": "text_delta", "text": "According to..."}}

event: content_block_delta
data: {"type": "content_block_delta", "index": 0,
       "delta": {"type": "citations_delta", 
                 "citation": {
                     "type": "char_location",
                     "cited_text": "...",
                     "document_index": 0,
                     ...
                 }}}

event: content_block_stop
data: {"type": "content_block_stop", "index": 0}

event: message_stop
data: {"type": "message_stop"}