Skip to content

Commit 9f8ee72

Browse files
yinghsienwucopybara-github
authored andcommitted
chore: add new fields
PiperOrigin-RevId: 913942680
1 parent 6b3269b commit 9f8ee72

3 files changed

Lines changed: 105 additions & 54 deletions

File tree

vertexai/_genai/types/__init__.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1213,9 +1213,6 @@
12131213
from .common import SandboxEnvironmentTemplateResourceRequirements
12141214
from .common import SandboxEnvironmentTemplateResourceRequirementsDict
12151215
from .common import SandboxEnvironmentTemplateResourceRequirementsOrDict
1216-
from .common import SandboxEnvironmentTemplateWarmPoolConfig
1217-
from .common import SandboxEnvironmentTemplateWarmPoolConfigDict
1218-
from .common import SandboxEnvironmentTemplateWarmPoolConfigOrDict
12191216
from .common import SandboxState
12201217
from .common import SavedQuery
12211218
from .common import SavedQueryDict
@@ -1244,6 +1241,9 @@
12441241
from .common import SchemaPromptSpecAppBuilderDataLinkedResourceDict
12451242
from .common import SchemaPromptSpecAppBuilderDataLinkedResourceOrDict
12461243
from .common import SchemaPromptSpecAppBuilderDataOrDict
1244+
from .common import SchemaPromptSpecInteractionData
1245+
from .common import SchemaPromptSpecInteractionDataDict
1246+
from .common import SchemaPromptSpecInteractionDataOrDict
12471247
from .common import SchemaPromptSpecMultimodalPrompt
12481248
from .common import SchemaPromptSpecMultimodalPromptDict
12491249
from .common import SchemaPromptSpecMultimodalPromptOrDict
@@ -1313,6 +1313,7 @@
13131313
from .common import SkillRevision
13141314
from .common import SkillRevisionDict
13151315
from .common import SkillRevisionOrDict
1316+
from .common import SkillSource
13161317
from .common import SkillState
13171318
from .common import State
13181319
from .common import Strategy
@@ -2315,9 +2316,6 @@
23152316
"CreateSandboxEnvironmentTemplateConfig",
23162317
"CreateSandboxEnvironmentTemplateConfigDict",
23172318
"CreateSandboxEnvironmentTemplateConfigOrDict",
2318-
"SandboxEnvironmentTemplateWarmPoolConfig",
2319-
"SandboxEnvironmentTemplateWarmPoolConfigDict",
2320-
"SandboxEnvironmentTemplateWarmPoolConfigOrDict",
23212319
"SandboxEnvironmentTemplate",
23222320
"SandboxEnvironmentTemplateDict",
23232321
"SandboxEnvironmentTemplateOrDict",
@@ -2489,6 +2487,9 @@
24892487
"SchemaPromptSpecPartList",
24902488
"SchemaPromptSpecPartListDict",
24912489
"SchemaPromptSpecPartListOrDict",
2490+
"SchemaPromptSpecInteractionData",
2491+
"SchemaPromptSpecInteractionDataDict",
2492+
"SchemaPromptSpecInteractionDataOrDict",
24922493
"SchemaPromptSpecStructuredPrompt",
24932494
"SchemaPromptSpecStructuredPromptDict",
24942495
"SchemaPromptSpecStructuredPromptOrDict",
@@ -2729,6 +2730,7 @@
27292730
"DefaultContainerCategory",
27302731
"PostSnapshotAction",
27312732
"Framework",
2733+
"SkillSource",
27322734
"EvaluationItemType",
27332735
"SamplingMethod",
27342736
"EvaluationRunState",

vertexai/_genai/types/common.py

Lines changed: 70 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,17 @@ class Framework(_common.CaseInSensitiveEnum):
383383
"""Angular framework."""
384384

385385

386+
class SkillSource(_common.CaseInSensitiveEnum):
387+
"""Output only. The source of the Skill."""
388+
389+
SKILL_SOURCE_UNSPECIFIED = "SKILL_SOURCE_UNSPECIFIED"
390+
"""The skill source is unspecified."""
391+
USER = "USER"
392+
"""The skill is created by a user."""
393+
SYSTEM = "SYSTEM"
394+
"""The skill is a system skill."""
395+
396+
386397
class EvaluationItemType(_common.CaseInSensitiveEnum):
387398
"""The type of the EvaluationItem."""
388399

@@ -7217,29 +7228,29 @@ class MemoryGenerationTriggerConfigGenerationTriggerRule(_common.BaseModel):
72177228

