# Class Sessions (1.153.1)

1.153.1 (latest) 1.153.0 1.152.0 1.151.0 1.150.0 1.149.0 1.148.1 1.147.0 1.146.0 1.145.0 1.144.0 1.143.0 1.142.0 1.141.0 1.140.0 1.139.0 1.138.0 1.137.0 1.136.0 1.135.0 1.134.0 1.133.0 1.132.0 1.131.0 1.130.0 1.129.0 1.122.0 1.121.0 1.120.0 1.119.0 1.118.0 1.117.0 1.95.1 1.94.0 1.93.1 1.92.0 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.0 1.75.0 1.74.0 1.73.0 1.72.0 1.71.1 1.70.0 1.69.0 1.68.0 1.67.1 1.66.0 1.65.0 1.63.0 1.62.0 1.60.0 1.59.0

    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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `AgentEngineSessionOperation` | The operation for creating the session. |

### 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `DeleteAgentEngineSessionOperation` | The operation for deleting the Agent Engine session. |

### 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `AgentEngineSession` | The requested Agent Engine session. |

### 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `str` Required. The name of the agent engine to list sessions for. |
| `config` | `ListAgentEngineSessionConfig` Optional. The configuration for the sessions to list. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Iterable[Session]` | An iterable of sessions. |