{"meta":{"title":"Citações","intro":"As citações vinculam trechos de uma resposta do assistente às fontes que os sustentam. Ative enableCitations ao criar ou retomar uma sessão e, em seguida, leia o payload citations nos eventos assistant.message para exibir notas de rodapé, listas de fontes ou links inline.","product":"GitHub Copilot","breadcrumbs":[{"href":"/pt/copilot","title":"GitHub Copilot"},{"href":"/pt/copilot/how-tos","title":"Instruções"},{"href":"/pt/copilot/how-tos/copilot-sdk","title":"SDK do Copilot"},{"href":"/pt/copilot/how-tos/copilot-sdk/features","title":"Features"},{"href":"/pt/copilot/how-tos/copilot-sdk/features/citations","title":"Citações"}],"documentType":"article"},"body":"# Citações\n\nAs citações vinculam trechos de uma resposta do assistente às fontes que os sustentam. Ative enableCitations ao criar ou retomar uma sessão e, em seguida, leia o payload citations nos eventos assistant.message para exibir notas de rodapé, listas de fontes ou links inline.\n\n<!-- markdownlint-disable GHD046 GHD005 -->\n\n<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->\n\n> \\[!WARNING]\n> As citações são um recurso experimental. O nome da opção, o conteúdo do evento e a cobertura do provedor podem ser alterados em uma versão futura.\n\n## Como funcionam as citações\n\nAs citações são produzidas pelo provedor de modelos, não pelo SDK. O fluxo tem três partes:\n\n1. Seu aplicativo fornece material citavel, como um anexo de documento ou um resultado de ferramenta que carrega o conteúdo de origem.\n2. O runtime marca esse material como citável na transmissão quando `enableCitations` estiver ativado. Para modelos da Anthropic, os anexos de arquivo são enviados como blocos `document` com citações ativadas.\n3. O modelo retorna metadados de citação, e o ambiente de execução os normaliza em um objeto `citations` independente de provedor no evento final `assistant.message`.\n\nO suporte ao provedor é limitado. O campo `provider` em cada registro da fonte indica de onde veio a citação:\n\n| Valor do provedor | Meaning                                                           |\n| ----------------- | ----------------------------------------------------------------- |\n| `anthropic`       | Citação produzida por uma resposta do modelo Claude, da Anthropic |\n| `openai`          | Citação produzida por uma resposta de um modelo da OpenAI         |\n| `client`          | Citação sintetizada pelo runtime a partir da saída da ferramenta  |\n\n> \\[!NOTE]\n> `enableCitations` Ativar não garante que uma resposta contenha citações. Os modelos só os emitem quando a resposta é baseada em material-fonte citável. Sempre trate o `citations` campo como opcional.\n\n## Habilitar citações em uma sessão\n\nDefina a opção na criação da sessão e defina-a novamente no currículo se desejar citações após uma reinicialização.\n\n<div class=\"ghd-codetabs\">\n<div class=\"ghd-codetab\" data-lang=\"typescript\" data-label=\"TypeScript\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">TypeScript</div>\n\n<!-- docs-validate: skip -->\n\n```typescript\nconst session = await client.createSession({\n    onPermissionRequest: approveAll,\n    enableCitations: true,\n});\n\nconst resumed = await client.resumeSession(session.sessionId, {\n    onPermissionRequest: approveAll,\n    enableCitations: true,\n});\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"python\" data-label=\"Python\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Python</div>\n\n<!-- docs-validate: skip -->\n\n```python\nsession = await client.create_session(\n    on_permission_request=PermissionHandler.approve_all,\n    enable_citations=True,\n)\n\nresumed = await client.resume_session(\n    session.session_id,\n    on_permission_request=PermissionHandler.approve_all,\n    enable_citations=True,\n)\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"go\" data-label=\"Go\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Go</div>\n\n<!-- docs-validate: skip -->\n\n```golang\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n    OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n    EnableCitations:     copilot.Bool(true),\n})\n\nresumed, err := client.ResumeSession(ctx, session.SessionID, &copilot.ResumeSessionConfig{\n    OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n    EnableCitations:     copilot.Bool(true),\n})\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"dotnet\" data-label=\".NET\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">.NET</div>\n\n<!-- docs-validate: skip -->\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n    OnPermissionRequest = PermissionHandler.ApproveAll,\n    EnableCitations = true,\n});\n\nvar resumed = await client.ResumeSessionAsync(session.SessionId, new ResumeSessionConfig\n{\n    OnPermissionRequest = PermissionHandler.ApproveAll,\n    EnableCitations = true,\n});\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"java\" data-label=\"Java\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Java</div>\n\n<!-- docs-validate: skip -->\n\n```java\nCopilotSession session = client\n        .createSession(new SessionConfig()\n                .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n                .setEnableCitations(true))\n        .get();\n\nCopilotSession resumed = client\n        .resumeSession(session.getSessionId(), new ResumeSessionConfig()\n                .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n                .setEnableCitations(true))\n        .get();\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"rust\" data-label=\"Rust\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Rust</div>\n\n<!-- docs-validate: skip -->\n\n```rust\nlet session = client\n    .create_session(\n        SessionConfig::new()\n            .approve_all_permissions()\n            .with_enable_citations(true),\n    )\n    .await?;\n\nlet resumed = client\n    .resume_session(\n        ResumeSessionConfig::new(session.id().clone())\n            .approve_all_permissions()\n            .with_enable_citations(true),\n    )\n    .await?;\n```\n\n</div>\n\n</div>\n\n## Ler citações de mensagens do assistente\n\nAs citações são recebidas no evento final `assistant.message`, não nos eventos `assistant.message_delta`. Aguarde a mensagem final antes de renderizar marcadores de origem.\n\n<div class=\"ghd-codetabs\">\n<div class=\"ghd-codetab\" data-lang=\"typescript\" data-label=\"TypeScript\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">TypeScript</div>\n\n<!-- docs-validate: skip -->\n\n```typescript\nsession.on((event) => {\n    if (event.type !== \"assistant.message\" || !event.data.citations) {\n        return;\n    }\n\n    const { sources, spans } = event.data.citations;\n    const sourceById = new Map(sources.map((source) => [source.id, source]));\n\n    for (const span of spans) {\n        const quoted = event.data.content.slice(span.startIndex, span.endIndex);\n        for (const reference of span.references) {\n            const source = sourceById.get(reference.sourceId);\n            const label = source?.title ?? source?.url ?? source?.path ?? source?.id;\n            console.log(`\"${quoted}\" — ${label}`);\n        }\n    }\n});\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"python\" data-label=\"Python\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Python</div>\n\n<!-- docs-validate: skip -->\n\n```python\nfrom copilot.session_events import SessionEventType\n\ndef utf16_slice(text: str, start: int, end: int) -> str:\n    \"\"\"Slice by UTF-16 code units, which is how span offsets are measured.\"\"\"\n    units = text.encode(\"utf-16-le\")\n    return units[start * 2 : end * 2].decode(\"utf-16-le\")\n\ndef handle(event):\n    if event.type != SessionEventType.ASSISTANT_MESSAGE or not event.data.citations:\n        return\n\n    sources = {source.id: source for source in event.data.citations.sources}\n\n    for span in event.data.citations.spans:\n        quoted = utf16_slice(event.data.content, span.start_index, span.end_index)\n        for reference in span.references:\n            source = sources[reference.source_id]\n            label = source.title or source.url or source.path or source.id\n            print(f'\"{quoted}\" — {label}')\n\nsession.on(handle)\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"go\" data-label=\"Go\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Go</div>\n\n<!-- docs-validate: skip -->\n\n```golang\n// import \"unicode/utf16\"\n\nsession.On(func(event copilot.SessionEvent) {\n    d, ok := event.Data.(*copilot.AssistantMessageData)\n    if !ok || d.Citations == nil {\n        return\n    }\n\n    sources := map[string]copilot.CitationSource{}\n    for _, source := range d.Citations.Sources {\n        sources[source.ID] = source\n    }\n\n    // Span offsets are UTF-16 code units, so index the UTF-16 view of the content.\n    units := utf16.Encode([]rune(d.Content))\n\n    for _, span := range d.Citations.Spans {\n        quoted := string(utf16.Decode(units[span.StartIndex:span.EndIndex]))\n        for _, reference := range span.References {\n            source := sources[reference.SourceID]\n            label := source.ID\n            switch {\n            case source.Title != nil:\n                label = *source.Title\n            case source.URL != nil:\n                label = *source.URL\n            case source.Path != nil:\n                label = *source.Path\n            }\n            fmt.Printf(\"%q — %s\\n\", quoted, label)\n        }\n    }\n})\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"dotnet\" data-label=\".NET\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">.NET</div>\n\n<!-- docs-validate: skip -->\n\n```csharp\nsession.On<SessionEvent>(evt =>\n{\n    if (evt is not AssistantMessageEvent message || message.Data.Citations is null)\n    {\n        return;\n    }\n\n    var sources = message.Data.Citations.Sources.ToDictionary(source => source.Id);\n\n    foreach (var span in message.Data.Citations.Spans)\n    {\n        var quoted = message.Data.Content[(int)span.StartIndex..(int)span.EndIndex];\n        foreach (var reference in span.References)\n        {\n            var source = sources[reference.SourceId];\n            var label = source.Title ?? source.Url ?? source.Path ?? source.Id;\n            Console.WriteLine($\"\\\"{quoted}\\\" — {label}\");\n        }\n    }\n});\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"java\" data-label=\"Java\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Java</div>\n\n<!-- docs-validate: skip -->\n\n```java\nsession.on(AssistantMessageEvent.class, event -> {\n    Citations citations = event.getData().citations();\n    if (citations == null) {\n        return;\n    }\n\n    Map<String, CitationSource> sources = citations.sources().stream()\n            .collect(Collectors.toMap(CitationSource::id, source -> source));\n\n    for (CitationSpan span : citations.spans()) {\n        String quoted = event.getData().content()\n                .substring(span.startIndex().intValue(), span.endIndex().intValue());\n        for (CitationReference reference : span.references()) {\n            CitationSource source = sources.get(reference.sourceId());\n            String label = source.title() != null ? source.title()\n                    : source.url() != null ? source.url()\n                    : source.path() != null ? source.path()\n                    : source.id();\n            System.out.printf(\"\\\"%s\\\" — %s%n\", quoted, label);\n        }\n    }\n});\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"rust\" data-label=\"Rust\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Rust</div>\n\n<!-- docs-validate: skip -->\n\n```rust\nuse github_copilot_sdk::session_events::AssistantMessageData;\nuse std::collections::HashMap;\n\nlet mut events = session.subscribe();\n\nwhile let Ok(event) = events.recv().await {\n    if event.event_type != \"assistant.message\" {\n        continue;\n    }\n\n    let Some(data) = event.typed_data::<AssistantMessageData>() else {\n        continue;\n    };\n    let Some(citations) = data.citations.as_ref() else {\n        continue;\n    };\n\n    let sources: HashMap<&str, _> = citations\n        .sources\n        .iter()\n        .map(|source| (source.id.as_str(), source))\n        .collect();\n\n    // Span offsets are UTF-16 code units, so index the UTF-16 view of the content.\n    let units: Vec<u16> = data.content.encode_utf16().collect();\n\n    for span in &citations.spans {\n        let quoted = String::from_utf16_lossy(\n            &units[span.start_index as usize..span.end_index as usize],\n        );\n        for reference in &span.references {\n            let Some(source) = sources.get(reference.source_id.as_str()) else {\n                continue;\n            };\n            let label = source\n                .title\n                .as_deref()\n                .or(source.url.as_deref())\n                .or(source.path.as_deref())\n                .unwrap_or(source.id.as_str());\n            println!(\"\\\"{quoted}\\\" — {label}\");\n        }\n    }\n}\n```\n\n</div>\n\n</div>\n\n## Referência de payload de citação\n\nO objeto `citations` separa as fontes deduplicadas dos trechos que fazem referência a elas, de modo que uma fonte citada cinco vezes aparece uma única vez em `sources`.\n\n| Tipo                | Campo               | Description                                                                                                 |\n| ------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |\n| `Citations`         | `sources`           | Conjunto de fontes sem duplicatas referenciado pelos trechos de citação                                     |\n| `Citations`         | `spans`             | Trechos de texto gerado anotados com suas fontes de apoio                                                   |\n| `CitationSource`    | `id`                | Identificador estável com escopo de rodada referenciado por `CitationReference.sourceId`                    |\n| `CitationSource`    | `provider`          | Sistema que produziu a citação: `anthropic`, `openai`ou `client`                                            |\n| `CitationSource`    | `title?`            | Título legível da fonte                                                                                     |\n| `CitationSource`    | `url?`              | URL da origem, quando é um recurso da Web                                                                   |\n| `CitationSource`    | `path?`             | Caminho do arquivo relativo à raiz do espaço de trabalho do agente, quando a origem é um arquivo            |\n| `CitationSpan`      | `startIndex`        | Iniciar deslocamento no conteúdo da mensagem final (unidades de código UTF-16, baseadas em zero, inclusive) |\n| `CitationSpan`      | `endIndex`          | Deslocamento final no conteúdo da mensagem final (unidades de código UTF-16, baseadas em zero, exclusivas)  |\n| `CitationSpan`      | `references`        | As fontes que dão suporte a esse intervalo                                                                  |\n| `CitationReference` | `sourceId`          | Identificador do(a) `CitationSource` para o(a) qual esta referência aponta                                  |\n| `CitationReference` | `citedText?`        | Texto exato da origem que dá suporte à expansão, quando o modelo o fornece                                  |\n| `CitationReference` | `location?`         | Local na fonte que dá suporte à expansão                                                                    |\n| `CitationReference` | `providerMetadata?` | Dados de correlação nativos do provedor, passados de forma opaca                                            |\n\n> \\[!TIP]\n> Os deslocamentos de expansão são medidos em unidades de código UTF-16 em relação à cadeia de caracteres `content` final. As cadeias de caracteres typeScript, Java e .NET já são UTF-16, para que você possa segmentá-las diretamente. As cadeias de caracteres em Python são indexadas por ponto de código Unicode, e as strings em Go e Rust usam UTF-8; portanto, converta o conteúdo para unidades de código UTF-16 antes de fatiá-lo, como fazem os exemplos acima.\n\n### Locais de citação\n\n`CitationReference.location` é uma união discriminada inserida por `type`:\n\n| Tipo de localização      | Campos                                                      | Utilização |\n| ------------------------ | ----------------------------------------------------------- | ---------- |\n| `char`                   |                                                             |            |\n| `startIndex`, `endIndex` | Intervalo de caracteres dentro do texto de origem           |            |\n| `page`                   |                                                             |            |\n| `startPage`, `endPage`   | Intervalo de páginas em um documento paginado               |            |\n| `block`                  |                                                             |            |\n| `startBlock`, `endBlock` | Intervalo de blocos de conteúdo em um documento estruturado |            |\n\n## Fornecer fontes citaveis\n\nAs citações precisam de material de origem que o modelo possa atribuir. Há duas maneiras de fornecê-lo.\n\n### Anexar documentos a uma mensagem\n\nQuando as citações são habilitadas e a sessão usa um provedor de Anthropic, os anexos de arquivo são enviados como `document` blocos com citações ativadas, de modo que o modelo pode citar passagens deles.\n\n<!-- docs-validate: skip -->\n\n```typescript\nawait session.sendAndWait({\n    prompt: \"Summarize the attached PDF and cite the passages you used.\",\n    attachments: [\n        {\n            type: \"blob\",\n            data: pdfBase64,\n            displayName: \"quarterly-report.pdf\",\n            mimeType: \"application/pdf\",\n        },\n    ],\n});\n```\n\nConsulte [Entrada de imagem](/pt/copilot/how-tos/copilot-sdk/features/image-input) para obter a API de anexos e os formatos de anexo `file` e `blob`.\n\n### Retornar fontes citaveis de uma ferramenta\n\nOs resultados da ferramenta carregam uma matriz experimental `citableSources` . Cada entrada fornece `content`, que o modelo pode citar, juntamente com um `id` e, opcionalmente, `title`, `url` e `path`. Essas origens persistem com o resultado da ferramenta; portanto, permanecem disponíveis após a retomada da sessão, e as citações criadas direto delas são marcadas com o provedor `client`.\n\n## Limitations\n\n* As citações são experimentais em cada SDK e não são cobertas por garantias de compatibilidade.\n* A cobertura depende do provedor do modelo. Uma sessão configurada para um provedor sem suporte a citações não emite payload `citations`.\n* As citações estão presentes somente no evento `assistant.message` final; portanto, os consumidores de streaming não podem renderizá-las como resposta mediana.\n* O código público e as citações de duplicação de IP não fazem parte dessa superfície.\n\n## Leitura adicional\n\n* [Eventos de sessão de streaming](/pt/copilot/how-tos/copilot-sdk/features/streaming-events): assinar os eventos da sessão e restringir os tipos de evento\n* [Entrada de imagem](/pt/copilot/how-tos/copilot-sdk/features/image-input): anexar arquivos e blobs na memória a uma mensagem\n* [Retomada e persistência da sessão](/pt/copilot/how-tos/copilot-sdk/features/session-persistence): retomar sessões e aplicar novamente as opções de sessão\n* [Compatibilidade do SDK e da CLI](/pt/copilot/how-tos/copilot-sdk/troubleshooting/compatibility): Matriz de recursos do SDK e da CLI"}