# Citações

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.

<!-- markdownlint-disable GHD046 GHD005 -->

<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->

> \[!WARNING]
> 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.

## Como funcionam as citações

As citações são produzidas pelo provedor de modelos, não pelo SDK. O fluxo tem três partes:

1. Seu aplicativo fornece material citavel, como um anexo de documento ou um resultado de ferramenta que carrega o conteúdo de origem.
2. 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.
3. 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`.

O suporte ao provedor é limitado. O campo `provider` em cada registro da fonte indica de onde veio a citação:

| Valor do provedor | Meaning                                                           |
| ----------------- | ----------------------------------------------------------------- |
| `anthropic`       | Citação produzida por uma resposta do modelo Claude, da Anthropic |
| `openai`          | Citação produzida por uma resposta de um modelo da OpenAI         |
| `client`          | Citação sintetizada pelo runtime a partir da saída da ferramenta  |

> \[!NOTE]
> `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.

## Habilitar citações em uma sessão

Defina 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.

<div class="ghd-codetabs">
<div class="ghd-codetab" data-lang="typescript" data-label="TypeScript"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">TypeScript</div>

<!-- docs-validate: skip -->

```typescript
const session = await client.createSession({
    onPermissionRequest: approveAll,
    enableCitations: true,
});

const resumed = await client.resumeSession(session.sessionId, {
    onPermissionRequest: approveAll,
    enableCitations: true,
});
```

</div>

<div class="ghd-codetab" data-lang="python" data-label="Python"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Python</div>

<!-- docs-validate: skip -->

```python
session = await client.create_session(
    on_permission_request=PermissionHandler.approve_all,
    enable_citations=True,
)

resumed = await client.resume_session(
    session.session_id,
    on_permission_request=PermissionHandler.approve_all,
    enable_citations=True,
)
```

</div>

<div class="ghd-codetab" data-lang="go" data-label="Go"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Go</div>

<!-- docs-validate: skip -->

```golang
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
    OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
    EnableCitations:     copilot.Bool(true),
})

resumed, err := client.ResumeSession(ctx, session.SessionID, &copilot.ResumeSessionConfig{
    OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
    EnableCitations:     copilot.Bool(true),
})
```

</div>

<div class="ghd-codetab" data-lang="dotnet" data-label=".NET"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">.NET</div>

<!-- docs-validate: skip -->

```csharp
var session = await client.CreateSessionAsync(new SessionConfig
{
    OnPermissionRequest = PermissionHandler.ApproveAll,
    EnableCitations = true,
});

var resumed = await client.ResumeSessionAsync(session.SessionId, new ResumeSessionConfig
{
    OnPermissionRequest = PermissionHandler.ApproveAll,
    EnableCitations = true,
});
```

</div>

<div class="ghd-codetab" data-lang="java" data-label="Java"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Java</div>

<!-- docs-validate: skip -->

```java
CopilotSession session = client
        .createSession(new SessionConfig()
                .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
                .setEnableCitations(true))
        .get();

CopilotSession resumed = client
        .resumeSession(session.getSessionId(), new ResumeSessionConfig()
                .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
                .setEnableCitations(true))
        .get();
```

</div>

<div class="ghd-codetab" data-lang="rust" data-label="Rust"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Rust</div>

<!-- docs-validate: skip -->

```rust
let session = client
    .create_session(
        SessionConfig::new()
            .approve_all_permissions()
            .with_enable_citations(true),
    )
    .await?;

let resumed = client
    .resume_session(
        ResumeSessionConfig::new(session.id().clone())
            .approve_all_permissions()
            .with_enable_citations(true),
    )
    .await?;
```

</div>

</div>

## Ler citações de mensagens do assistente

As 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.

<div class="ghd-codetabs">
<div class="ghd-codetab" data-lang="typescript" data-label="TypeScript"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">TypeScript</div>

<!-- docs-validate: skip -->

```typescript
session.on((event) => {
    if (event.type !== "assistant.message" || !event.data.citations) {
        return;
    }

    const { sources, spans } = event.data.citations;
    const sourceById = new Map(sources.map((source) => [source.id, source]));

    for (const span of spans) {
        const quoted = event.data.content.slice(span.startIndex, span.endIndex);
        for (const reference of span.references) {
            const source = sourceById.get(reference.sourceId);
            const label = source?.title ?? source?.url ?? source?.path ?? source?.id;
            console.log(`"${quoted}" — ${label}`);
        }
    }
});
```

</div>

<div class="ghd-codetab" data-lang="python" data-label="Python"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Python</div>

<!-- docs-validate: skip -->

