Featured AI Products
Compute
Build, deploy, and scale cloud compute resources
Containers and Images
Safely store and manage containers and backups
Managed Databases
Fully managed resources running popular database engines
Management and Dev Tools
Control infrastructure and gather insights
Networking
Secure and control traffic to apps
Security
Help protect your account and resources with these security features
Storage
Store and access any amount of data reliably in the cloud
Browse all products
AI/ML
CMS
Data and IoT
Developer Tools
Gaming and Media
Hosting
Security and Networking
Startups and SMBs
Web and App Platforms
See all solutions
Community
Documentation
Developer Tools
Get Involved
Utilities and Help
Become a Partner
Marketplace
Pricing

- Community
- DigitalOcean
- Community
- DigitalOcean

Is the "Include citations" checkbox in Agent settings the same as `"include_retrieval_info": true` in the API?

Posted on May 11, 2025

Does this setting only affect the “playground” and the provided chatbot widget or does it also change the API behavior?

It’s not clear exactly how this works and.what it’s supposed to do. In the playground it’s functionality seems to just hyper link to the same information that is linked from “Message Info” below every message whether that checkbox is checked or not.

This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

These answers are provided by our Community. If you find them useful, show some love by clicking the heart. If you run into issues leave a comment, or add your own answer to help others.

Bobby

May 12, 2025

Hey Setec,

From what I can tell, the “Include citations” checkbox in the Agent settings mainly affects how citations are displayed in the Playground and the built-in chatbot widget, I guess that it is likely it doesn’t change API behavior on its own.

If you’re working with the API directly and want retrieval metadata like source documents or citations, you probably need to set "include_retrieval_info": true explicitly in your request. I think that this seems to be what controls whether the retrievals field is returned in the response.

So while the checkbox and the API flag appear to serve similar purposes, they don’t seem to be directly linked, at least not in a way that impacts the API output automatically. But I haven’t found official confirmation on this.

Has the DigitalOcean support team been able to confirm if this is the case?

- Bobby

The developer cloud

Scale up as you grow — whether you're running one virtual machine or ten thousand.

View all products

Start building today

From GPU-powered inference and Kubernetes to managed databases and storage, get everything you need to build, scale, and deploy intelligent applications.