Response with inline citations
Below is an example of a response from a Knowledge Graph that includes inline citations:
Corresponding references array
Below is the corresponding
references
object that contains a direct snippet from the source file that was used to support the response:Enable inline citations
To enable inline citations in Knowledge Graph responses, setinline_citations: true
in your query_config
parameter when making direct Knowledge Graph queries via the /v1/graphs/question
endpoint.
cURL
Citation format and correlation
Citation format
Inline citations appear in the answer from the LLM as[filename.pdf](cite_id)
, where:
filename.pdf
is the name of the source filecite_id
is a unique identifier that matches thecite
field in thereferences
object
Correlate citations with references
Inline citations in the response text correspond to entries in thereferences
array. Each citation uses the cite
field from the references array as its identifier.
Example correlation:
Here’s an example showing how inline citations correlate with the references array:
Response text:
- Citation
[Acme-Product-Catalog.pdf](a1b2c3d4-e5f6-7890-abcd-ef1234567890)
uses thecite
field from the first reference object - Citation
[Acme-Product-Catalog.pdf](b2c3d4e5-f6g7-8901-bcde-f23456789012)
uses thecite
field from the second reference object
Response format
Knowledge Graph responses include areferences
object with files
and web
objects. The files
object contains file
objects for file-based sources and the web
object contains web
objects for web-based sources.
File sources (references.file
objects)
Field | Type | Description |
---|---|---|
text | string | The actual text snippet from the source document that supports the response |
fileId | string | Unique identifier for the source file |
score | number | Internal score used during the retrieval process for ranking and selecting relevant snippets |
page | integer | Page number where the snippet was found in the source document |
cite | string | Unique identifier used in inline citations within the response text |
Web sources (references.web
objects)
Field | Type | Description |
---|---|---|
text | string | The actual text snippet from the web page that supports the response |
url | string | URL of the source web page |
title | string | Title of the web page |
score | number | Internal score used during the retrieval process for ranking and selecting relevant snippets |
cite | string | Unique identifier used in inline citations within the response text |
Streaming responses
When using streaming responses with Knowledge Graph tools, thereferences
object containing sources and citations is sent in the last chunk of the stream. This means:
- Content chunks: The response text with inline citations is streamed progressively
- Final chunk: Contains the graph data with the complete
references
object - Citation processing: You need to collect all chunks and process the final one to access source text
Next steps
- Learn about Knowledge Graph query configuration for tuning search parameters
- Explore Knowledge Graph tools for chat completions
- Check out direct Knowledge Graph queries for programmatic access