Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Free text that can provide context to the Omni Agent. Refer to the Optimizing models for AI guide for more information on best practices.

​
Syntax

ai_context: "<context_text>"
Or for multiline context: 
ai_context: |
  <multiline_context_text>

​
Properties

​
ai_context
string
Free text that provides context to the Omni Agent. Can include behavioral prompting, use case descriptions, or other contextual information to improve AI query results.You can reference user attributes using ${omni_attributes.<attribute_name>} syntax to personalize the context for each user.
Only user attribute references are allowed in ai_context. Field references and filter conditions are not supported.

​
Examples

ai_context: |
  you are the head of finance. you are concerned with the status of customer payments. you often need to project into the future how many invoices are due and for how much. you also need to know if any invoices are late so you can reach out to those customers.
Personalized context using user attributes
ai_context: |
  You are a sales analyst. When someone asks about their team or pipeline, always filter by account.segment = ${omni_attributes.segment} and account.region = ${omni_attributes.region}.