Skip to content

docs: Update GenerateVideos docstrings and samples #2797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Jul 31, 2026
Merged

docs: Update GenerateVideos docstrings and samples #2797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1337,7 +1337,9 @@ from google.genai import types
# Create operation
operation = client.models.generate_videos(
model='veo-3.1-generate-preview',
prompt='A neon hologram of a cat driving at top speed',
source=types.GenerateVideosSource(
prompt='A neon hologram of a cat driving at top speed',
),
config=types.GenerateVideosConfig(
number_of_videos=1,
duration_seconds=5,
Expand Down Expand Up @@ -1365,9 +1367,11 @@ image = types.Image.from_file(location="local/path/file.png")
# Create operation
operation = client.models.generate_videos(
model='veo-3.1-generate-preview',
# Prompt is optional if image is provided
prompt='Night sky',
image=image,
source=types.GenerateVideosSource(
# Prompt is optional if image is provided
prompt='Night sky',
image=image,
),
config=types.GenerateVideosConfig(
number_of_videos=1,
duration_seconds=5,
Expand Down Expand Up @@ -1399,11 +1403,13 @@ video = types.Video.from_file("local/path/video.mp4")
# Create operation
operation = client.models.generate_videos(
model='veo-3.1-generate-preview',
# Prompt is optional if Video is provided
prompt='Night sky',
# Input video must be in GCS for Gemini Enterprise Agent Platform or a URI for Gemini
video=types.Video(
uri="gs://bucket-name/inputs/videos/cat_driving.mp4",
source=types.GenerateVideosSource(
# Prompt is optional if Video is provided
prompt='Night sky',
# Input video must be in GCS for Gemini Enterprise Agent Platform or a URI for Gemini
video=types.Video(
uri="gs://bucket-name/inputs/videos/cat_driving.mp4",
),
),
config=types.GenerateVideosConfig(
number_of_videos=1,
Expand Down
2 changes: 1 addition & 1 deletion google/genai/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7091,7 +7091,7 @@ def generate_videos(
time.sleep(10)
operation = client.operations.get(operation)

operation.result.generated_videos[0].video.uri
operation.response.generated_videos[0].video.uri
```
"""
if prompt or image or video:
Expand Down
4 changes: 2 additions & 2 deletions google/genai/operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def get(
time.sleep(10)
operation = client.operations.get(operation)

print(operation.result)
print(operation.response)
"""
# Currently, only GenerateVideosOperation is supported.
# TODO(b/398040607): Support short form names
Expand Down Expand Up @@ -554,7 +554,7 @@ async def get(
await asyncio.sleep(10)
operation = await client.aio.operations.get(operation)

print(operation.result)
print(operation.response)
"""
# Currently, only GenerateVideosOperation is supported.
operation_name = operation.name
Expand Down
Loading