Sessions
(
api_client_
:
google
.
genai
.
_api_client
.
BaseApiClient
)
API documentation for Sessions
class.
Properties
events
API documentation for events
property.
Methods
create
create
(
*
,
name
:
str
,
user_id
:
str
,
config
:
typing
.
Optional
[
typing
.
Union
[
vertexai
.
_genai
.
types
.
common
.
CreateAgentEngineSessionConfig
,
vertexai
.
_genai
.
types
.
common
.
CreateAgentEngineSessionConfigDict
,
]
]
=
None
)
-
> vertexai
.
_genai
.
types
.
common
.
AgentEngineSessionOperation
Creates a new session in the Agent Engine.
name
str
Required. The name of the agent engine to create the session for.
user_id
str
Required. The user ID of the session.
config
CreateAgentEngineSessionConfig
Optional. The configuration for the session to create.
AgentEngineSessionOperation
delete
delete
(
*
,
name
:
str
,
config
:
typing
.
Optional
[
typing
.
Union
[
vertexai
.
_genai
.
types
.
common
.
DeleteAgentEngineSessionConfig
,
vertexai
.
_genai
.
types
.
common
.
DeleteAgentEngineSessionConfigDict
,
]
]
=
None
)
-
> vertexai
.
_genai
.
types
.
common
.
DeleteAgentEngineSessionOperation
Delete an Agent Engine session.
name
str
Required. The name of the Agent Engine session to be deleted. Format: projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}
.
config
DeleteAgentEngineSessionConfig
Optional. Additional configurations for deleting the Agent Engine session.
DeleteAgentEngineSessionOperation
get
get
(
*
,
name
:
str
,
config
:
typing
.
Optional
[
typing
.
Union
[
vertexai
.
_genai
.
types
.
common
.
GetAgentEngineSessionConfig
,
vertexai
.
_genai
.
types
.
common
.
GetAgentEngineSessionConfigDict
,
]
]
=
None
)
-
> vertexai
.
_genai
.
types
.
common
.
Session
Gets an agent engine session.
name
str
Required. The name of the Agent Engine session to get. Format: projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}
.
config
GetAgentEngineSessionConfig
Optional. Additional configurations for getting the Agent Engine session.
AgentEngineSession
list
list
(
*
,
name
:
str
,
config
:
typing
.
Optional
[
typing
.
Union
[
vertexai
.
_genai
.
types
.
common
.
ListAgentEngineSessionsConfig
,
vertexai
.
_genai
.
types
.
common
.
ListAgentEngineSessionsConfigDict
,
]
]
=
None
)
-
> typing
.
Iterator
[
vertexai
.
_genai
.
types
.
common
.
Session
]
Lists Agent Engine sessions.
name
str
Required. The name of the agent engine to list sessions for.
config
ListAgentEngineSessionConfig
Optional. The configuration for the sessions to list.
Iterable[Session]