72187229
event_count: Optional[int] = Field(
72197230
default=None,
7220-
description="""Specifies to trigger generation when the event count reaches this limit.""",
7231+
description="""Optional. Specifies to trigger generation when the event count reaches this limit.""",
72217232
)
72227233
fixed_interval: Optional[str] = Field(
72237234
default=None,
7224-
description="""Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.""",
7235+
description="""Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.""",
72257236
)
72267237
idle_duration: Optional[str] = Field(
72277238
default=None,
7228-
description="""Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.""",
7239+
description="""Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.""",
72297240
)
72307241

72317242

72327243
class MemoryGenerationTriggerConfigGenerationTriggerRuleDict(TypedDict, total=False):
72337244
"""Represents the active rule that determines when to flush the buffer."""
72347245

72357246
event_count: Optional[int]
7236-
"""Specifies to trigger generation when the event count reaches this limit."""
7247+
"""Optional. Specifies to trigger generation when the event count reaches this limit."""
72377248

72387249
fixed_interval: Optional[str]
7239-
"""Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity."""
7250+
"""Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity."""
72407251

72417252
idle_duration: Optional[str]
7242-
"""Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity."""
7253+
"""Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity."""
72437254

72447255

72457256
MemoryGenerationTriggerConfigGenerationTriggerRuleOrDict = Union[
@@ -7701,7 +7712,7 @@ class KeepAliveProbeHttpGet(_common.BaseModel):
77017712

77027713
path: Optional[str] = Field(
77037714
default=None,
7704-
description="""Required. Specifies the path of the HTTP GET request (e.g., "/is_busy").""",
7715+
description="""Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`).""",
77057716
)
77067717
port: Optional[int] = Field(
77077718
default=None,
@@ -7713,7 +7724,7 @@ class KeepAliveProbeHttpGetDict(TypedDict, total=False):
77137724
"""Specifies the HTTP GET configuration for the probe."""
77147725

77157726
path: Optional[str]
7716-
"""Required. Specifies the path of the HTTP GET request (e.g., "/is_busy")."""
7727+
"""Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`)."""
77177728

77187729
port: Optional[int]
77197730
"""Optional. Specifies the port number on the container to which the request is sent."""
@@ -7847,7 +7858,7 @@ class ReasoningEngineSpecPackageSpec(_common.BaseModel):
78477858
)
78487859
python_version: Optional[str] = Field(
78497860
default=None,
7850-
description="""Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.""",
7861+
description="""Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.""",
78517862
)
78527863
requirements_gcs_uri: Optional[str] = Field(
78537864
default=None,
@@ -7865,7 +7876,7 @@ class ReasoningEngineSpecPackageSpecDict(TypedDict, total=False):
78657876
"""Optional. The Cloud Storage URI of the pickled python object."""
78667877

78677878
python_version: Optional[str]
7868-
"""Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10."""
7879+
"""Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10."""
78697880

78707881
requirements_gcs_uri: Optional[str]
78717882
"""Optional. The Cloud Storage URI of the `requirements.txt` file"""
@@ -8059,7 +8070,7 @@ class ReasoningEngineSpecSourceCodeSpecPythonSpec(_common.BaseModel):
80598070
)
80608071
version: Optional[str] = Field(
80618072
default=None,
8062-
description="""Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.""",
8073+
description="""Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.""",
80638074
)
80648075

80658076

@@ -8076,7 +8087,7 @@ class ReasoningEngineSpecSourceCodeSpecPythonSpecDict(TypedDict, total=False):
80768087
"""Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt"."""
80778088

80788089
version: Optional[str]
8079-
"""Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10."""
8090+
"""Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10."""
80808091

80818092

80828093
ReasoningEngineSpecSourceCodeSpecPythonSpecOrDict = Union[
@@ -12474,10 +12485,6 @@ class SandboxEnvironmentConnectionInfo(_common.BaseModel):
1247412485
default=None,
1247512486
description="""Output only. The internal IP address of the SandboxEnvironment.""",
1247612487
)
12477-
sandbox_hostname: Optional[str] = Field(
12478-
default=None,
12479-
description="""Output only. The hostname of the SandboxEnvironment.""",
12480-
)
1248112488
routing_token: Optional[str] = Field(
1248212489
default=None,
1248312490
description="""Output only. The routing token for the SandboxEnvironment.""",
@@ -12496,9 +12503,6 @@ class SandboxEnvironmentConnectionInfoDict(TypedDict, total=False):
1249612503
sandbox_internal_ip: Optional[str]
1249712504
"""Output only. The internal IP address of the SandboxEnvironment."""
1249812505

12499-
sandbox_hostname: Optional[str]
12500-
"""Output only. The hostname of the SandboxEnvironment."""
12501-
1250212506
routing_token: Optional[str]
1250312507
"""Output only. The routing token for the SandboxEnvironment."""
1250412508

@@ -13291,28 +13295,6 @@ class _CreateSandboxEnvironmentTemplateRequestParametersDict(TypedDict, total=Fa
1329113295
]
1329213296

1329313297

13294-
class SandboxEnvironmentTemplateWarmPoolConfig(_common.BaseModel):
13295-
"""Configuration for a warm pool of sandbox instances."""
13296-
13297-
target_instance_count: Optional[int] = Field(
13298-
default=None,
13299-
description="""Optional. The target number of pre-warmed instances to maintain.""",
13300-
)
13301-
13302-
13303-
class SandboxEnvironmentTemplateWarmPoolConfigDict(TypedDict, total=False):
13304-
"""Configuration for a warm pool of sandbox instances."""
13305-
13306-
target_instance_count: Optional[int]
13307-
"""Optional. The target number of pre-warmed instances to maintain."""
13308-
13309-
13310-
SandboxEnvironmentTemplateWarmPoolConfigOrDict = Union[
13311-
SandboxEnvironmentTemplateWarmPoolConfig,
13312-
SandboxEnvironmentTemplateWarmPoolConfigDict,
13313-
]
13314-
13315-
1331613298
class SandboxEnvironmentTemplate(_common.BaseModel):
1331713299
"""A sandbox environment template."""
1331813300

@@ -13363,10 +13345,6 @@ class SandboxEnvironmentTemplate(_common.BaseModel):
1336313345
default=None,
1336413346
description="""Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.""",
1336513347
)
13366-
warm_pool_config: Optional[SandboxEnvironmentTemplateWarmPoolConfig] = Field(
13367-
default=None,
13368-
description="""Optional. The configuration for the warm pool of this template.""",
13369-
)
1337013348

1337113349

1337213350
class SandboxEnvironmentTemplateDict(TypedDict, total=False):
@@ -13409,9 +13387,6 @@ class SandboxEnvironmentTemplateDict(TypedDict, total=False):
1340913387
update_time: Optional[datetime.datetime]
1341013388
"""Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated."""
1341113389

13412-
warm_pool_config: Optional[SandboxEnvironmentTemplateWarmPoolConfigDict]
13413-
"""Optional. The configuration for the warm pool of this template."""
13414-
1341513390

1341613391
SandboxEnvironmentTemplateOrDict = Union[
1341713392
SandboxEnvironmentTemplate, SandboxEnvironmentTemplateDict
@@ -16453,6 +16428,27 @@ class SchemaPromptSpecPartListDict(TypedDict, total=False):
1645316428
]
1645416429

1645516430

16431+
class SchemaPromptSpecInteractionData(_common.BaseModel):
16432+
"""Defines data for an interaction prompt."""
16433+
16434+
interaction_ids: Optional[list[str]] = Field(
16435+
default=None,
16436+
description="""Optional. Lists interaction IDs associated with the prompt. This maps 1:1 to PromptMessage.contents. If InteractionData is present, every prompt message has an interaction ID.""",
16437+
)
16438+
16439+
16440+
class SchemaPromptSpecInteractionDataDict(TypedDict, total=False):
16441+
"""Defines data for an interaction prompt."""
16442+
16443+
interaction_ids: Optional[list[str]]
16444+
"""Optional. Lists interaction IDs associated with the prompt. This maps 1:1 to PromptMessage.contents. If InteractionData is present, every prompt message has an interaction ID."""
16445+
16446+
16447+
SchemaPromptSpecInteractionDataOrDict = Union[
16448+
SchemaPromptSpecInteractionData, SchemaPromptSpecInteractionDataDict
16449+
]
16450+
16451+
1645616452
class SchemaPromptSpecStructuredPrompt(_common.BaseModel):
1645716453
"""Represents a structured prompt."""
1645816454

@@ -16489,6 +16485,9 @@ class SchemaPromptSpecStructuredPrompt(_common.BaseModel):
1648916485
prompt_message: Optional[SchemaPromptSpecPromptMessage] = Field(
1649016486
default=None, description="""The prompt message."""
1649116487
)
16488+
interaction_data: Optional[SchemaPromptSpecInteractionData] = Field(
16489+
default=None, description="""Data for interaction use case."""
16490+
)
1649216491

1649316492

1649416493
class SchemaPromptSpecStructuredPromptDict(TypedDict, total=False):
@@ -16521,6 +16520,9 @@ class SchemaPromptSpecStructuredPromptDict(TypedDict, total=False):
1652116520
prompt_message: Optional[SchemaPromptSpecPromptMessageDict]
1652216521
"""The prompt message."""
1652316522

16523+
interaction_data: Optional[SchemaPromptSpecInteractionDataDict]
16524+
"""Data for interaction use case."""
16525+
1652416526

1652516527
SchemaPromptSpecStructuredPromptOrDict = Union[
1652616528
SchemaPromptSpecStructuredPrompt, SchemaPromptSpecStructuredPromptDict
@@ -18107,6 +18109,17 @@ class Skill(_common.BaseModel):
1810718109
state: Optional[SkillState] = Field(
1810818110
default=None, description="""Output only. The state of the Skill."""
1810918111
)
18112+
labels: Optional[dict[str, str]] = Field(
18113+
default=None,
18114+
description="""The labels with user-defined metadata to organize Skills.""",
18115+
)
18116+
sha256: Optional[str] = Field(
18117+
default=None,
18118+
description="""Output only. The SHA256 checksum of the zipped filesystem.""",
18119+
)
18120+
skill_source: Optional[SkillSource] = Field(
18121+
default=None, description="""Output only. The source of the Skill."""
18122+
)
1811018123

1811118124

1811218125
class SkillDict(TypedDict, total=False):
@@ -18142,6 +18155,15 @@ class SkillDict(TypedDict, total=False):
1814218155
state: Optional[SkillState]
1814318156
"""Output only. The state of the Skill."""
1814418157

18158+
labels: Optional[dict[str, str]]
18159+
"""The labels with user-defined metadata to organize Skills."""
18160+
18161+
sha256: Optional[str]
18162+
"""Output only. The SHA256 checksum of the zipped filesystem."""
18163+
18164+
skill_source: Optional[SkillSource]
18165+
"""Output only. The source of the Skill."""
18166+
1814518167

1814618168
SkillOrDict = Union[Skill, SkillDict]
1814718169

vertexai/_genai/types/evals.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,10 @@ class UserScenario(_common.BaseModel):
502502
default=None,
503503
description="""The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset.""",
504504
)
505+
test_case_title: Optional[str] = Field(
506+
default=None,
507+
description="""Represents a short 3-5 word title for eval test case.""",
508+
)
505509

506510

507511
class UserScenarioDict(TypedDict, total=False):
@@ -513,6 +517,9 @@ class UserScenarioDict(TypedDict, total=False):
513517
conversation_plan: Optional[str]
514518
"""The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset."""
515519

520+
test_case_title: Optional[str]
521+
"""Represents a short 3-5 word title for eval test case."""
522+
516523

517524
UserScenarioOrDict = Union[UserScenario, UserScenarioDict]
518525

@@ -536,6 +543,17 @@ class UserScenarioGenerationConfig(_common.BaseModel):
536543
default=None,
537544
description="""Environment context to drive simulation. For example, for a QA agent, this could be the docs queried by the tools.""",
538545
)
546+
environment_data: Optional[str] = Field(
547+
default=None, description="""Optional. Environment data in string type."""
548+
)
549+
simulation_instruction: Optional[str] = Field(
550+
default=None,
551+
description="""Optional. Simulation instruction to guide the user scenario generation.""",
552+
)
553+
user_scenario_count: Optional[int] = Field(
554+
default=None,
555+
description="""Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100.""",
556+
)
539557

540558

541559
class UserScenarioGenerationConfigDict(TypedDict, total=False):
@@ -553,6 +571,15 @@ class UserScenarioGenerationConfigDict(TypedDict, total=False):
553571
environment_context: Optional[str]
554572
"""Environment context to drive simulation. For example, for a QA agent, this could be the docs queried by the tools."""
555573

574+
environment_data: Optional[str]
575+
"""Optional. Environment data in string type."""
576+
577+
simulation_instruction: Optional[str]
578+
"""Optional. Simulation instruction to guide the user scenario generation."""
579+
580+
user_scenario_count: Optional[int]
581+
"""Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100."""
582+
556583

557584
UserScenarioGenerationConfigOrDict = Union[
558585
UserScenarioGenerationConfig, UserScenarioGenerationConfigDict

0 commit comments

Comments
 (0)