```python
from copilot.session_events import SessionEventType

def utf16_slice(text: str, start: int, end: int) -> str:
    """Slice by UTF-16 code units, which is how span offsets are measured."""
    units = text.encode("utf-16-le")
    return units[start * 2 : end * 2].decode("utf-16-le")

def handle(event):
    if event.type != SessionEventType.ASSISTANT_MESSAGE or not event.data.citations:
        return

    sources = {source.id: source for source in event.data.citations.sources}

    for span in event.data.citations.spans:
        quoted = utf16_slice(event.data.content, span.start_index, span.end_index)
        for reference in span.references:
            source = sources[reference.source_id]
            label = source.title or source.url or source.path or source.id
            print(f'"{quoted}" — {label}')

session.on(handle)
```

</div>

<div class="ghd-codetab" data-lang="go" data-label="Go"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Go</div>

<!-- docs-validate: skip -->

```golang
// import "unicode/utf16"

session.On(func(event copilot.SessionEvent) {
    d, ok := event.Data.(*copilot.AssistantMessageData)
    if !ok || d.Citations == nil {
        return
    }

    sources := map[string]copilot.CitationSource{}
    for _, source := range d.Citations.Sources {
        sources[source.ID] = source
    }

    // Span offsets are UTF-16 code units, so index the UTF-16 view of the content.
    units := utf16.Encode([]rune(d.Content))

    for _, span := range d.Citations.Spans {
        quoted := string(utf16.Decode(units[span.StartIndex:span.EndIndex]))
        for _, reference := range span.References {
            source := sources[reference.SourceID]
            label := source.ID
            switch {
            case source.Title != nil:
                label = *source.Title
            case source.URL != nil:
                label = *source.URL
            case source.Path != nil:
                label = *source.Path
            }
            fmt.Printf("%q — %s\n", quoted, label)
        }
    }
})
```

</div>

<div class="ghd-codetab" data-lang="dotnet" data-label=".NET"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">.NET</div>

<!-- docs-validate: skip -->

```csharp
session.On<SessionEvent>(evt =>
{
    if (evt is not AssistantMessageEvent message || message.Data.Citations is null)
    {
        return;
    }

    var sources = message.Data.Citations.Sources.ToDictionary(source => source.Id);

    foreach (var span in message.Data.Citations.Spans)
    {
        var quoted = message.Data.Content[(int)span.StartIndex..(int)span.EndIndex];
        foreach (var reference in span.References)
        {
            var source = sources[reference.SourceId];
            var label = source.Title ?? source.Url ?? source.Path ?? source.Id;
            Console.WriteLine($"\"{quoted}\" — {label}");
        }
    }
});
```

</div>

<div class="ghd-codetab" data-lang="java" data-label="Java"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Java</div>

<!-- docs-validate: skip -->

```java
session.on(AssistantMessageEvent.class, event -> {
    Citations citations = event.getData().citations();
    if (citations == null) {
        return;
    }

    Map<String, CitationSource> sources = citations.sources().stream()
            .collect(Collectors.toMap(CitationSource::id, source -> source));

    for (CitationSpan span : citations.spans()) {
        String quoted = event.getData().content()
                .substring(span.startIndex().intValue(), span.endIndex().intValue());
        for (CitationReference reference : span.references()) {
            CitationSource source = sources.get(reference.sourceId());
            String label = source.title() != null ? source.title()
                    : source.url() != null ? source.url()
                    : source.path() != null ? source.path()
                    : source.id();
            System.out.printf("\"%s\" — %s%n", quoted, label);
        }
    }
});
```

</div>

<div class="ghd-codetab" data-lang="rust" data-label="Rust"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Rust</div>

<!-- docs-validate: skip -->

```rust
use github_copilot_sdk::session_events::AssistantMessageData;
use std::collections::HashMap;

let mut events = session.subscribe();

while let Ok(event) = events.recv().await {
    if event.event_type != "assistant.message" {
        continue;
    }

    let Some(data) = event.typed_data::<AssistantMessageData>() else {
        continue;
    };
    let Some(citations) = data.citations.as_ref() else {
        continue;
    };

    let sources: HashMap<&str, _> = citations
        .sources
        .iter()
        .map(|source| (source.id.as_str(), source))
        .collect();

    // Span offsets are UTF-16 code units, so index the UTF-16 view of the content.
    let units: Vec<u16> = data.content.encode_utf16().collect();

    for span in &citations.spans {
        let quoted = String::from_utf16_lossy(
            &units[span.start_index as usize..span.end_index as usize],
        );
        for reference in &span.references {
            let Some(source) = sources.get(reference.source_id.as_str()) else {
                continue;
            };
            let label = source
                .title
                .as_deref()
                .or(source.url.as_deref())
                .or(source.path.as_deref())
                .unwrap_or(source.id.as_str());
            println!("\"{quoted}\" — {label}");
        }
    }
}
```

