Session

Method	HTTP request
blocking_continue	POST /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/blockingContinue
cancel	POST /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/cancel
create	POST /v2/aipAgents/agents/{agentRid}/sessions
get	GET /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}
list	GET /v2/aipAgents/agents/{agentRid}/sessions
page	GET /v2/aipAgents/agents/{agentRid}/sessions
rag_context	PUT /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext
streaming_continue	POST /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/streamingContinue

blocking_continue

Continue a conversation session with an Agent, or add the first exchange to a session after creation. Adds a new exchange to the session with the provided inputs, and generates a response from the Agent. Blocks on returning the result of the added exchange until the response is fully generated. Streamed responses are also supported; see streamingContinue for details. Concurrent requests to continue the same session are not supported. Clients should wait to receive a response before sending the next message.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
session_rid	SessionRid	sessionRid
parameter_inputs	Dict[ParameterId, ParameterValueDict]	Any supplied values for application variables to pass to the Agent for the exchange.
user_input	UserTextInputDict	The user message for the Agent to respond to.
contexts_override	Optional[List[InputContextDict]]	If set, automatic context retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.	[optional]
preview	Optional[PreviewMode]	preview	[optional]

Return type

SessionExchangeResult

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# SessionRid | sessionRid
session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
# Dict[ParameterId, ParameterValueDict] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange.
parameter_inputs = None
# UserTextInputDict | The user message for the Agent to respond to.
user_input = {"text": "What is the status of my order?"}
# Optional[List[InputContextDict]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.
contexts_override = None
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.blocking_continue(
        agent_rid,
        session_rid,
        parameter_inputs=parameter_inputs,
        user_input=user_input,
        contexts_override=contexts_override,
        preview=preview,
    )
    print("The blocking_continue response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.blocking_continue: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	SessionExchangeResult	The result of the added exchange for the session.	application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel

Cancel an in-progress streamed exchange with an Agent which was initiated with streamingContinue. Canceling an exchange allows clients to prevent the exchange from being added to the session, or to provide a response to replace the Agent-generated response. Note that canceling an exchange does not terminate the stream returned by streamingContinue; clients should close the stream on triggering the cancellation request to stop reading from the stream.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
session_rid	SessionRid	sessionRid
message_id	MessageId	The identifier for the in-progress exchange to cancel. This should match the `messageId` which was provided when initiating the exchange with `streamingContinue`.
preview	Optional[PreviewMode]	preview	[optional]
response	Optional[AgentMarkdownResponse]	When specified, the exchange is added to the session with the client-provided response as the result. When omitted, the exchange is not added to the session.	[optional]

Return type

CancelSessionResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# SessionRid | sessionRid
session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
# MessageId | The identifier for the in-progress exchange to cancel. This should match the `messageId` which was provided when initiating the exchange with `streamingContinue`.
message_id = "00f8412a-c29d-4063-a417-8052825285a5"
# Optional[PreviewMode] | preview
preview = None
# Optional[AgentMarkdownResponse] | When specified, the exchange is added to the session with the client-provided response as the result. When omitted, the exchange is not added to the session.
response = "The status of your order is **In Transit**."


try:
    api_response = foundry_client.aip_agents.Agent.Session.cancel(
        agent_rid,
        session_rid,
        message_id=message_id,
        preview=preview,
        response=response,
    )
    print("The cancel response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.cancel: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	CancelSessionResponse		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

Create a new conversation session between the calling user and an Agent. Use blockingContinue or streamingContinue to start adding exchanges to the session.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
agent_version	Optional[AgentVersionString]	The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time.	[optional]
preview	Optional[PreviewMode]	preview	[optional]

Return type

Session

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# Optional[AgentVersionString] | The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time.
agent_version = "1.0"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.create(
        agent_rid,
        agent_version=agent_version,
        preview=preview,
    )
    print("The create response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Session	The created Session	application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the details of a conversation session between the calling user and an Agent.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
session_rid	SessionRid	sessionRid
preview	Optional[PreviewMode]	preview	[optional]

Return type

Session

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# SessionRid | sessionRid
session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.get(
        agent_rid,
        session_rid,
        preview=preview,
    )
    print("The get response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Session		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

List all conversation sessions between the calling user and an Agent that was created by this client. This does not list sessions for the user created by other clients. For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
page_size	Optional[PageSize]	pageSize	[optional]
page_token	Optional[PageToken]	pageToken	[optional]
preview	Optional[PreviewMode]	preview	[optional]

Return type

ResourceIterator[Session]

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None
# Optional[PreviewMode] | preview
preview = None


try:
    for session in foundry_client.aip_agents.Agent.Session.list(
        agent_rid,
        page_size=page_size,
        page_token=page_token,
        preview=preview,
    ):
        pprint(session)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.list: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ListSessionsResponse		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

page

List all conversation sessions between the calling user and an Agent that was created by this client. This does not list sessions for the user created by other clients. For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
page_size	Optional[PageSize]	pageSize	[optional]
page_token	Optional[PageToken]	pageToken	[optional]
preview	Optional[PreviewMode]	preview	[optional]

Return type

ListSessionsResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.page(
        agent_rid,
        page_size=page_size,
        page_token=page_token,
        preview=preview,
    )
    print("The page response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.page: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ListSessionsResponse		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rag_context

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.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
session_rid	SessionRid	sessionRid
parameter_inputs	Dict[ParameterId, ParameterValueDict]	Any values for application variables to use for the context retrieval.
user_input	UserTextInputDict	The user message to retrieve relevant context for from the configured Agent data sources.
preview	Optional[PreviewMode]	preview	[optional]

Return type

AgentSessionRagContextResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# SessionRid | sessionRid
session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
# Dict[ParameterId, ParameterValueDict] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval.
parameter_inputs = {"customerName": {"type": "string", "value": "Titan Technologies"}}
# UserTextInputDict | The user message to retrieve relevant context for from the configured Agent data sources.
user_input = {"text": "What is the status of my order?"}
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.rag_context(
        agent_rid,
        session_rid,
        parameter_inputs=parameter_inputs,
        user_input=user_input,
        preview=preview,
    )
    print("The rag_context response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.rag_context: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	AgentSessionRagContextResponse		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

streaming_continue

Continue a conversation session with an Agent, or add the first exchange to a session after creation. Adds a new exchange to the session with the provided inputs, and generates a response from the Agent. Returns a stream of the Agent response text (formatted using markdown) for clients to consume as the response is generated. On completion of the streamed response, clients can load the full details of the exchange that was added to the session by reloading the session content. Streamed exchanges also support cancellation; see cancel for details. Concurrent requests to continue the same session are not supported. Clients should wait to receive a response, or cancel the in-progress exchange, before sending the next message.

Parameters

Name	Type	Description	Notes
agent_rid	AgentRid	agentRid
session_rid	SessionRid	sessionRid
parameter_inputs	Dict[ParameterId, ParameterValueDict]	Any supplied values for application variables to pass to the Agent for the exchange.
user_input	UserTextInputDict	The user message for the Agent to respond to.
contexts_override	Optional[List[InputContextDict]]	If set, automatic context retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.	[optional]
message_id	Optional[MessageId]	A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete.	[optional]
preview	Optional[PreviewMode]	preview	[optional]

Return type

bytes

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# AgentRid | agentRid
agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1"
# SessionRid | sessionRid
session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
# Dict[ParameterId, ParameterValueDict] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange.
parameter_inputs = {
    "currentCustomerOrders": {
        "type": "objectSet",
        "ontology": "example-ontology",
        "objectSet": {
            "type": "filter",
            "objectSet": {"type": "base", "objectType": "customerOrder"},
            "where": {"type": "eq", "field": "customerId", "value": "123abc"},
        },
    }
}
# UserTextInputDict | The user message for the Agent to respond to.
user_input = {"text": "What is the status of my order?"}
# Optional[List[InputContextDict]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.
contexts_override = None
# Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete.
message_id = "00f8412a-c29d-4063-a417-8052825285a5"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.aip_agents.Agent.Session.streaming_continue(
        agent_rid,
        session_rid,
        parameter_inputs=parameter_inputs,
        user_input=user_input,
        contexts_override=contexts_override,
        message_id=message_id,
        preview=preview,
    )
    print("The streaming_continue response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Session.streaming_continue: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	bytes		application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

Session.md

Latest commit

History

Session.md

File metadata and controls

Session

blocking_continue

Parameters

Return type

Example

Authorization

HTTP response details

cancel

Parameters

Return type

Example

Authorization

HTTP response details

create

Parameters

Return type

Example

Authorization

HTTP response details

get

Parameters

Return type

Example

Authorization

HTTP response details

list

Parameters

Return type

Example

Authorization

HTTP response details

page

Parameters

Return type

Example

Authorization

HTTP response details

rag_context

Parameters

Return type

Example

Authorization

HTTP response details

streaming_continue

Parameters

Return type

Example

Authorization

HTTP response details