Skip to content

Commit 0077bde

Browse files
vertex-sdk-botcopybara-github
authored andcommitted
docs: Fix Sessions SDK docstrings
PiperOrigin-RevId: 816325320
1 parent 0dd3ccd commit 0077bde

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

vertexai/_genai/session_events.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def append(
142142
Appends Agent Engine session event.
143143
144144
Args:
145-
name (str): Required. The name of the Agent Engine session to append event for. Format:
145+
name (str): Required. The name of the Agent Engine session to append the event to. Format:
146146
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
147147
author (str): Required. The author of the Agent Engine session event.
148148
invocation_id (str): Required. The invocation ID of the Agent Engine session event.
@@ -313,7 +313,7 @@ async def append(
313313
Appends Agent Engine session event.
314314
315315
Args:
316-
name (str): Required. The name of the Agent Engine session to append event for. Format:
316+
name (str): Required. The name of the Agent Engine session to append the event to. Format:
317317
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
318318
author (str): Required. The author of the Agent Engine session event.
319319
invocation_id (str): Required. The invocation ID of the Agent Engine session event.

vertexai/_genai/sessions.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ def _create(
225225
Creates a new session in the Agent Engine.
226226
227227
Args:
228-
name (str): Required. The name of the Agent Engine session to be created. Format:
228+
name (str): Required. The name of the Agent Engine to create the session under. Format:
229229
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
230230
user_id (str): Required. The user ID of the session.
231231
config (CreateAgentEngineSessionConfig):
@@ -293,7 +293,7 @@ def delete(
293293
294294
Args:
295295
name (str): Required. The name of the Agent Engine session to be deleted. Format:
296-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
296+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
297297
config (DeleteAgentEngineSessionConfig):
298298
Optional. Additional configurations for deleting the Agent Engine session.
299299
@@ -358,7 +358,7 @@ def get(
358358
359359
Args:
360360
name (str): Required. The name of the Agent Engine session to get. Format:
361-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
361+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
362362
config (GetAgentEngineSessionConfig):
363363
Optional. Additional configurations for getting the Agent Engine session.
364364
@@ -539,7 +539,7 @@ def _update(
539539
540540
Args:
541541
name (str): Required. The name of the Agent Engine session to be updated. Format:
542-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
542+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
543543
config (UpdateAgentEngineSessionConfig):
544544
Optional. Additional configurations for updating the Agent Engine session.
545545
@@ -699,7 +699,7 @@ async def _create(
699699
Creates a new session in the Agent Engine.
700700
701701
Args:
702-
name (str): Required. The name of the Agent Engine session to be created. Format:
702+
name (str): Required. The name of the Agent Engine to create the session under. Format:
703703
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
704704
user_id (str): Required. The user ID of the session.
705705
config (CreateAgentEngineSessionConfig):
@@ -769,7 +769,7 @@ async def delete(
769769
770770
Args:
771771
name (str): Required. The name of the Agent Engine session to be deleted. Format:
772-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
772+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
773773
config (DeleteAgentEngineSessionConfig):
774774
Optional. Additional configurations for deleting the Agent Engine session.
775775
@@ -836,7 +836,7 @@ async def get(
836836
837837
Args:
838838
name (str): Required. The name of the Agent Engine session to get. Format:
839-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
839+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
840840
config (GetAgentEngineSessionConfig):
841841
Optional. Additional configurations for getting the Agent Engine session.
842842
@@ -1023,7 +1023,7 @@ async def _update(
10231023
10241024
Args:
10251025
name (str): Required. The name of the Agent Engine session to be updated. Format:
1026-
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}`.
1026+
`projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}`.
10271027
config (UpdateAgentEngineSessionConfig):
10281028
Optional. Additional configurations for updating the Agent Engine session.
10291029

vertexai/_genai/types.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7467,7 +7467,7 @@ class _GetAgentEngineSessionRequestParameters(_common.BaseModel):
74677467
"""Parameters for getting an agent engine session."""
74687468

74697469
name: Optional[str] = Field(
7470-
default=None, description="""Name of the agent engine."""
7470+
default=None, description="""Name of the agent engine session."""
74717471
)
74727472
config: Optional[GetAgentEngineSessionConfig] = Field(
74737473
default=None, description=""""""
@@ -7478,7 +7478,7 @@ class _GetAgentEngineSessionRequestParametersDict(TypedDict, total=False):
74787478
"""Parameters for getting an agent engine session."""
74797479

74807480
name: Optional[str]
7481-
"""Name of the agent engine."""
7481+
"""Name of the agent engine session."""
74827482

74837483
config: Optional[GetAgentEngineSessionConfigDict]
74847484
""""""
@@ -7982,7 +7982,7 @@ class ListAgentEngineSessionEventsConfigDict(TypedDict, total=False):
79827982

79837983

79847984
class _ListAgentEngineSessionEventsRequestParameters(_common.BaseModel):
7985-
"""Parameters for listing agent engines."""
7985+
"""Parameters for listing agent engine session events."""
79867986

79877987
name: Optional[str] = Field(
79887988
default=None, description="""Name of the agent engine session."""
@@ -7993,7 +7993,7 @@ class _ListAgentEngineSessionEventsRequestParameters(_common.BaseModel):
79937993

79947994

79957995
class _ListAgentEngineSessionEventsRequestParametersDict(TypedDict, total=False):
7996-
"""Parameters for listing agent engines."""
7996+
"""Parameters for listing agent engine session events."""
79977997

79987998
name: Optional[str]
79997999
"""Name of the agent engine session."""

0 commit comments

Comments
 (0)