docs: [vertexai] Introduce modules

PiperOrigin-RevId: 834424318

Author: BenjaminKazemi

vertexai/_genai/datasets.py

@@ -40,9 +40,6 @@ def _AssembleDatasetParameters_to_vertex(
     parent_object: Optional[dict[str, Any]] = None,
 ) -> dict[str, Any]:
     to_object: dict[str, Any] = {}
-    if getv(from_object, ["config"]) is not None:
-        setv(to_object, ["config"], getv(from_object, ["config"]))
-
     if getv(from_object, ["name"]) is not None:
         setv(to_object, ["_url", "name"], getv(from_object, ["name"]))
 
@@ -53,6 +50,9 @@ def _AssembleDatasetParameters_to_vertex(
             getv(from_object, ["gemini_request_read_config"]),
         )
 
+    if getv(from_object, ["config"]) is not None:
+        setv(to_object, ["config"], getv(from_object, ["config"]))
+
     return to_object
 
 
@@ -61,9 +61,6 @@ def _AssessDatasetParameters_to_vertex(
     parent_object: Optional[dict[str, Any]] = None,
 ) -> dict[str, Any]:
     to_object: dict[str, Any] = {}
-    if getv(from_object, ["config"]) is not None:
-        setv(to_object, ["config"], getv(from_object, ["config"]))
-
     if getv(from_object, ["name"]) is not None:
         setv(to_object, ["_url", "name"], getv(from_object, ["name"]))
 
@@ -105,6 +102,9 @@ def _AssessDatasetParameters_to_vertex(
             getv(from_object, ["batch_prediction_validation_assessment_config"]),
         )
 
+    if getv(from_object, ["config"]) is not None:
+        setv(to_object, ["config"], getv(from_object, ["config"]))
+
     return to_object
 
 
@@ -250,20 +250,20 @@ class Datasets(_api_module.BaseModule):
     def _assemble_multimodal_dataset(
         self,
         *,
-        config: Optional[types.AssembleDatasetConfigOrDict] = None,
         name: str,
         gemini_request_read_config: Optional[
             types.GeminiRequestReadConfigOrDict
         ] = None,
+        config: Optional[types.AssembleDatasetConfigOrDict] = None,
     ) -> types.MultimodalDatasetOperation:
         """
         Assembles a multimodal dataset resource.
         """
 
         parameter_model = types._AssembleDatasetParameters(
-            config=config,
             name=name,
             gemini_request_read_config=gemini_request_read_config,
+            config=config,
         )
 
         request_url_dict: Optional[dict[str, str]]
