This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Retrieve relevant context for a user message from the data sources configured for the session.
This allows clients to pre-retrieve context for a user message before sending it to the Agent with the contextsOverride option when continuing a session, to allow any pre-processing of the context before sending it to the Agent.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-write.
stringAn RID identifying an AIP Agent created in AIP Agent Studio.
stringThe Resource Identifier (RID) of the conversation session.
objectobjectThe user message to retrieve relevant context for from the configured Agent data sources.
map<ParameterId, ParameterValue>Any parameter values to use for the context retrieval.
objectContext retrieved from an Agent's configured context data sources which was relevant to the supplied user message.
list<ObjectContext>1
2
3
4
5
curl -X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions/ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6/ragContext?preview=true" \
-d '{"userInput":{"text":"What is the status of my order?"}}'1
2
3
4
5
6
7
8
9
10
11
12
{
"objectContexts": [
{
"objectRids": [
"ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"
],
"propertyTypeRids": [
"ri.ontology.main.property.7899aeb4-a389-4f2e-a0fd-e7193a4f6cb1"
]
}
]
}