Custom Instructions

Sometimes, you want to pass in user information for the AI assistant to consider or provide instructions for the AI assistant to follow.

When using the Inkeep uikit components, you can pass this information in using context and guidance as part of the aiChatSettings configuration.

You can make these values dynamic based on user specific information (e.g. for logged in users) or based on the information from your CRM, application logic, or other sources.

context

context can be used to provide additional details about the user that might be helpful information for the bot to consider while answering.

Often, this is used to dynamically provide information about the user that can be inferred by their account (if authenticated to your application) or based on the page they are currently viewing.

Examples

For providing context based on the user:

`The user is currently viewing documentation page ${url}.`

"The user is new to the platform." // (for user life cycle stages)

For providing context based on a product:

`The question is about ${product}.` // (for teams with multiple products)

"The user is using the cloud hosted version of the application." // (for teams with multiple versions or pricing tiers)

Frame context as a single phrase or a bullet point list.

context applies to the entire chat session.

guidance

guidance can be used to customize the behavior of the bot response using natural language. You can think of guidance as custom instructions for the large language model.

We've already optimized chat responses to have proper guardrails for staying on topic, tone, brand-protection, etc.

However, guidance is useful when you want to go beyond the default behavior.

Checkout the Custom Guidance article for tips on how to use it.

guidance applies to the entire chat session, not just the first message.