@@ -307,7 +307,6 @@ def _assemble_multimodal_dataset(
     def _assess_multimodal_dataset(
         self,
         *,
-        config: Optional[types.AssessDatasetConfigOrDict] = None,
         name: str,
         gemini_request_read_config: Optional[
             types.GeminiRequestReadConfigOrDict
@@ -324,19 +323,20 @@ def _assess_multimodal_dataset(
         batch_prediction_validation_assessment_config: Optional[
             types.BatchPredictionValidationAssessmentConfigOrDict
         ] = None,
+        config: Optional[types.AssessDatasetConfigOrDict] = None,
     ) -> types.MultimodalDatasetOperation:
         """
         Assesses a multimodal dataset resource.
         """
 
         parameter_model = types._AssessDatasetParameters(
-            config=config,
             name=name,
             gemini_request_read_config=gemini_request_read_config,
             tuning_resource_usage_assessment_config=tuning_resource_usage_assessment_config,
             tuning_validation_assessment_config=tuning_validation_assessment_config,
             batch_prediction_resource_usage_assessment_config=batch_prediction_resource_usage_assessment_config,
             batch_prediction_validation_assessment_config=batch_prediction_validation_assessment_config,
+            config=config,
         )
 
         request_url_dict: Optional[dict[str, str]]
@@ -1060,20 +1060,20 @@ class AsyncDatasets(_api_module.BaseModule):
     async def _assemble_multimodal_dataset(
         self,
         *,
-        config: Optional[types.AssembleDatasetConfigOrDict] = None,
         name: str,
         gemini_request_read_config: Optional[
             types.GeminiRequestReadConfigOrDict
         ] = None,
+        config: Optional[types.AssembleDatasetConfigOrDict] = None,
     ) -> types.MultimodalDatasetOperation:
         """
         Assembles a multimodal dataset resource.
         """
 
         parameter_model = types._AssembleDatasetParameters(
-            config=config,
             name=name,
             gemini_request_read_config=gemini_request_read_config,
+            config=config,
         )
 
         request_url_dict: Optional[dict[str, str]]
@@ -1119,7 +1119,6 @@ async def _assemble_multimodal_dataset(
     async def _assess_multimodal_dataset(
         self,
         *,
-        config: Optional[types.AssessDatasetConfigOrDict] = None,
         name: str,
         gemini_request_read_config: Optional[
             types.GeminiRequestReadConfigOrDict
@@ -1136,19 +1135,20 @@ async def _assess_multimodal_dataset(
         batch_prediction_validation_assessment_config: Optional[
             types.BatchPredictionValidationAssessmentConfigOrDict
         ] = None,
+        config: Optional[types.AssessDatasetConfigOrDict] = None,
     ) -> types.MultimodalDatasetOperation:
         """
         Assesses a multimodal dataset resource.
         """
 
         parameter_model = types._AssessDatasetParameters(
-            config=config,
             name=name,
             gemini_request_read_config=gemini_request_read_config,
             tuning_resource_usage_assessment_config=tuning_resource_usage_assessment_config,
             tuning_validation_assessment_config=tuning_validation_assessment_config,
             batch_prediction_resource_usage_assessment_config=batch_prediction_resource_usage_assessment_config,
             batch_prediction_validation_assessment_config=batch_prediction_validation_assessment_config,
+            config=config,
         )
 
         request_url_dict: Optional[dict[str, str]]

vertexai/_genai/types/__init__.py

@@ -1628,9 +1628,6 @@
     "ListAgentEngineSessionEventsResponse",
     "ListAgentEngineSessionEventsResponseDict",
     "ListAgentEngineSessionEventsResponseOrDict",
-    "AssembleDatasetConfig",
-    "AssembleDatasetConfigDict",
-    "AssembleDatasetConfigOrDict",
     "GeminiExample",
     "GeminiExampleDict",
     "GeminiExampleOrDict",
@@ -1640,12 +1637,12 @@
     "GeminiRequestReadConfig",
     "GeminiRequestReadConfigDict",
     "GeminiRequestReadConfigOrDict",
+    "AssembleDatasetConfig",
+    "AssembleDatasetConfigDict",
+    "AssembleDatasetConfigOrDict",
     "MultimodalDatasetOperation",
     "MultimodalDatasetOperationDict",
     "MultimodalDatasetOperationOrDict",
-    "AssessDatasetConfig",
-    "AssessDatasetConfigDict",
-    "AssessDatasetConfigOrDict",
     "TuningResourceUsageAssessmentConfig",
     "TuningResourceUsageAssessmentConfigDict",
     "TuningResourceUsageAssessmentConfigOrDict",
@@ -1658,6 +1655,9 @@
     "BatchPredictionValidationAssessmentConfig",
     "BatchPredictionValidationAssessmentConfigDict",
     "BatchPredictionValidationAssessmentConfigOrDict",
+    "AssessDatasetConfig",
+    "AssessDatasetConfigDict",
+    "AssessDatasetConfigOrDict",
     "SchemaTablesDatasetMetadataBigQuerySource",
     "SchemaTablesDatasetMetadataBigQuerySourceDict",
     "SchemaTablesDatasetMetadataBigQuerySourceOrDict",

vertexai/_genai/types/common.py

@@ -9735,33 +9735,6 @@ class ListAgentEngineSessionEventsResponseDict(TypedDict, total=False):
 ]
 
 
-class AssembleDatasetConfig(_common.BaseModel):
-    """Config for assembling a multimodal dataset resource."""
-
-    http_options: Optional[genai_types.HttpOptions] = Field(
-        default=None, description="""Used to override HTTP request options."""
-    )
-    timeout: Optional[int] = Field(
-        default=90,
-        description="""The timeout for the assemble dataset request in seconds. If not
-      set, the default timeout is 90 seconds.""",
-    )
-
-
-class AssembleDatasetConfigDict(TypedDict, total=False):
-    """Config for assembling a multimodal dataset resource."""
-
-    http_options: Optional[genai_types.HttpOptionsDict]
-    """Used to override HTTP request options."""
-
-    timeout: Optional[int]
-    """The timeout for the assemble dataset request in seconds. If not
-      set, the default timeout is 90 seconds."""
-
-
-AssembleDatasetConfigOrDict = Union[AssembleDatasetConfig, AssembleDatasetConfigDict]
-
-
 class GeminiExample(_common.BaseModel):
     """Represents a Gemini example."""
 
@@ -9881,28 +9854,55 @@ class GeminiRequestReadConfigDict(TypedDict, total=False):
 ]
 
 
+class AssembleDatasetConfig(_common.BaseModel):
+    """Config for assembling a multimodal dataset resource."""
+
+    http_options: Optional[genai_types.HttpOptions] = Field(
+        default=None, description="""Used to override HTTP request options."""
+    )
+    timeout: Optional[int] = Field(
+        default=90,
+        description="""The timeout for the assemble dataset request in seconds. If not
+      set, the default timeout is 90 seconds.""",
+    )
+
+
+class AssembleDatasetConfigDict(TypedDict, total=False):
+    """Config for assembling a multimodal dataset resource."""
+
+    http_options: Optional[genai_types.HttpOptionsDict]
+    """Used to override HTTP request options."""
+
+    timeout: Optional[int]
+    """The timeout for the assemble dataset request in seconds. If not
+      set, the default timeout is 90 seconds."""
+
+
+AssembleDatasetConfigOrDict = Union[AssembleDatasetConfig, AssembleDatasetConfigDict]
+
+
 class _AssembleDatasetParameters(_common.BaseModel):
     """Parameters for assembling a multimodal dataset resource."""
 
-    config: Optional[AssembleDatasetConfig] = Field(default=None, description="""""")
     name: Optional[str] = Field(default=None, description="""""")
     gemini_request_read_config: Optional[GeminiRequestReadConfig] = Field(
         default=None, description=""""""
     )
+    config: Optional[AssembleDatasetConfig] = Field(default=None, description="""""")
 
 
 class _AssembleDatasetParametersDict(TypedDict, total=False):
     """Parameters for assembling a multimodal dataset resource."""
 
-    config: Optional[AssembleDatasetConfigDict]
-    """"""
-
     name: Optional[str]
     """"""
 
     gemini_request_read_config: Optional[GeminiRequestReadConfigDict]
     """"""
 
+    config: Optional[AssembleDatasetConfigDict]
+    """"""
+
 
 _AssembleDatasetParametersOrDict = Union[
     _AssembleDatasetParameters, _AssembleDatasetParametersDict
@@ -9957,33 +9957,6 @@ class MultimodalDatasetOperationDict(TypedDict, total=False):
 ]
 
 
-class AssessDatasetConfig(_common.BaseModel):
-    """Config for assessing a multimodal dataset resource."""
-
-    http_options: Optional[genai_types.HttpOptions] = Field(
-        default=None, description="""Used to override HTTP request options."""
-    )
-    timeout: Optional[int] = Field(
-        default=90,
-        description="""The timeout for the assess dataset request in seconds. If not set,
-      the default timeout is 90 seconds.""",
-    )
-
-
-class AssessDatasetConfigDict(TypedDict, total=False):
-    """Config for assessing a multimodal dataset resource."""
-
-    http_options: Optional[genai_types.HttpOptionsDict]
-    """Used to override HTTP request options."""
-
-    timeout: Optional[int]
-    """The timeout for the assess dataset request in seconds. If not set,
-      the default timeout is 90 seconds."""
-
-
-AssessDatasetConfigOrDict = Union[AssessDatasetConfig, AssessDatasetConfigDict]
-
-
 class TuningResourceUsageAssessmentConfig(_common.BaseModel):
     """Config for tuning resource usage assessment."""
 
@@ -10062,10 +10035,36 @@ class BatchPredictionValidationAssessmentConfigDict(TypedDict, total=False):
 ]
 
 
+class AssessDatasetConfig(_common.BaseModel):
+    """Config for assessing a multimodal dataset resource."""
+
+    http_options: Optional[genai_types.HttpOptions] = Field(
+        default=None, description="""Used to override HTTP request options."""
+    )
+    timeout: Optional[int] = Field(
+        default=90,
+        description="""The timeout for the assess dataset request in seconds. If not set,
+      the default timeout is 90 seconds.""",
+    )
+
+
+class AssessDatasetConfigDict(TypedDict, total=False):
+    """Config for assessing a multimodal dataset resource."""
+
+    http_options: Optional[genai_types.HttpOptionsDict]
+    """Used to override HTTP request options."""
+
+    timeout: Optional[int]
+    """The timeout for the assess dataset request in seconds. If not set,
+      the default timeout is 90 seconds."""
+
+
+AssessDatasetConfigOrDict = Union[AssessDatasetConfig, AssessDatasetConfigDict]
+
+
 class _AssessDatasetParameters(_common.BaseModel):
     """Parameters for assessing a multimodal dataset resource."""
 
-    config: Optional[AssessDatasetConfig] = Field(default=None, description="""""")
     name: Optional[str] = Field(default=None, description="""""")
     gemini_request_read_config: Optional[GeminiRequestReadConfig] = Field(
         default=None, description=""""""
@@ -10082,14 +10081,12 @@ class _AssessDatasetParameters(_common.BaseModel):
     batch_prediction_validation_assessment_config: Optional[
         BatchPredictionValidationAssessmentConfig
     ] = Field(default=None, description="""""")
+    config: Optional[AssessDatasetConfig] = Field(default=None, description="""""")
 
 
 class _AssessDatasetParametersDict(TypedDict, total=False):
     """Parameters for assessing a multimodal dataset resource."""
 
-    config: Optional[AssessDatasetConfigDict]
-    """"""
-
     name: Optional[str]
     """"""
 
@@ -10114,6 +10111,9 @@ class _AssessDatasetParametersDict(TypedDict, total=False):
     ]
     """"""
 
+    config: Optional[AssessDatasetConfigDict]
+    """"""
+
 
 _AssessDatasetParametersOrDict = Union[
     _AssessDatasetParameters, _AssessDatasetParametersDict