openai/chatkit-python
Publicmirrored fromhttps://github.com/openai/chatkit-pythonAvailable
docs/guides/add-annotations.md
161lines · modecode
| 1 | # Add annotations in assistant messages |
| 2 | |
| 3 | ChatKit renders clickable inline citations when assistant text includes `annotations` and rolls every reference into a collapsed **Sources** list beneath each message. You can let the model emit annotations directly or attach sources yourself before streaming the message. |
| 4 | |
| 5 | ## Use model-emitted citations |
| 6 | |
| 7 | When you stream a Responses run through `stream_agent_response`, ChatKit automatically converts any `file_citation`, `container_file_citation`, and `url_citation` annotations returned by the OpenAI API into ChatKit `Annotation` objects and attaches them to streamed message content. |
| 8 | |
| 9 | Provide the model with citable evidence via tools to receive citation annotations, most commonly: |
| 10 | |
| 11 | - `FileSearchTool` for uploaded documents (emits `file_citation` / `container_file_citation`) |
| 12 | - `WebSearchTool` for live URLs (emits `url_citation`) |
| 13 | |
| 14 | No additional server-side wiring is required beyond calling `stream_agent_response`. If the model emits citation annotations from tool usage, ChatKit will forward them automatically as `Annotation` objects on the corresponding content parts. |
| 15 | |
| 16 | ### Customize how citations are converted |
| 17 | |
| 18 | Sometimes the default rendering for model-emitted citations is not very helpful. For example, file citations may not include enough metadata for ChatKit to show a meaningful default title or description. You can pass a custom [`ResponseStreamConverter`](../../api/chatkit/agents/#chatkit.agents.ResponseStreamConverter) and override: |
| 19 | |
| 20 | - `file_citation_to_annotation` |
| 21 | - `container_file_citation_to_annotation` |
| 22 | - `url_citation_to_annotation` |
| 23 | |
| 24 | Here is a minimal example that enriches file citations with a more helpful title/description using an internal mapping: |
| 25 | |
| 26 | ```python |
| 27 | from chatkit.agents import ResponseStreamConverter, stream_agent_response |
| 28 | from chatkit.types import Annotation, FileSource |
| 29 | |
| 30 | |
| 31 | class MyResponseStreamConverter(ResponseStreamConverter): |
| 32 | def __init__(self, file_lookup: dict[str, dict[str, str]]): |
| 33 | super().__init__() |
| 34 | self._file_lookup = file_lookup |
| 35 | |
| 36 | async def file_citation_to_annotation(self, citation): |
| 37 | info = self._file_lookup.get(citation.file_id, {}) |
| 38 | return Annotation( |
| 39 | source=FileSource( |
| 40 | filename=info.get("filename", citation.file_id), |
| 41 | title=info.get("title"), |
| 42 | description=info.get("description"), |
| 43 | ), |
| 44 | index=citation.index, |
| 45 | ) |
| 46 | |
| 47 | |
| 48 | converter = MyResponseStreamConverter( |
| 49 | file_lookup={ |
| 50 | "file_123": { |
| 51 | "filename": "q1_report.pdf", |
| 52 | "title": "Q1 Report", |
| 53 | "description": "Quarterly performance summary", |
| 54 | } |
| 55 | } |
| 56 | ) |
| 57 | |
| 58 | stream_agent_response(..., converter=converter) |
| 59 | ``` |
| 60 | |
| 61 | You can also return an `EntitySource` instead of a `FileSource` to control the inline label, handle clicks, and customize the popover preview. For more on entity annotations (including `interactive` click/preview hooks), see [Annotating with custom entities](#annotating-with-custom-entities) below. |
| 62 | |
| 63 | |
| 64 | ## Attach sources manually |
| 65 | |
| 66 | If you build assistant messages yourself, include annotations on each `AssistantMessageContent` item. |
| 67 | |
| 68 | ```python |
| 69 | from datetime import datetime |
| 70 | from chatkit.types import ( |
| 71 | Annotation, |
| 72 | AssistantMessageContent, |
| 73 | AssistantMessageItem, |
| 74 | FileSource, |
| 75 | ThreadItemDoneEvent, |
| 76 | URLSource, |
| 77 | ) |
| 78 | |
| 79 | text = "Quarterly revenue grew 12% year over year." |
| 80 | annotations = [ |
| 81 | Annotation( |
| 82 | source=FileSource(filename="q1_report.pdf", title="Q1 Report"), |
| 83 | index=len(text) - 1, # attach near the end of the sentence |
| 84 | ), |
| 85 | Annotation( |
| 86 | source=URLSource( |
| 87 | url="https://example.com/press-release", |
| 88 | title="Press release", |
| 89 | ), |
| 90 | index=len(text) - 1, |
| 91 | ), |
| 92 | ] |
| 93 | |
| 94 | yield ThreadItemDoneEvent( |
| 95 | item=AssistantMessageItem( |
| 96 | id=self.store.generate_item_id("message", thread, context), |
| 97 | thread_id=thread.id, |
| 98 | created_at=datetime.now(), |
| 99 | content=[AssistantMessageContent(text=text, annotations=annotations)], |
| 100 | ) |
| 101 | ) |
| 102 | ``` |
| 103 | |
| 104 | `index` is the character position to place the footnote marker; re-use the same index when multiple citations support the same claim so the footnote numbers stay grouped. |
| 105 | |
| 106 | ## Annotating with custom entities |
| 107 | |
| 108 | You can attach `EntitySource` items as annotations to show entity references inline in assistant text and in the **Sources** list below the message. |
| 109 | |
| 110 | Entity annotations support a few UI-focused fields: |
| 111 | |
| 112 | - `icon`: Controls the icon shown for the entity in the default inline/hover UI. |
| 113 | - `label`: Customizes what's shown in the default entity hover header (when you are not rendering a custom preview). |
| 114 | - `inline_label`: Shows a label inline instead of an icon. |
| 115 | - `interactive=True`: Wires the annotation to client-side callbacks (`ChatKitOptions.entities.onClick` and `ChatKitOptions.entities.onRequestPreview`). |
| 116 | |
| 117 | ```python |
| 118 | from datetime import datetime |
| 119 | from chatkit.types import ( |
| 120 | Annotation, |
| 121 | AssistantMessageContent, |
| 122 | AssistantMessageItem, |
| 123 | EntitySource, |
| 124 | ThreadItemDoneEvent, |
| 125 | ) |
| 126 | |
| 127 | text = "Here are the ACME account details for reference." |
| 128 | |
| 129 | annotations = [ |
| 130 | Annotation( |
| 131 | source=EntitySource( |
| 132 | id="customer_123", |
| 133 | title="ACME Corp", |
| 134 | description="Enterprise plan · 500 seats", |
| 135 | icon="suitcase", |
| 136 | label="Customer", |
| 137 | interactive=True, |
| 138 | # Free-form data object passed to your client-side entity callbacks |
| 139 | data={"href": "https://crm.example.com/customers/123"}, |
| 140 | ), |
| 141 | # `index` controls where the inline marker is placed in the text. |
| 142 | index=text.index("ACME") + len("ACME"), |
| 143 | ) |
| 144 | ] |
| 145 | |
| 146 | yield ThreadItemDoneEvent( |
| 147 | item=AssistantMessageItem( |
| 148 | id=self.store.generate_item_id("message", thread, context), |
| 149 | thread_id=thread.id, |
| 150 | created_at=datetime.now(), |
| 151 | content=[ |
| 152 | AssistantMessageContent( |
| 153 | text=text, |
| 154 | annotations=annotations, |
| 155 | ) |
| 156 | ], |
| 157 | ) |
| 158 | ) |
| 159 | ``` |
| 160 | |
| 161 | Provide richer previews and navigation by handling [`entities.onRequestPreview`](https://openai.github.io/chatkit-js/api/openai/chatkit/type-aliases/entitiesoption/#onrequestpreview) and [`entities.onClick`](https://openai.github.io/chatkit-js/api/openai/chatkit/type-aliases/entitiesoption/#onclick) in ChatKit.js. These callbacks are only invoked for entity annotations with `interactive=True`; use the `data` payload to pass entity information and deep link into your app. |
| 162 | |