Sessions
Examples
Optional query and approach pairs that steer Explore Memories.
examples is an optional list of query and approach pairs that show the agent how to handle typical questions. Your server sets them when creating a createAgentTask session. The React SDK only receives a clientToken and cannot change them.
How examples apply per task type:
| Task type | examples |
|---|---|
EXPLORE_MEMORIES | Optional. A list of query and approach pairs. |
EXPLORE_PRODUCT | Not supported |
MEMORY_CHAT | Not supported |
MEMORY_SEARCH | Not supported |
STREAMING_CHAT_COMPLETION | Not supported |
STRUCTURED_CHAT_COMPLETION | Not supported |
How they work
Each item needs:
query: an example user questionapproach: how the agent should handle that question
Leave examples off when you do not want to steer the agent with sample questions. Sending examples on any other task type is rejected.
Examples
EXPLORE_MEMORIES
{
createAgentTask: {
taskType: 'EXPLORE_MEMORIES',
examples: [
{
query: 'Which parents lack a matching child?',
approach: 'Use keywordSearch parentForEach and filter empty search_matching_memory_ids.',
},
],
},
}See Sessions for full request bodies per task type.