</div>

</div>

## Referência de conteúdo de citação

O 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`.

| Tipo                | Campo               | Description                                                                                                 |
| ------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Citations`         | `sources`           | Conjunto de fontes sem duplicatas referenciado pelos trechos de citação                                     |
| `Citations`         | `spans`             | Trechos de texto gerado anotados com suas fontes de apoio                                                   |
| `CitationSource`    | `id`                | Identificador estável com escopo de turno referenciado por `CitationReference.sourceId`                     |
| `CitationSource`    | `provider`          | Sistema que produziu a citação: `anthropic`, `openai`ou `client`                                            |
| `CitationSource`    | `title?`            | Título legível da fonte                                                                                     |
| `CitationSource`    | `url?`              | URL da origem, quando é um recurso da Web                                                                   |
| `CitationSource`    | `path?`             | Caminho do arquivo relativo à raiz do espaço de trabalho do agente, quando a origem é um arquivo            |
| `CitationSpan`      | `startIndex`        | Iniciar deslocamento no conteúdo da mensagem final (unidades de código UTF-16, baseadas em zero, inclusive) |
| `CitationSpan`      | `endIndex`          | Deslocamento final no conteúdo da mensagem final (unidades de código UTF-16, baseadas em zero, exclusivas)  |
| `CitationSpan`      | `references`        | As fontes que dão suporte a esse intervalo                                                                  |
| `CitationReference` | `sourceId`          | Identificador do(a) `CitationSource` para o(a) qual esta referência aponta                                  |
| `CitationReference` | `citedText?`        | Texto exato da origem que dá suporte ao intervalo, quando o modelo o fornece                                |
| `CitationReference` | `location?`         | Local na fonte que dá suporte ao trecho                                                                     |
| `CitationReference` | `providerMetadata?` | Dados de correlação nativos do provedor, passados de forma opaca                                            |

> \[!TIP]
> Os offsets de span são medidos em unidades de código UTF-16 em relação à string final `content`. 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.

### Locais de citação

`CitationReference.location` é uma união discriminada indexada por `type`:

| Tipo de localização      | Campos                                                      | Utilização |
| ------------------------ | ----------------------------------------------------------- | ---------- |
| `char`                   |                                                             |            |
| `startIndex`, `endIndex` | Intervalo de caracteres dentro do texto de origem           |            |
| `page`                   |                                                             |            |
| `startPage`, `endPage`   | Intervalo de páginas em um documento paginado               |            |
| `block`                  |                                                             |            |
| `startBlock`, `endBlock` | Intervalo de blocos de conteúdo em um documento estruturado |            |

## Fornecer fontes citaveis

As citações precisam de material de origem que o modelo possa atribuir. Há duas maneiras de fornecê-lo.

### Anexar documentos a uma mensagem

Quando 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.

<!-- docs-validate: skip -->

```typescript
await session.sendAndWait({
    prompt: "Summarize the attached PDF and cite the passages you used.",
    attachments: [
        {
            type: "blob",
            data: pdfBase64,
            displayName: "quarterly-report.pdf",
            mimeType: "application/pdf",
        },
    ],
});
```

Consulte [Entrada de imagem](/pt/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/image-input) para obter a API de anexos e os formatos de anexo `file` e `blob`.

### Retornar fontes citaveis de uma ferramenta

Os 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 fontes são persistidas com o resultado da ferramenta, portanto permanecem disponíveis após a retomada da sessão, e as citações geradas a partir delas são marcadas com o provedor `client`.

## Limitations

* As citações são experimentais em cada SDK e não são cobertas por garantias de compatibilidade.
* A cobertura depende do provedor do modelo. Uma sessão configurada para um provedor sem suporte a citações não emite payload `citations`.
* As citações só estão presentes no evento final `assistant.message` , portanto, os consumidores de streaming não podem renderizá-las no meio da resposta.
* O código público e as citações de duplicação de IP não fazem parte dessa superfície.

## Leitura adicional

* [Eventos de sessão de streaming](/pt/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/streaming-events): assinar os eventos da sessão e restringir os tipos de evento
* [Entrada de imagem](/pt/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/image-input): anexar arquivos e blobs na memória a uma mensagem
* [Retomada e persistência da sessão](/pt/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/session-persistence): retomar sessões e aplicar novamente as opções de sessão
* [Compatibilidade do SDK e da CLI](/pt/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/compatibility): Matriz de recursos do SDK e da CLI