# Package Classes (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 Summary of entries of Classes for aiplatform.

## Classes

### [Client](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.Client)

Gen AI Client for the Vertex SDK.

Use this client to interact with Vertex-specific Gemini features.

### [AgentEngines](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.agent_engines.AgentEngines)

API documentation for `AgentEngines` class.

### [AsyncAgentEngines](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.agent_engines.AsyncAgentEngines)

API documentation for `AsyncAgentEngines` class.

### [AsyncEvals](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.evals.AsyncEvals)

API documentation for `AsyncEvals` class.

### [Evals](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.evals.Evals)

API documentation for `Evals` class.

### [AsyncMemories](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memories.AsyncMemories)

API documentation for `AsyncMemories` class.

### [Memories](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memories.Memories)

API documentation for `Memories` class.

### [AsyncMemoryRevisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memory_revisions.AsyncMemoryRevisions)

API documentation for `AsyncMemoryRevisions` class.

### [MemoryRevisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memory_revisions.MemoryRevisions)

API documentation for `MemoryRevisions` class.

### [AsyncPromptOptimizer](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompt_optimizer.AsyncPromptOptimizer)

Prompt Optimizer

### [PromptOptimizer](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompt_optimizer.PromptOptimizer)

Prompt Optimizer

### [AsyncPrompts](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompts.AsyncPrompts)

API documentation for `AsyncPrompts` class.

### [Prompts](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompts.Prompts)

API documentation for `Prompts` class.

### [AsyncSessionEvents](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.session_events.AsyncSessionEvents)

API documentation for `AsyncSessionEvents` class.

### [SessionEvents](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.session_events.SessionEvents)

API documentation for `SessionEvents` class.

### [AsyncSessions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.sessions.AsyncSessions)

API documentation for `AsyncSessions` class.

### [Sessions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.sessions.Sessions)

API documentation for `Sessions` class.

### [AsyncSkillRevisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skill_revisions.AsyncSkillRevisions)

Class for managing Skill Revisions in the Skill Registry.

### [SkillRevisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skill_revisions.SkillRevisions)

Class for managing Skill Revisions in the Skill Registry.

### [AsyncSkills](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skills.AsyncSkills)

Class for managing Skills in the Skill Registry.

### [Skills](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skills.Skills)

Class for managing Skills in the Skill Registry.

### [A2aTask](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.A2aTask)

A task.

### [A2aTaskDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.A2aTaskDict)

A task.

### [A2aTaskState](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.A2aTaskState)

Output only. The state of the task. The state of a new task is SUBMITTED by default. The state of a task can only be updated via AppendA2aTaskEvents API.

### [AcceleratorType](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AcceleratorType)

Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.

### [AgentEngine](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngine)

An agent engine instance.

### [AgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineConfig)

Config for agent engine methods.

### [AgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineConfigDict)

Config for agent engine methods.

### [AgentEngineDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineDict)

An agent engine instance.

### [AgentEngineGenerateMemoriesOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineGenerateMemoriesOperation)

Operation that generates memories for an agent engine.

### [AgentEngineGenerateMemoriesOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineGenerateMemoriesOperationDict)

Operation that generates memories for an agent engine.

### [AgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineMemoryConfig)

Config for creating a Memory.

### [AgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineMemoryConfigDict)

Config for creating a Memory.

### [AgentEngineMemoryOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineMemoryOperation)

Operation that has an agent engine memory as a response.

### [AgentEngineMemoryOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineMemoryOperationDict)

Operation that has an agent engine memory as a response.

### [AgentEngineOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineOperation)

Operation that has an agent engine as a response.

### [AgentEngineOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineOperationDict)

Operation that has an agent engine as a response.

### [AgentEnginePurgeMemoriesOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEnginePurgeMemoriesOperation)

Operation that purges memories from an agent engine.

### [AgentEnginePurgeMemoriesOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEnginePurgeMemoriesOperationDict)

Operation that purges memories from an agent engine.

### [AgentEngineRollbackMemoryOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineRollbackMemoryOperation)

Operation that rolls back a memory.

### [AgentEngineRollbackMemoryOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineRollbackMemoryOperationDict)

Operation that rolls back a memory.

### [AgentEngineRuntimeRevision](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineRuntimeRevision)

An agent engine runtime revision instance.

### [AgentEngineRuntimeRevisionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineRuntimeRevisionDict)

An agent engine runtime revision instance.

### [AgentEngineSandboxOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSandboxOperation)

Operation that has an agent engine sandbox as a response.

### [AgentEngineSandboxOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSandboxOperationDict)

Operation that has an agent engine sandbox as a response.

### [AgentEngineSandboxSnapshotOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSandboxSnapshotOperation)

Operation that has an agent engine sandbox snapshot as a response.

### [AgentEngineSandboxSnapshotOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSandboxSnapshotOperationDict)

Operation that has an agent engine sandbox snapshot as a response.

### [AgentEngineSessionOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSessionOperation)

Operation that has an agent engine session as a response.

### [AgentEngineSessionOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentEngineSessionOperationDict)

Operation that has an agent engine session as a response.

### [AgentRunConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentRunConfig)

Configuration for an Agent Run.

### [AgentRunConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentRunConfigDict)

Configuration for an Agent Run.

### [AgentServerMode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AgentServerMode)

The agent server mode.

### [AggregatedMetricResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AggregatedMetricResult)

Evaluation result for a single metric for an evaluation dataset.

### [AggregatedMetricResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AggregatedMetricResultDict)

Evaluation result for a single metric for an evaluation dataset.

### [AnalysisConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AnalysisConfig)

Configuration for an analysis to be performed on an evaluation run.

### [AnalysisConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AnalysisConfigDict)

Configuration for an analysis to be performed on an evaluation run.

### [AppendAgentEngineSessionEventConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineSessionEventConfig)

Config for appending agent engine session event.

### [AppendAgentEngineSessionEventConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineSessionEventConfigDict)

Config for appending agent engine session event.

### [AppendAgentEngineSessionEventResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineSessionEventResponse)

Response for appending agent engine session event.

### [AppendAgentEngineSessionEventResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineSessionEventResponseDict)

Response for appending agent engine session event.

### [AppendAgentEngineTaskEventConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineTaskEventConfig)

Config for appending Agent Engine task events.

### [AppendAgentEngineTaskEventConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineTaskEventConfigDict)

Config for appending Agent Engine task events.

### [AppendAgentEngineTaskEventResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineTaskEventResponse)

Response for appending Agent Engine task events.

### [AppendAgentEngineTaskEventResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AppendAgentEngineTaskEventResponseDict)

Response for appending Agent Engine task events.

### [AssembleDataset](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssembleDataset)

Represents the assembled dataset.

### [AssembleDatasetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssembleDatasetConfig)

Config for assembling a multimodal dataset resource.

### [AssembleDatasetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssembleDatasetConfigDict)

Config for assembling a multimodal dataset resource.

### [AssembleDatasetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssembleDatasetDict)

Represents the assembled dataset.

### [AssessDatasetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssessDatasetConfig)

Config for assessing a multimodal dataset resource.

### [AssessDatasetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AssessDatasetConfigDict)

Config for assessing a multimodal dataset resource.

### [AttackCategoryResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AttackCategoryResult)

The red teaming outcome for a specific attack category.

### [AttackCategoryResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.AttackCategoryResultDict)

The red teaming outcome for a specific attack category.

### [BatchPredictionResourceUsageAssessmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionResourceUsageAssessmentConfig)

Config for batch prediction resource usage assessment.

### [BatchPredictionResourceUsageAssessmentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionResourceUsageAssessmentConfigDict)

Config for batch prediction resource usage assessment.

### [BatchPredictionResourceUsageAssessmentResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionResourceUsageAssessmentResult)

Result of batch prediction resource usage assessment.

### [BatchPredictionResourceUsageAssessmentResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionResourceUsageAssessmentResultDict)

Result of batch prediction resource usage assessment.

### [BatchPredictionValidationAssessmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionValidationAssessmentConfig)

Config for batch prediction validation assessment.

### [BatchPredictionValidationAssessmentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionValidationAssessmentConfigDict)

Config for batch prediction validation assessment.

### [BatchPredictionValidationAssessmentResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionValidationAssessmentResult)

Result of batch prediction validation assessment.

### [BatchPredictionValidationAssessmentResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BatchPredictionValidationAssessmentResultDict)

Result of batch prediction validation assessment.

### [BigQueryRequestSet](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BigQueryRequestSet)

Represents a BigQuery request set.

### [BigQueryRequestSetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BigQueryRequestSetDict)

Represents a BigQuery request set.

### [BleuInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuInput)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [BleuInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuInputDict)

API documentation for `BleuInputDict` class.

### [BleuInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuInstance)

Bleu instance.

### [BleuInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuInstanceDict)

Bleu instance.

### [BleuResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuResults)

Result of evaluating a bleu metric.

### [BleuResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.BleuResultsDict)

Result of evaluating a bleu metric.

### [CancelQueryJobAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CancelQueryJobAgentEngineConfig)

Config for canceling async querying agent engines.

### [CancelQueryJobAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CancelQueryJobAgentEngineConfigDict)

Config for canceling async querying agent engines.

### [CancelQueryJobResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CancelQueryJobResult)

Result of canceling a query job.

### [CancelQueryJobResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CancelQueryJobResultDict)

Result of canceling a query job.

### [CandidateResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CandidateResponse)

Responses from model or agent.

### [CandidateResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CandidateResponseDict)

Responses from model or agent.

### [CandidateResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CandidateResult)

Result for a single candidate.

### [CandidateResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CandidateResultDict)

Result for a single candidate.

### [CheckQueryJobAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobAgentEngineConfig)

Config for async querying agent engines.

### [CheckQueryJobAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobAgentEngineConfigDict)

Config for async querying agent engines.

### [CheckQueryJobResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobResponse)

Response from LRO.

### [CheckQueryJobResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobResponseDict)

Response from LRO.

### [CheckQueryJobResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobResult)

Result of checking a query job.

### [CheckQueryJobResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CheckQueryJobResultDict)

Result of checking a query job.

### [Chunk](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Chunk)

A chunk of data.

### [ChunkDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ChunkDict)

A chunk of data.

### [CodeExecutionMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CodeExecutionMetric)

A metric that executes custom Python code for evaluation.

### [CometResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CometResult)

Spec for Comet result - calculates the comet score for the given instance using the version specified in the spec.

### [CometResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CometResultDict)

Spec for Comet result - calculates the comet score for the given instance using the version specified in the spec.

### [ContainerSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContainerSpec)

The spec of a Container.

### [ContainerSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContainerSpecDict)

The spec of a Container.

### [ContentMap](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContentMap)

Map of placeholder in metric prompt template to contents of model input.

### [ContentMapContents](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContentMapContents)

Map of placeholder in metric prompt template to contents of model input.

### [ContentMapContentsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContentMapContentsDict)

Map of placeholder in metric prompt template to contents of model input.

### [ContentMapDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ContentMapDict)

Map of placeholder in metric prompt template to contents of model input.

### [CreateAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineConfig)

Config for create agent engine.

### [CreateAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineConfigDict)

Config for create agent engine.

### [CreateAgentEngineSandboxConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSandboxConfig)

Config for creating a Sandbox.

### [CreateAgentEngineSandboxConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSandboxConfigDict)

Config for creating a Sandbox.

### [CreateAgentEngineSandboxSnapshotConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSandboxSnapshotConfig)

Config for creating a Sandbox Environment Snapshot.

### [CreateAgentEngineSandboxSnapshotConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSandboxSnapshotConfigDict)

Config for creating a Sandbox Environment Snapshot.

### [CreateAgentEngineSessionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSessionConfig)

Config for creating a Session.

### [CreateAgentEngineSessionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineSessionConfigDict)

Config for creating a Session.

### [CreateAgentEngineTaskConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineTaskConfig)

Config for creating a Session.

### [CreateAgentEngineTaskConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateAgentEngineTaskConfigDict)

Config for creating a Session.

### [CreateDatasetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateDatasetConfig)

Config for creating a dataset resource to store prompts.

### [CreateDatasetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateDatasetConfigDict)

Config for creating a dataset resource to store prompts.

### [CreateDatasetVersionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateDatasetVersionConfig)

Config for creating a dataset version resource to store prompts.

### [CreateDatasetVersionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateDatasetVersionConfigDict)

Config for creating a dataset version resource to store prompts.

### [CreateEvaluationItemConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationItemConfig)

Config to create an evaluation item.

### [CreateEvaluationItemConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationItemConfigDict)

Config to create an evaluation item.

### [CreateEvaluationMetricConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationMetricConfig)

Config for creating an evaluation metric.

### [CreateEvaluationMetricConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationMetricConfigDict)

Config for creating an evaluation metric.

### [CreateEvaluationRunConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationRunConfig)

Config to create an evaluation run.

### [CreateEvaluationRunConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationRunConfigDict)

Config to create an evaluation run.

### [CreateEvaluationSetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationSetConfig)

Config to create an evaluation set.

### [CreateEvaluationSetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateEvaluationSetConfigDict)

Config to create an evaluation set.

### [CreateMultimodalDatasetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateMultimodalDatasetConfig)

Config for creating a dataset resource to store multimodal dataset.

### [CreateMultimodalDatasetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateMultimodalDatasetConfigDict)

Config for creating a dataset resource to store multimodal dataset.

### [CreatePromptConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreatePromptConfig)

Config for creating a prompt.

### [CreatePromptConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreatePromptConfigDict)

Config for creating a prompt.

### [CreatePromptVersionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreatePromptVersionConfig)

Config for creating a prompt version.

### [CreatePromptVersionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreatePromptVersionConfigDict)

Config for creating a prompt version.

### [CreateSandboxEnvironmentTemplateConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateSandboxEnvironmentTemplateConfig)

Config for creating a Sandbox Template.

### [CreateSandboxEnvironmentTemplateConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateSandboxEnvironmentTemplateConfigDict)

Config for creating a Sandbox Template.

### [CreateSkillConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateSkillConfig)

Config for creating a skill.

### [CreateSkillConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CreateSkillConfigDict)

Config for creating a skill.

### [CustomCodeExecutionSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomCodeExecutionSpec)

Specifies a metric using remote Python function execution.

This metric is computed by running user-defined Python functions remotely.

### [CustomCodeExecutionSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomCodeExecutionSpecDict)

Specifies a metric using remote Python function execution.

This metric is computed by running user-defined Python functions remotely.

### [CustomJob](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomJob)

Represents a job that runs custom workloads such as a Docker container or a Python package.

### [CustomJobDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomJobDict)

Represents a job that runs custom workloads such as a Docker container or a Python package.

### [CustomJobSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomJobSpec)

Represents a job that runs custom workloads such as a Docker container or a Python package.

### [CustomJobSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.CustomJobSpecDict)

Represents a job that runs custom workloads such as a Docker container or a Python package.

### [Dataset](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Dataset)

Represents a dataset resource to store prompts.

### [DatasetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DatasetDict)

Represents a dataset resource to store prompts.

### [DatasetOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DatasetOperation)

Represents the create dataset operation.

### [DatasetOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DatasetOperationDict)

Represents the create dataset operation.

### [DatasetVersion](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DatasetVersion)

Represents a dataset version resource to store prompts.

### [DatasetVersionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DatasetVersionDict)

Represents a dataset version resource to store prompts.

### [DefaultContainerCategory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DefaultContainerCategory)

The category of the default container image.

### [DeleteAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineConfig)

Config for deleting agent engine.

### [DeleteAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineConfigDict)

Config for deleting agent engine.

### [DeleteAgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineMemoryConfig)

Config for deleting an Agent Engine Memory.

### [DeleteAgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineMemoryConfigDict)

Config for deleting an Agent Engine Memory.

### [DeleteAgentEngineMemoryOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineMemoryOperation)

Operation for deleting agent engines.

### [DeleteAgentEngineMemoryOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineMemoryOperationDict)

Operation for deleting agent engines.

### [DeleteAgentEngineOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineOperation)

Operation for deleting agent engines.

### [DeleteAgentEngineOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineOperationDict)

Operation for deleting agent engines.

### [DeleteAgentEngineRuntimeRevisionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineRuntimeRevisionConfig)

Config for deleting an Agent Engine Runtime Revision.

### [DeleteAgentEngineRuntimeRevisionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineRuntimeRevisionConfigDict)

Config for deleting an Agent Engine Runtime Revision.

### [DeleteAgentEngineRuntimeRevisionOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineRuntimeRevisionOperation)

Operation for deleting agent engine runtime revisions.

### [DeleteAgentEngineRuntimeRevisionOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineRuntimeRevisionOperationDict)

Operation for deleting agent engine runtime revisions.

### [DeleteAgentEngineSandboxConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSandboxConfig)

Config for deleting an Agent Engine Sandbox.

### [DeleteAgentEngineSandboxConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSandboxConfigDict)

Config for deleting an Agent Engine Sandbox.

### [DeleteAgentEngineSandboxOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSandboxOperation)

Operation for deleting agent engines.

### [DeleteAgentEngineSandboxOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSandboxOperationDict)

Operation for deleting agent engines.

### [DeleteAgentEngineSessionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSessionConfig)

Config for deleting an Agent Engine Session.

### [DeleteAgentEngineSessionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSessionConfigDict)

Config for deleting an Agent Engine Session.

### [DeleteAgentEngineSessionOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSessionOperation)

Operation for deleting agent engine sessions.

### [DeleteAgentEngineSessionOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineSessionOperationDict)

Operation for deleting agent engine sessions.

### [DeleteAgentEngineTaskConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineTaskConfig)

Config for deleting an Agent Engine Task.

### [DeleteAgentEngineTaskConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteAgentEngineTaskConfigDict)

Config for deleting an Agent Engine Task.

### [DeleteEvaluationMetricConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteEvaluationMetricConfig)

Config for deleting an evaluation metric.

### [DeleteEvaluationMetricConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteEvaluationMetricConfigDict)

Config for deleting an evaluation metric.

### [DeleteEvaluationMetricOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteEvaluationMetricOperation)

Operation for deleting an evaluation metric.

### [DeleteEvaluationMetricOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteEvaluationMetricOperationDict)

Operation for deleting an evaluation metric.

### [DeletePromptConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptConfig)

Config for deleting a prompt.

### [DeletePromptConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptConfigDict)

Config for deleting a prompt.

### [DeletePromptOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptOperation)

Operation for deleting prompts.

### [DeletePromptOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptOperationDict)

Operation for deleting prompts.

### [DeletePromptVersionOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptVersionOperation)

Operation for deleting prompt versions.

### [DeletePromptVersionOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeletePromptVersionOperationDict)

Operation for deleting prompt versions.

### [DeleteSandboxEnvironmentSnapshotConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentSnapshotConfig)

Config for deleting a Sandbox Environment Snapshot.

### [DeleteSandboxEnvironmentSnapshotConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentSnapshotConfigDict)

Config for deleting a Sandbox Environment Snapshot.

### [DeleteSandboxEnvironmentSnapshotOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentSnapshotOperation)

Operation for deleting sandbox environment snapshots.

### [DeleteSandboxEnvironmentSnapshotOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentSnapshotOperationDict)

Operation for deleting sandbox environment snapshots.

### [DeleteSandboxEnvironmentTemplateConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentTemplateConfig)

Config for deleting a Sandbox Template.

### [DeleteSandboxEnvironmentTemplateConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentTemplateConfigDict)

Config for deleting a Sandbox Template.

### [DeleteSandboxEnvironmentTemplateOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentTemplateOperation)

Operation for deleting sandbox templates.

### [DeleteSandboxEnvironmentTemplateOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSandboxEnvironmentTemplateOperationDict)

Operation for deleting sandbox templates.

### [DeleteSkillConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSkillConfig)

Config for deleting a skill.

### [DeleteSkillConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSkillConfigDict)

Config for deleting a skill.

### [DeleteSkillOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSkillOperation)

Operation for deleting a skill.

### [DeleteSkillOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DeleteSkillOperationDict)

Operation for deleting a skill.

### [DiskSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DiskSpec)

Represents the spec of disk options.

### [DiskSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DiskSpecDict)

Represents the spec of disk options.

### [DnsPeeringConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DnsPeeringConfig)

DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.

### [DnsPeeringConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.DnsPeeringConfigDict)

DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.

### [EnvVar](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EnvVar)

Represents an environment variable present in a Container or Python Module.

### [EnvVarDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EnvVarDict)

Represents an environment variable present in a Container or Python Module.

### [EvalCase](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCase)

A comprehensive representation of a GenAI interaction for evaluation.

### [EvalCaseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCaseDict)

A comprehensive representation of a GenAI interaction for evaluation.

### [EvalCaseMetricResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCaseMetricResult)

Evaluation result for a single evaluation case for a single metric.

### [EvalCaseMetricResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCaseMetricResultDict)

Evaluation result for a single evaluation case for a single metric.

### [EvalCaseResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCaseResult)

Eval result for a single evaluation case.

### [EvalCaseResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalCaseResultDict)

Eval result for a single evaluation case.

### [EvalRunInferenceConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalRunInferenceConfig)

Optional parameters for inference.

### [EvalRunInferenceConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvalRunInferenceConfigDict)

Optional parameters for inference.

### [EvaluateDatasetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetConfig)

Config for evaluate instances.

### [EvaluateDatasetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetConfigDict)

Config for evaluate instances.

### [EvaluateDatasetOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetOperation)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [EvaluateDatasetOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetOperationDict)

API documentation for `EvaluateDatasetOperationDict` class.

### [EvaluateDatasetRequestParameters](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetRequestParameters)

Parameters for batch dataset evaluation.

### [EvaluateDatasetRequestParametersDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateDatasetRequestParametersDict)

Parameters for batch dataset evaluation.

### [EvaluateInstancesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateInstancesConfig)

Config for evaluate instances.

### [EvaluateInstancesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateInstancesConfigDict)

Config for evaluate instances.

### [EvaluateInstancesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateInstancesResponse)

Result of evaluating an LLM metric.

### [EvaluateInstancesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateInstancesResponseDict)

Result of evaluating an LLM metric.

### [EvaluateMethodConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateMethodConfig)

Optional parameters for the evaluate method.

### [EvaluateMethodConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluateMethodConfigDict)

Optional parameters for the evaluate method.

### [EvaluationDataset](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationDataset)

The dataset used for evaluation.

### [EvaluationDatasetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationDatasetDict)

The dataset used for evaluation.

### [EvaluationInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationInstance)

A single instance to be evaluated.

### [EvaluationInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationInstanceDict)

A single instance to be evaluated.

### [EvaluationItem](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItem)

EvaluationItem is a single evaluation request or result.

The content of an EvaluationItem is immutable - it cannot be updated once
created. EvaluationItems can be deleted when no longer needed.

### [EvaluationItemDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemDict)

EvaluationItem is a single evaluation request or result.

The content of an EvaluationItem is immutable - it cannot be updated once
created. EvaluationItems can be deleted when no longer needed.

### [EvaluationItemRequest](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemRequest)

Single evaluation request.

### [EvaluationItemRequestDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemRequestDict)

Single evaluation request.

### [EvaluationItemResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemResult)

Represents the result of an evaluation item.

### [EvaluationItemResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemResultDict)

Represents the result of an evaluation item.

### [EvaluationItemType](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationItemType)

The type of the EvaluationItem.

### [EvaluationMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationMetric)

Represents an evaluation metric.

### [EvaluationMetricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationMetricDict)

Represents an evaluation metric.

### [EvaluationPrompt](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationPrompt)

Represents the prompt to be evaluated.

### [EvaluationPromptDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationPromptDict)

Represents the prompt to be evaluated.

### [EvaluationResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationResult)

Result of an evaluation run for an evaluation dataset.

### [EvaluationResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationResultDict)

Result of an evaluation run for an evaluation dataset.

### [EvaluationRun](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRun)

Represents an evaluation run.

### [EvaluationRunAgentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunAgentConfig)

This field is experimental and may change in future versions.

Agent config for an evaluation run.

### [EvaluationRunAgentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunAgentConfigDict)

This field is experimental and may change in future versions.

Agent config for an evaluation run.

### [EvaluationRunConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunConfig)

The evaluation configuration used for the evaluation run.

### [EvaluationRunConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunConfigDict)

The evaluation configuration used for the evaluation run.

### [EvaluationRunDataSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunDataSource)

Represents an evaluation run data source.

### [EvaluationRunDataSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunDataSourceDict)

Represents an evaluation run data source.

### [EvaluationRunDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunDict)

Represents an evaluation run.

### [EvaluationRunInferenceConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunInferenceConfig)

This field is experimental and may change in future versions.

Configuration that describes an agent.

### [EvaluationRunInferenceConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunInferenceConfigDict)

This field is experimental and may change in future versions.

Configuration that describes an agent.

### [EvaluationRunMetadata](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunMetadata)

Metadata for an evaluation run.

### [EvaluationRunMetadataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunMetadataDict)

Metadata for an evaluation run.

### [EvaluationRunMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunMetric)

The metric used for evaluation run.

### [EvaluationRunMetricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunMetricDict)

The metric used for evaluation run.

### [EvaluationRunPromptTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunPromptTemplate)

Prompt template used for inference.

Only one of `prompt_template` or `gcs_uri` should be set. If both are
provided, an error will be raised.

### [EvaluationRunPromptTemplateDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunPromptTemplateDict)

Prompt template used for inference.

Only one of `prompt_template` or `gcs_uri` should be set. If both are
provided, an error will be raised.

### [EvaluationRunResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunResults)

Represents the results of an evaluation run.

### [EvaluationRunResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunResultsDict)

Represents the results of an evaluation run.

### [EvaluationRunState](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationRunState)

Represents the state of an evaluation run.

### [EvaluationSet](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationSet)

Represents an evaluation set.

### [EvaluationSetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EvaluationSetDict)

Represents an evaluation set.

### [Event](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Event)

Represents an event in a conversation between agents and users.

It is used to store the content of the conversation, as well as the actions
taken by the agents like function calls, function responses, intermediate NL
responses etc.

### [EventActions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EventActions)

Actions are parts of events that are executed by the agent.

### [EventActionsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EventActionsDict)

Actions are parts of events that are executed by the agent.

### [EventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EventDict)

Represents an event in a conversation between agents and users.

It is used to store the content of the conversation, as well as the actions
taken by the agents like function calls, function responses, intermediate NL
responses etc.

### [EventMetadata](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EventMetadata)

Metadata relating to a LLM response event.

### [EventMetadataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.EventMetadataDict)

Metadata relating to a LLM response event.

### [ExactMatchInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchInput)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [ExactMatchInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchInputDict)

API documentation for `ExactMatchInputDict` class.

### [ExactMatchInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchInstance)

Exact match instance.

### [ExactMatchInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchInstanceDict)

Exact match instance.

### [ExactMatchResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchResults)

Result of evaluating an exact match metric.

### [ExactMatchResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchResultsDict)

Result of evaluating an exact match metric.

### [ExactMatchSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchSpec)

Spec for exact match metric.

### [ExactMatchSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExactMatchSpecDict)

Spec for exact match metric.

### [ExecuteCodeAgentEngineSandboxConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExecuteCodeAgentEngineSandboxConfig)

Config for executing code in an Agent Engine sandbox.

### [ExecuteCodeAgentEngineSandboxConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExecuteCodeAgentEngineSandboxConfigDict)

Config for executing code in an Agent Engine sandbox.

### [ExecuteSandboxEnvironmentResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExecuteSandboxEnvironmentResponse)

The response for executing a sandbox environment.

### [ExecuteSandboxEnvironmentResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ExecuteSandboxEnvironmentResponseDict)

The response for executing a sandbox environment.

### [FailedRubric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.FailedRubric)

A specific failed rubric and the associated analysis.

### [FailedRubricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.FailedRubricDict)

A specific failed rubric and the associated analysis.

### [Framework](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Framework)

Framework used to build the application.

### [GeminiExample](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiExample)

Represents a Gemini example.

### [GeminiExampleDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiExampleDict)

Represents a Gemini example.

### [GeminiRequestReadConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiRequestReadConfig)

Represents the config for reading Gemini requests.

### [GeminiRequestReadConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiRequestReadConfigDict)

Represents the config for reading Gemini requests.

### [GeminiTemplateConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiTemplateConfig)

Represents a Gemini template config.

### [GeminiTemplateConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GeminiTemplateConfigDict)

Represents a Gemini template config.

### [GenerateAgentEngineMemoriesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateAgentEngineMemoriesConfig)

Config for generating memories.

### [GenerateAgentEngineMemoriesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateAgentEngineMemoriesConfigDict)

Config for generating memories.

### [GenerateInstanceRubricsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateInstanceRubricsResponse)

Response for generating rubrics.

### [GenerateInstanceRubricsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateInstanceRubricsResponseDict)

Response for generating rubrics.

### [GenerateLossClustersConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersConfig)

Config for generating loss clusters.

### [GenerateLossClustersConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersConfigDict)

Config for generating loss clusters.

### [GenerateLossClustersOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersOperation)

Long-running operation for generating loss clusters.

### [GenerateLossClustersOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersOperationDict)

Long-running operation for generating loss clusters.

### [GenerateLossClustersResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersResponse)

Response message for EvaluationAnalyticsService.GenerateLossClusters.

### [GenerateLossClustersResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateLossClustersResponseDict)

Response message for EvaluationAnalyticsService.GenerateLossClusters.

### [GenerateMemoriesRequestDirectContentsSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectContentsSource)

The direct contents source for generating memories.

### [GenerateMemoriesRequestDirectContentsSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectContentsSourceDict)

The direct contents source for generating memories.

### [GenerateMemoriesRequestDirectContentsSourceEvent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectContentsSourceEvent)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GenerateMemoriesRequestDirectContentsSourceEventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectContentsSourceEventDict)

API documentation for `GenerateMemoriesRequestDirectContentsSourceEventDict` class.

### [GenerateMemoriesRequestDirectMemoriesSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectMemoriesSource)

The direct memories source for generating memories.

### [GenerateMemoriesRequestDirectMemoriesSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectMemoriesSourceDict)

The direct memories source for generating memories.

### [GenerateMemoriesRequestDirectMemoriesSourceDirectMemory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectMemoriesSourceDirectMemory)

A direct memory to upload to Memory Bank.

### [GenerateMemoriesRequestDirectMemoriesSourceDirectMemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestDirectMemoriesSourceDirectMemoryDict)

A direct memory to upload to Memory Bank.

### [GenerateMemoriesRequestVertexSessionSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestVertexSessionSource)

The vertex session source for generating memories.

### [GenerateMemoriesRequestVertexSessionSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesRequestVertexSessionSourceDict)

The vertex session source for generating memories.

### [GenerateMemoriesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesResponse)

The response for generating memories.

### [GenerateMemoriesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesResponseDict)

The response for generating memories.

### [GenerateMemoriesResponseGeneratedMemory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesResponseGeneratedMemory)

A memory that was generated.

### [GenerateMemoriesResponseGeneratedMemoryAction](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesResponseGeneratedMemoryAction)

The action to take.

### [GenerateMemoriesResponseGeneratedMemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateMemoriesResponseGeneratedMemoryDict)

A memory that was generated.

### [GenerateUserScenariosConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateUserScenariosConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GenerateUserScenariosConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateUserScenariosConfigDict)

API documentation for `GenerateUserScenariosConfigDict` class.

### [GenerateUserScenariosResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateUserScenariosResponse)

Response message for DataFoundryService.GenerateUserScenarios.

### [GenerateUserScenariosResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GenerateUserScenariosResponseDict)

Response message for DataFoundryService.GenerateUserScenarios.

### [GetAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineConfig)

Config for create agent engine.

### [GetAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineConfigDict)

Config for create agent engine.

### [GetAgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineMemoryConfig)

Config for getting an Agent Engine Memory.

### [GetAgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineMemoryConfigDict)

Config for getting an Agent Engine Memory.

### [GetAgentEngineMemoryRevisionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineMemoryRevisionConfig)

Config for getting an Agent Engine Memory Revision.

### [GetAgentEngineMemoryRevisionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineMemoryRevisionConfigDict)

Config for getting an Agent Engine Memory Revision.

### [GetAgentEngineOperationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineOperationConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GetAgentEngineOperationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineOperationConfigDict)

API documentation for `GetAgentEngineOperationConfigDict` class.

### [GetAgentEngineRuntimeRevisionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineRuntimeRevisionConfig)

Config for getting an Agent Engine Runtime Revision.

### [GetAgentEngineRuntimeRevisionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineRuntimeRevisionConfigDict)

Config for getting an Agent Engine Runtime Revision.

### [GetAgentEngineSandboxConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineSandboxConfig)

Config for getting an Agent Engine Memory.

### [GetAgentEngineSandboxConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineSandboxConfigDict)

Config for getting an Agent Engine Memory.

### [GetAgentEngineSessionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineSessionConfig)

Config for getting an Agent Engine Session.

### [GetAgentEngineSessionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineSessionConfigDict)

Config for getting an Agent Engine Session.

### [GetAgentEngineTaskConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineTaskConfig)

Config for getting an Agent Engine Task.

### [GetAgentEngineTaskConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetAgentEngineTaskConfigDict)

Config for getting an Agent Engine Task.

### [GetDatasetOperationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetDatasetOperationConfig)

Config for getting a dataset version operation.

### [GetDatasetOperationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetDatasetOperationConfigDict)

Config for getting a dataset version operation.

### [GetDeleteAgentEngineRuntimeRevisionOperationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetDeleteAgentEngineRuntimeRevisionOperationConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GetDeleteAgentEngineRuntimeRevisionOperationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetDeleteAgentEngineRuntimeRevisionOperationConfigDict)

API documentation for `GetDeleteAgentEngineRuntimeRevisionOperationConfigDict` class.

### [GetEvaluationItemConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationItemConfig)

Config for get evaluation item.

### [GetEvaluationItemConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationItemConfigDict)

Config for get evaluation item.

### [GetEvaluationMetricConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationMetricConfig)

Config for getting an evaluation metric.

### [GetEvaluationMetricConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationMetricConfigDict)

Config for getting an evaluation metric.

### [GetEvaluationRunConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationRunConfig)

Config for get evaluation run.

### [GetEvaluationRunConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationRunConfigDict)

Config for get evaluation run.

### [GetEvaluationSetConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationSetConfig)

Config for get evaluation set.

### [GetEvaluationSetConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetEvaluationSetConfigDict)

Config for get evaluation set.

### [GetMultimodalDatasetOperationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetMultimodalDatasetOperationConfig)

Config for getting a multimodal dataset operation.

### [GetMultimodalDatasetOperationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetMultimodalDatasetOperationConfigDict)

Config for getting a multimodal dataset operation.

### [GetPromptConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetPromptConfig)

Config for getting a prompt.

### [GetPromptConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetPromptConfigDict)

Config for getting a prompt.

### [GetSandboxEnvironmentSnapshotConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSandboxEnvironmentSnapshotConfig)

Config for getting a Sandbox Environment Snapshot.

### [GetSandboxEnvironmentSnapshotConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSandboxEnvironmentSnapshotConfigDict)

Config for getting a Sandbox Environment Snapshot.

### [GetSandboxEnvironmentTemplateConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSandboxEnvironmentTemplateConfig)

Config for getting a Sandbox Template.

### [GetSandboxEnvironmentTemplateConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSandboxEnvironmentTemplateConfigDict)

Config for getting a Sandbox Template.

### [GetSkillConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillConfig)

Config for getting a skill.

### [GetSkillConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillConfigDict)

Config for getting a skill.

### [GetSkillOperationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillOperationConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GetSkillOperationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillOperationConfigDict)

API documentation for `GetSkillOperationConfigDict` class.

### [GetSkillRevisionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillRevisionConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [GetSkillRevisionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.GetSkillRevisionConfigDict)

API documentation for `GetSkillRevisionConfigDict` class.

### [IdentityType](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IdentityType)

The identity type to use for the Reasoning Engine. If not specified, the `service_account` field will be used if set, otherwise the default Vertex AI Reasoning Engine Service Agent in the project will be used.

### [Importance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Importance)

Importance level of the rubric.

### [IngestEventsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestEventsConfig)

Config for ingesting events.

### [IngestEventsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestEventsConfigDict)

Config for ingesting events.

### [IngestionDirectContentsSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestionDirectContentsSource)

The direct contents source for ingesting events.

### [IngestionDirectContentsSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestionDirectContentsSourceDict)

The direct contents source for ingesting events.

### [IngestionDirectContentsSourceEvent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestionDirectContentsSourceEvent)

The direct contents source event for ingesting events.

### [IngestionDirectContentsSourceEventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IngestionDirectContentsSourceEventDict)

The direct contents source event for ingesting events.

### [IntermediateExtractedMemory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IntermediateExtractedMemory)

An extracted memory that is the intermediate result before consolidation.

### [IntermediateExtractedMemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.IntermediateExtractedMemoryDict)

An extracted memory that is the intermediate result before consolidation.

### [JobState](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.JobState)

Output only. The detailed state of the job.

### [KeepAliveProbe](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.KeepAliveProbe)

Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.

### [KeepAliveProbeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.KeepAliveProbeDict)

Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.

### [KeepAliveProbeHttpGet](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.KeepAliveProbeHttpGet)

Specifies the HTTP GET configuration for the probe.

### [KeepAliveProbeHttpGetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.KeepAliveProbeHttpGetDict)

Specifies the HTTP GET configuration for the probe.

### [LLMMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LLMMetric)

A metric that uses LLM-as-a-judge for evaluation.

### [Language](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Language)

The coding language supported in this environment.

### [ListAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineConfig)

Config for listing agent engines.

### [ListAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineConfigDict)

Config for listing agent engines.

### [ListAgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryConfig)

Config for listing agent engine memories.

### [ListAgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryConfigDict)

Config for listing agent engine memories.

### [ListAgentEngineMemoryRevisionsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryRevisionsConfig)

Config for listing Agent Engine memory revisions.

### [ListAgentEngineMemoryRevisionsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryRevisionsConfigDict)

Config for listing Agent Engine memory revisions.

### [ListAgentEngineMemoryRevisionsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryRevisionsResponse)

Response for listing agent engine memory revisions.

### [ListAgentEngineMemoryRevisionsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineMemoryRevisionsResponseDict)

Response for listing agent engine memory revisions.

### [ListAgentEngineRuntimeRevisionsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineRuntimeRevisionsConfig)

Config for listing reasoning engine runtime revisions.

### [ListAgentEngineRuntimeRevisionsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineRuntimeRevisionsConfigDict)

Config for listing reasoning engine runtime revisions.

### [ListAgentEngineSandboxesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSandboxesConfig)

Config for listing agent engine sandboxes.

### [ListAgentEngineSandboxesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSandboxesConfigDict)

Config for listing agent engine sandboxes.

### [ListAgentEngineSandboxesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSandboxesResponse)

Response for listing agent engine sandboxes.

### [ListAgentEngineSandboxesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSandboxesResponseDict)

Response for listing agent engine sandboxes.

### [ListAgentEngineSessionEventsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionEventsConfig)

Config for listing agent engine session events.

### [ListAgentEngineSessionEventsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionEventsConfigDict)

Config for listing agent engine session events.

### [ListAgentEngineSessionEventsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionEventsResponse)

Response for listing agent engine session events.

### [ListAgentEngineSessionEventsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionEventsResponseDict)

Response for listing agent engine session events.

### [ListAgentEngineSessionsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionsConfig)

Config for listing agent engine sessions.

### [ListAgentEngineSessionsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineSessionsConfigDict)

Config for listing agent engine sessions.

### [ListAgentEngineTaskEventsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTaskEventsConfig)

Config for listing agent engine tasks.

### [ListAgentEngineTaskEventsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTaskEventsConfigDict)

Config for listing agent engine tasks.

### [ListAgentEngineTaskEventsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTaskEventsResponse)

Response for listing Agent Engine tasks events.

### [ListAgentEngineTaskEventsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTaskEventsResponseDict)

Response for listing Agent Engine tasks events.

### [ListAgentEngineTasksConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTasksConfig)

Config for listing agent engine tasks.

### [ListAgentEngineTasksConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTasksConfigDict)

Config for listing agent engine tasks.

### [ListAgentEngineTasksResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTasksResponse)

Response for listing agent engine tasks.

### [ListAgentEngineTasksResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListAgentEngineTasksResponseDict)

Response for listing agent engine tasks.

### [ListDatasetVersionsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListDatasetVersionsResponse)

Response for listing prompt datasets.

### [ListDatasetVersionsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListDatasetVersionsResponseDict)

Response for listing prompt datasets.

### [ListDatasetsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListDatasetsResponse)

Response for listing prompt datasets.

### [ListDatasetsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListDatasetsResponseDict)

Response for listing prompt datasets.

### [ListEvaluationMetricsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListEvaluationMetricsConfig)

Config for listing evaluation metrics.

### [ListEvaluationMetricsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListEvaluationMetricsConfigDict)

Config for listing evaluation metrics.

### [ListEvaluationMetricsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListEvaluationMetricsResponse)

Response for listing evaluation metrics.

### [ListEvaluationMetricsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListEvaluationMetricsResponseDict)

Response for listing evaluation metrics.

### [ListMultimodalDatasetsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListMultimodalDatasetsConfig)

Config for listing multimodal datasets.

### [ListMultimodalDatasetsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListMultimodalDatasetsConfigDict)

Config for listing multimodal datasets.

### [ListMultimodalDatasetsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListMultimodalDatasetsResponse)

Response for listing multimodal datasets.

### [ListMultimodalDatasetsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListMultimodalDatasetsResponseDict)

Response for listing multimodal datasets.

### [ListPromptsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListPromptsConfig)

Config for listing prompt datasets and dataset versions.

### [ListPromptsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListPromptsConfigDict)

Config for listing prompt datasets and dataset versions.

### [ListReasoningEnginesMemoriesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesMemoriesResponse)

Response for listing agent engine memories.

### [ListReasoningEnginesMemoriesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesMemoriesResponseDict)

Response for listing agent engine memories.

### [ListReasoningEnginesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesResponse)

Response for listing agent engines.

### [ListReasoningEnginesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesResponseDict)

Response for listing agent engines.

### [ListReasoningEnginesRuntimeRevisionsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesRuntimeRevisionsResponse)

Response for listing agent engine runtime revisions.

### [ListReasoningEnginesRuntimeRevisionsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesRuntimeRevisionsResponseDict)

Response for listing agent engine runtime revisions.

### [ListReasoningEnginesSessionsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesSessionsResponse)

Response for listing agent engine sessions.

### [ListReasoningEnginesSessionsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListReasoningEnginesSessionsResponseDict)

Response for listing agent engine sessions.

### [ListSandboxEnvironmentSnapshotsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentSnapshotsConfig)

Config for listing sandbox environment snapshots.

### [ListSandboxEnvironmentSnapshotsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentSnapshotsConfigDict)

Config for listing sandbox environment snapshots.

### [ListSandboxEnvironmentSnapshotsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentSnapshotsResponse)

Response for listing sandbox environment snapshots.

### [ListSandboxEnvironmentSnapshotsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentSnapshotsResponseDict)

Response for listing sandbox environment snapshots.

### [ListSandboxEnvironmentTemplatesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentTemplatesConfig)

Config for listing sandbox templates.

### [ListSandboxEnvironmentTemplatesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentTemplatesConfigDict)

Config for listing sandbox templates.

### [ListSandboxEnvironmentTemplatesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentTemplatesResponse)

Response for listing sandbox templates.

### [ListSandboxEnvironmentTemplatesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSandboxEnvironmentTemplatesResponseDict)

Response for listing sandbox templates.

### [ListSkillRevisionsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillRevisionsConfig)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [ListSkillRevisionsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillRevisionsConfigDict)

API documentation for `ListSkillRevisionsConfigDict` class.

### [ListSkillRevisionsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillRevisionsResponse)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [ListSkillRevisionsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillRevisionsResponseDict)

API documentation for `ListSkillRevisionsResponseDict` class.

### [ListSkillsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillsConfig)

Config for listing skills.

### [ListSkillsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillsConfigDict)

Config for listing skills.

### [ListSkillsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillsResponse)

Response for listing skills.

### [ListSkillsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ListSkillsResponseDict)

Response for listing skills.

### [LossAnalysisConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossAnalysisConfig)

Configuration for the loss analysis job.

### [LossAnalysisConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossAnalysisConfigDict)

Configuration for the loss analysis job.

### [LossAnalysisResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossAnalysisResult)

The top-level result for loss analysis.

### [LossAnalysisResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossAnalysisResultDict)

The top-level result for loss analysis.

### [LossCluster](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossCluster)

A semantic grouping of failures (e.g., "Hallucination of Action").

### [LossClusterDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossClusterDict)

A semantic grouping of failures (e.g., "Hallucination of Action").

### [LossExample](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossExample)

A specific example of a loss pattern.

### [LossExampleDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossExampleDict)

A specific example of a loss pattern.

### [LossTaxonomyEntry](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossTaxonomyEntry)

A specific entry in the loss pattern taxonomy.

### [LossTaxonomyEntryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LossTaxonomyEntryDict)

A specific entry in the loss pattern taxonomy.

### [LustreMount](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LustreMount)

Represents a mount configuration for Lustre file system.

### [LustreMountDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.LustreMountDict)

Represents a mount configuration for Lustre file system.

### [MachineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MachineConfig)

The machine config of the code execution environment.

### [MachineSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MachineSpec)

Specification of a single machine.

### [MachineSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MachineSpecDict)

Specification of a single machine.

### [ManagedTopicEnum](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ManagedTopicEnum)

Represents the managed memory topic.

### [MapInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MapInstance)

Instance data specified as a map.

### [MapInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MapInstanceDict)

Instance data specified as a map.

### [Memory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Memory)

A memory.

### [MemoryBankCustomizationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfig)

Represents configuration for organizing natural language memories for a particular scope.

### [MemoryBankCustomizationConfigConsolidationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigConsolidationConfig)

Represents configuration for customizing how memories are consolidated.

### [MemoryBankCustomizationConfigConsolidationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigConsolidationConfigDict)

Represents configuration for customizing how memories are consolidated.

### [MemoryBankCustomizationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigDict)

Represents configuration for organizing natural language memories for a particular scope.

### [MemoryBankCustomizationConfigGenerateMemoriesExample](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExample)

An example of how to generate memories for a particular scope.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource)

A conversation source for the example. This is similar to `DirectContentsSource`.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceDict)

A conversation source for the example. This is similar to `DirectContentsSource`.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent)

The conversation source event for generating memories.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEventDict)

The conversation source event for generating memories.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleDict)

An example of how to generate memories for a particular scope.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory)

A memory generated by the operation.

### [MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemoryDict)

A memory generated by the operation.

### [MemoryBankCustomizationConfigMemoryTopic](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopic)

A topic of information that should be extracted from conversations and stored as memories.

### [MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic)

A custom memory topic defined by the developer.

### [MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopicDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopicDict)

A custom memory topic defined by the developer.

### [MemoryBankCustomizationConfigMemoryTopicDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopicDict)

A topic of information that should be extracted from conversations and stored as memories.

### [MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic)

A managed memory topic defined by the system.

### [MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopicDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopicDict)

A managed memory topic defined by the system.

### [MemoryBankIngestEventsOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankIngestEventsOperation)

Operation that ingests events into a memory bank.

### [MemoryBankIngestEventsOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryBankIngestEventsOperationDict)

Operation that ingests events into a memory bank.

### [MemoryConjunctionFilter](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryConjunctionFilter)

The conjunction filter for memories.

### [MemoryConjunctionFilterDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryConjunctionFilterDict)

The conjunction filter for memories.

### [MemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryDict)

A memory.

### [MemoryFilter](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryFilter)

Filter to apply when retrieving memories.

### [MemoryFilterDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryFilterDict)

Filter to apply when retrieving memories.

### [MemoryGenerationTriggerConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryGenerationTriggerConfig)

The configuration for triggering memory generation for ingested events.

### [MemoryGenerationTriggerConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryGenerationTriggerConfigDict)

The configuration for triggering memory generation for ingested events.

### [MemoryGenerationTriggerConfigGenerationTriggerRule](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryGenerationTriggerConfigGenerationTriggerRule)

Represents the active rule that determines when to flush the buffer.

### [MemoryGenerationTriggerConfigGenerationTriggerRuleDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryGenerationTriggerConfigGenerationTriggerRuleDict)

Represents the active rule that determines when to flush the buffer.

### [MemoryMetadataMergeStrategy](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryMetadataMergeStrategy)

The strategy to use when applying metadata to existing memories during consolidation.

### [MemoryMetadataValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryMetadataValue)

The metadata values for memories.

### [MemoryMetadataValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryMetadataValueDict)

The metadata values for memories.

### [MemoryProfile](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryProfile)

A memory profile.

### [MemoryProfileDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryProfileDict)

A memory profile.

### [MemoryRevision](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryRevision)

A memory revision.

### [MemoryRevisionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryRevisionDict)

A memory revision.

### [MemoryStructuredContent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryStructuredContent)

Represents the structured value of the memory.

### [MemoryStructuredContentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryStructuredContentDict)

Represents the structured value of the memory.

### [MemoryTopicId](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryTopicId)

The topic ID for a memory.

### [MemoryTopicIdDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryTopicIdDict)

The topic ID for a memory.

### [MemoryType](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MemoryType)

The type of the memory.

### [Message](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Message)

Represents a single message turn in a conversation.

### [MessageDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MessageDict)

Represents a single message turn in a conversation.

### [Metadata](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Metadata)

Metadata for a chunk.

### [MetadataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetadataDict)

Metadata for a chunk.

### [Metric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Metric)

The metric used for evaluation.

### [MetricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricDict)

The metric used for evaluation.

### [MetricPromptBuilder](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricPromptBuilder)

Builder class for structured LLM-based metric prompt template.

### [MetricResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricResult)

Result for a single metric on a single instance.

### [MetricResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricResultDict)

Result for a single metric on a single instance.

### [MetricSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricSource)

The metric source used for evaluation.

### [MetricSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricSourceDict)

The metric source used for evaluation.

### [MetricxResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricxResult)

Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.

### [MetricxResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MetricxResultDict)

Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.

### [MultimodalDataset](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MultimodalDataset)

Represents a multimodal dataset.

### [MultimodalDatasetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MultimodalDatasetDict)

Represents a multimodal dataset.

### [MultimodalDatasetOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MultimodalDatasetOperation)

Represents the create dataset operation.

### [MultimodalDatasetOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.MultimodalDatasetOperationDict)

Represents the create dataset operation.

### [NfsMount](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.NfsMount)

Represents a mount configuration for Network File System (NFS) to mount.

### [NfsMountDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.NfsMountDict)

Represents a mount configuration for Network File System (NFS) to mount.

### [ObservabilityEvalCase](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ObservabilityEvalCase)

A single evaluation case instance for data stored in GCP Observability.

### [ObservabilityEvalCaseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ObservabilityEvalCaseDict)

A single evaluation case instance for data stored in GCP Observability.

### [Operator](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Operator)

Represents the operator to apply to the filter. If not set, then EQUAL will be used.

### [OptimizationMethod](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizationMethod)

The method for data driven prompt optimization.

### [OptimizeConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeConfig)

Config for Prompt Optimizer.

### [OptimizeConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeConfigDict)

Config for Prompt Optimizer.

### [OptimizeJobConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeJobConfig)

VAPO Prompt Optimizer Config.

### [OptimizeJobConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeJobConfigDict)

VAPO Prompt Optimizer Config.

### [OptimizeResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeResponse)

Response for the optimize_prompt method.

### [OptimizeResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeResponseDict)

Response for the optimize_prompt method.

### [OptimizeResponseEndpoint](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeResponseEndpoint)

Response for the optimize_prompt method.

### [OptimizeResponseEndpointDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeResponseEndpointDict)

Response for the optimize_prompt method.

### [OptimizeTarget](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.OptimizeTarget)

Specifies the method for calling the optimize_prompt.

### [PairwiseMetricInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PairwiseMetricInput)

Pairwise metric instance.

### [PairwiseMetricInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PairwiseMetricInputDict)

Pairwise metric instance.

### [PairwiseMetricInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PairwiseMetricInstance)

Pairwise metric instance.

### [PairwiseMetricInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PairwiseMetricInstanceDict)

Pairwise metric instance.

### [PointwiseMetricInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PointwiseMetricInput)

Pointwise metric input.

### [PointwiseMetricInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PointwiseMetricInputDict)

Pointwise metric input.

### [PointwiseMetricInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PointwiseMetricInstance)

Pointwise metric instance.

### [PointwiseMetricInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PointwiseMetricInstanceDict)

Pointwise metric instance.

### [PostSnapshotAction](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PostSnapshotAction)

Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.

### [Prompt](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Prompt)

Represents a prompt.

### [PromptDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptDict)

Represents a prompt.

### [PromptOptimizerConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptOptimizerConfig)

VAPO Prompt Optimizer Config.

### [PromptOptimizerConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptOptimizerConfigDict)

VAPO Prompt Optimizer Config.

### [PromptOptimizerMethod](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptOptimizerMethod)

The method for data driven prompt optimization.

### [PromptRef](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptRef)

Reference to a prompt.

### [PromptRefDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptRefDict)

Reference to a prompt.

### [PromptTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptTemplate)

A prompt template for creating prompts with variables.

### [PromptTemplateData](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptTemplateData)

Holds data for a prompt template.

Message to hold a prompt template and the values to populate the template.

### [PromptTemplateDataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptTemplateDataDict)

Holds data for a prompt template.

Message to hold a prompt template and the values to populate the template.

### [PromptTemplateDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptTemplateDict)

A prompt template for creating prompts with variables.

### [PromptVersionRef](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptVersionRef)

Reference to a prompt version.

### [PromptVersionRefDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PromptVersionRefDict)

Reference to a prompt version.

### [Protocol](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Protocol)

Protocol for port. Defaults to TCP if not specified.

### [PscInterfaceConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PscInterfaceConfig)

Configuration for PSC-I.

### [PscInterfaceConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PscInterfaceConfigDict)

Configuration for PSC-I.

### [PurgeAgentEngineMemoriesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PurgeAgentEngineMemoriesConfig)

Config for purging memories.

### [PurgeAgentEngineMemoriesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PurgeAgentEngineMemoriesConfigDict)

Config for purging memories.

### [PurgeMemoriesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PurgeMemoriesResponse)

The response for purging memories.

### [PurgeMemoriesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PurgeMemoriesResponseDict)

The response for purging memories.

### [PythonPackageSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PythonPackageSpec)

The spec of a Python packaged code.

### [PythonPackageSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.PythonPackageSpecDict)

The spec of a Python packaged code.

### [QueryAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryAgentEngineConfig)

Config for querying agent engines.

### [QueryAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryAgentEngineConfigDict)

Config for querying agent engines.

### [QueryAgentEngineRuntimeRevisionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryAgentEngineRuntimeRevisionConfig)

Config for querying agent engine runtime revisions.

### [QueryAgentEngineRuntimeRevisionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryAgentEngineRuntimeRevisionConfigDict)

Config for querying agent engine runtime revisions.

### [QueryReasoningEngineResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryReasoningEngineResponse)

The response for querying an agent engine.

### [QueryReasoningEngineResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.QueryReasoningEngineResponseDict)

The response for querying an agent engine.

### [ReasoningEngine](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngine)

An agent engine.

### [ReasoningEngineContextSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpec)

Configuration for how Agent Engine sub-resources should manage context.

### [ReasoningEngineContextSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecDict)

Configuration for how Agent Engine sub-resources should manage context.

### [ReasoningEngineContextSpecMemoryBankConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfig)

Specification for a Memory Bank.

### [ReasoningEngineContextSpecMemoryBankConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigDict)

Specification for a Memory Bank.

### [ReasoningEngineContextSpecMemoryBankConfigGenerationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigGenerationConfig)

Configuration for how to generate memories.

### [ReasoningEngineContextSpecMemoryBankConfigGenerationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigGenerationConfigDict)

Configuration for how to generate memories.

### [ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig)

Configuration for how to perform similarity search on memories.

### [ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfigDict)

Configuration for how to perform similarity search on memories.

### [ReasoningEngineContextSpecMemoryBankConfigTtlConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigTtlConfig)

Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank.

### [ReasoningEngineContextSpecMemoryBankConfigTtlConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigTtlConfigDict)

Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank.

### [ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig)

Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory.

### [ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfigDict)

Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory.

### [ReasoningEngineDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineDict)

An agent engine.

### [ReasoningEngineRuntimeRevision](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineRuntimeRevision)

A runtime revision.

### [ReasoningEngineRuntimeRevisionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineRuntimeRevisionDict)

A runtime revision.

### [ReasoningEngineSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpec)

The specification of an agent engine.

### [ReasoningEngineSpecContainerSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecContainerSpec)

Specification for deploying from a container image.

### [ReasoningEngineSpecContainerSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecContainerSpecDict)

Specification for deploying from a container image.

### [ReasoningEngineSpecDeploymentSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpec)

The specification of a Reasoning Engine deployment.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfig)

Agent Gateway configuration for a Reasoning Engine deployment.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig)

Configuration for traffic originating from a Reasoning Engine.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfigDict)

Configuration for traffic originating from a Reasoning Engine.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig)

Configuration for traffic targeting a Reasoning Engine.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfigDict)

Configuration for traffic targeting a Reasoning Engine.

### [ReasoningEngineSpecDeploymentSpecAgentGatewayConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecAgentGatewayConfigDict)

Agent Gateway configuration for a Reasoning Engine deployment.

### [ReasoningEngineSpecDeploymentSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDeploymentSpecDict)

The specification of a Reasoning Engine deployment.

### [ReasoningEngineSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecDict)

The specification of an agent engine.

### [ReasoningEngineSpecPackageSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecPackageSpec)

User-provided package specification, containing pickled object and package requirements.

### [ReasoningEngineSpecPackageSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecPackageSpecDict)

User-provided package specification, containing pickled object and package requirements.

### [ReasoningEngineSpecSourceCodeSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpec)

Specification for deploying from source code.

### [ReasoningEngineSpecSourceCodeSpecAgentConfigSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecAgentConfigSource)

Specification for the deploying from agent config.

### [ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig)

Configuration for the Agent Development Kit (ADK).

### [ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfigDict)

Configuration for the Agent Development Kit (ADK).

### [ReasoningEngineSpecSourceCodeSpecAgentConfigSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecAgentConfigSourceDict)

Specification for the deploying from agent config.

### [ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig)

Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect.

This includes the repository, revision, and directory to use.

### [ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfigDict)

Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect.

This includes the repository, revision, and directory to use.

### [ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource)

Specifies source code to be fetched from a Git repository managed through the Developer Connect service.

### [ReasoningEngineSpecSourceCodeSpecDeveloperConnectSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecDeveloperConnectSourceDict)

Specifies source code to be fetched from a Git repository managed through the Developer Connect service.

### [ReasoningEngineSpecSourceCodeSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecDict)

Specification for deploying from source code.

### [ReasoningEngineSpecSourceCodeSpecImageSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecImageSpec)

The image spec for building an image (within a single build step), based on the config file (i.e. Dockerfile) in the source directory.

### [ReasoningEngineSpecSourceCodeSpecImageSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecImageSpecDict)

The image spec for building an image (within a single build step), based on the config file (i.e. Dockerfile) in the source directory.

### [ReasoningEngineSpecSourceCodeSpecInlineSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecInlineSource)

Specifies source code provided as a byte stream.

### [ReasoningEngineSpecSourceCodeSpecInlineSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecInlineSourceDict)

Specifies source code provided as a byte stream.

### [ReasoningEngineSpecSourceCodeSpecPythonSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecPythonSpec)

Specification for running a Python application from source.

### [ReasoningEngineSpecSourceCodeSpecPythonSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineSpecSourceCodeSpecPythonSpecDict)

Specification for running a Python application from source.

### [ReasoningEngineTrafficConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfig)

Traffic distribution configuration.

### [ReasoningEngineTrafficConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigDict)

Traffic distribution configuration.

### [ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest)

Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision.

### [ReasoningEngineTrafficConfigTrafficSplitAlwaysLatestDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitAlwaysLatestDict)

Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision.

### [ReasoningEngineTrafficConfigTrafficSplitManual](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitManual)

Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each.

### [ReasoningEngineTrafficConfigTrafficSplitManualDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitManualDict)

Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each.

### [ReasoningEngineTrafficConfigTrafficSplitManualTarget](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitManualTarget)

A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it.

### [ReasoningEngineTrafficConfigTrafficSplitManualTargetDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReasoningEngineTrafficConfigTrafficSplitManualTargetDict)

A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it.

### [RedTeamingAnalysisConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RedTeamingAnalysisConfig)

Configuration for the automated Agent Red Teaming analysis.

### [RedTeamingAnalysisConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RedTeamingAnalysisConfigDict)

Configuration for the automated Agent Red Teaming analysis.

### [RedTeamingAnalysisResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RedTeamingAnalysisResult)

The top-level result for Red Teaming analysis.

### [RedTeamingAnalysisResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RedTeamingAnalysisResultDict)

The top-level result for Red Teaming analysis.

### [ReservationAffinity](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReservationAffinity)

A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity.

### [ReservationAffinityDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ReservationAffinityDict)

A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity.

### [ResponseCandidate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ResponseCandidate)

A model-generated content to the prompt.

### [ResponseCandidateDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ResponseCandidateDict)

A model-generated content to the prompt.

### [ResponseCandidateResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ResponseCandidateResult)

Aggregated metric results for a single response candidate.

### [ResponseCandidateResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ResponseCandidateResultDict)

Aggregated metric results for a single response candidate.

### [RestoreVersionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RestoreVersionConfig)

Config for restoring a prompt version.

### [RestoreVersionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RestoreVersionConfigDict)

Config for restoring a prompt version.

### [RestoreVersionOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RestoreVersionOperation)

Represents the restore version operation.

### [RestoreVersionOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RestoreVersionOperationDict)

Represents the restore version operation.

### [RetrieveAgentEngineMemoriesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveAgentEngineMemoriesConfig)

Config for retrieving memories.

### [RetrieveAgentEngineMemoriesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveAgentEngineMemoriesConfigDict)

Config for retrieving memories.

### [RetrieveMemoriesRequestSimilaritySearchParams](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesRequestSimilaritySearchParams)

The parameters for semantic similarity search based retrieval.

### [RetrieveMemoriesRequestSimilaritySearchParamsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesRequestSimilaritySearchParamsDict)

The parameters for semantic similarity search based retrieval.

### [RetrieveMemoriesRequestSimpleRetrievalParams](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesRequestSimpleRetrievalParams)

The parameters for simple (non-similarity search) retrieval.

### [RetrieveMemoriesRequestSimpleRetrievalParamsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesRequestSimpleRetrievalParamsDict)

The parameters for simple (non-similarity search) retrieval.

### [RetrieveMemoriesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesResponse)

The response for retrieving memories.

### [RetrieveMemoriesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesResponseDict)

The response for retrieving memories.

### [RetrieveMemoriesResponseRetrievedMemory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesResponseRetrievedMemory)

A retrieved memory.

### [RetrieveMemoriesResponseRetrievedMemoryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoriesResponseRetrievedMemoryDict)

A retrieved memory.

### [RetrieveMemoryProfilesConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoryProfilesConfig)

Config for retrieving memory profiles.

### [RetrieveMemoryProfilesConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveMemoryProfilesConfigDict)

Config for retrieving memory profiles.

### [RetrieveProfilesResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveProfilesResponse)

The response for retrieving memory profiles.

### [RetrieveProfilesResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveProfilesResponseDict)

The response for retrieving memory profiles.

### [RetrieveSkillsConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveSkillsConfig)

Config for retrieving skills.

### [RetrieveSkillsConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveSkillsConfigDict)

Config for retrieving skills.

### [RetrieveSkillsResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveSkillsResponse)

Response for retrieving skills.

### [RetrieveSkillsResponseDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrieveSkillsResponseDict)

Response for retrieving skills.

### [RetrievedSkill](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrievedSkill)

A retrieved skill from semantic search.

### [RetrievedSkillDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RetrievedSkillDict)

A retrieved skill from semantic search.

### [RollbackAgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RollbackAgentEngineMemoryConfig)

Config for rolling back a memory.

### [RollbackAgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RollbackAgentEngineMemoryConfigDict)

Config for rolling back a memory.

### [RougeInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeInput)

Rouge input.

### [RougeInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeInputDict)

Rouge input.

### [RougeInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeInstance)

Rouge instance.

### [RougeInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeInstanceDict)

Rouge instance.

### [RougeResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeResults)

Result of evaluating a rouge metric.

### [RougeResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RougeResultsDict)

Result of evaluating a rouge metric.

### [Rubric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Rubric)

Message representing a single testable criterion for evaluation.

One input prompt could have multiple rubrics.

### [RubricBasedMetricInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricInput)

Input for a rubric-based metrics.

### [RubricBasedMetricInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricInputDict)

Input for a rubric-based metrics.

### [RubricBasedMetricInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricInstance)

Defines an instance for Rubric-based metrics.

This class allows various input formats.

### [RubricBasedMetricInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricInstanceDict)

Defines an instance for Rubric-based metrics.

This class allows various input formats.

### [RubricBasedMetricResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricResult)

Result for a rubric-based metric.

### [RubricBasedMetricResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricResultDict)

Result for a rubric-based metric.

### [RubricBasedMetricSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricSpec)

Specification for a metric that is based on rubrics.

### [RubricBasedMetricSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricBasedMetricSpecDict)

Specification for a metric that is based on rubrics.

### [RubricContent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricContent)

Content of the rubric, defining the testable criteria.

### [RubricContentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricContentDict)

Content of the rubric, defining the testable criteria.

### [RubricContentProperty](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricContentProperty)

Defines criteria based on a specific property.

### [RubricContentPropertyDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricContentPropertyDict)

Defines criteria based on a specific property.

### [RubricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricDict)

Message representing a single testable criterion for evaluation.

One input prompt could have multiple rubrics.

### [RubricEnhancedContents](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricEnhancedContents)

Rubric-enhanced contents for evaluation.

### [RubricEnhancedContentsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricEnhancedContentsDict)

Rubric-enhanced contents for evaluation.

### [RubricGenerationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricGenerationConfig)

Config for generating rubrics.

### [RubricGenerationConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricGenerationConfigDict)

Config for generating rubrics.

### [RubricGroup](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricGroup)

A group of rubrics.

Used for grouping rubrics based on a metric or a version.

### [RubricGroupDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricGroupDict)

A group of rubrics.

Used for grouping rubrics based on a metric or a version.

### [RubricVerdict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricVerdict)

Represents the verdict of an evaluation against a single rubric.

### [RubricVerdictDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RubricVerdictDict)

Represents the verdict of an evaluation against a single rubric.

### [RunQueryJobAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RunQueryJobAgentEngineConfig)

Config for checking a query job on an agent engine.

### [RunQueryJobAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RunQueryJobAgentEngineConfigDict)

Config for checking a query job on an agent engine.

### [RunQueryJobResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RunQueryJobResult)

Result of running a query job.

### [RunQueryJobResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.RunQueryJobResultDict)

Result of running a query job.

### [SamplingConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SamplingConfig)

Sampling config for a BigQuery request set.

### [SamplingConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SamplingConfigDict)

Sampling config for a BigQuery request set.

### [SamplingMethod](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SamplingMethod)

Represents the sampling method for a BigQuery request set.

### [SandboxEnvironment](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironment)

A sandbox environment.

### [SandboxEnvironmentConnectionInfo](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentConnectionInfo)

The connection information of the SandboxEnvironment.

### [SandboxEnvironmentConnectionInfoDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentConnectionInfoDict)

The connection information of the SandboxEnvironment.

### [SandboxEnvironmentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentDict)

A sandbox environment.

### [SandboxEnvironmentSnapshot](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSnapshot)

A sandbox environment snapshot.

### [SandboxEnvironmentSnapshotDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSnapshotDict)

A sandbox environment snapshot.

### [SandboxEnvironmentSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpec)

The specification of a sandbox environment.

### [SandboxEnvironmentSpecCodeExecutionEnvironment](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpecCodeExecutionEnvironment)

The code execution environment with customized settings.

### [SandboxEnvironmentSpecCodeExecutionEnvironmentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpecCodeExecutionEnvironmentDict)

The code execution environment with customized settings.

### [SandboxEnvironmentSpecComputerUseEnvironment](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpecComputerUseEnvironment)

The computer use environment with customized settings.

### [SandboxEnvironmentSpecComputerUseEnvironmentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpecComputerUseEnvironmentDict)

The computer use environment with customized settings.

### [SandboxEnvironmentSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentSpecDict)

The specification of a sandbox environment.

### [SandboxEnvironmentTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplate)

A sandbox environment template.

### [SandboxEnvironmentTemplateCustomContainerEnvironment](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateCustomContainerEnvironment)

The customized sandbox runtime environment for BYOC.

### [SandboxEnvironmentTemplateCustomContainerEnvironmentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateCustomContainerEnvironmentDict)

The customized sandbox runtime environment for BYOC.

### [SandboxEnvironmentTemplateCustomContainerSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateCustomContainerSpec)

Specification for deploying from a custom container image.

### [SandboxEnvironmentTemplateCustomContainerSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateCustomContainerSpecDict)

Specification for deploying from a custom container image.

### [SandboxEnvironmentTemplateDefaultContainerEnvironment](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateDefaultContainerEnvironment)

The default sandbox runtime environment for default container workloads.

### [SandboxEnvironmentTemplateDefaultContainerEnvironmentDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateDefaultContainerEnvironmentDict)

The default sandbox runtime environment for default container workloads.

### [SandboxEnvironmentTemplateDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateDict)

A sandbox environment template.

### [SandboxEnvironmentTemplateEgressControlConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateEgressControlConfig)

Configuration for egress control of sandbox instances.

### [SandboxEnvironmentTemplateEgressControlConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateEgressControlConfigDict)

Configuration for egress control of sandbox instances.

### [SandboxEnvironmentTemplateNetworkPort](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateNetworkPort)

Represents a network port in a container.

### [SandboxEnvironmentTemplateNetworkPortDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateNetworkPortDict)

Represents a network port in a container.

### [SandboxEnvironmentTemplateOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateOperation)

Operation that has an agent engine sandbox as a response.

### [SandboxEnvironmentTemplateOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateOperationDict)

Operation that has an agent engine sandbox as a response.

### [SandboxEnvironmentTemplateResourceRequirements](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateResourceRequirements)

Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.

### [SandboxEnvironmentTemplateResourceRequirementsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateResourceRequirementsDict)

Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.

### [SandboxEnvironmentTemplateWarmPoolConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateWarmPoolConfig)

Configuration for a warm pool of sandbox instances.

### [SandboxEnvironmentTemplateWarmPoolConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxEnvironmentTemplateWarmPoolConfigDict)

Configuration for a warm pool of sandbox instances.

### [SandboxState](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SandboxState)

Output only. The runtime state of the SandboxEnvironment.

### [SavedQuery](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SavedQuery)

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

### [SavedQueryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SavedQueryDict)

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

### [Scheduling](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Scheduling)

All parameters related to queuing and scheduling of custom jobs.

### [SchedulingDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchedulingDict)

All parameters related to queuing and scheduling of custom jobs.

### [SchemaPredictParamsGroundingConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPredictParamsGroundingConfig)

The configuration for grounding checking.

### [SchemaPredictParamsGroundingConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPredictParamsGroundingConfigDict)

The configuration for grounding checking.

### [SchemaPredictParamsGroundingConfigSourceEntry](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPredictParamsGroundingConfigSourceEntry)

Single source entry for the grounding checking.

### [SchemaPredictParamsGroundingConfigSourceEntryDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPredictParamsGroundingConfigSourceEntryDict)

Single source entry for the grounding checking.

### [SchemaPromptApiSchema](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptApiSchema)

The A2 schema of a prompt.

### [SchemaPromptApiSchemaDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptApiSchemaDict)

The A2 schema of a prompt.

### [SchemaPromptInstancePromptExecution](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptInstancePromptExecution)

A prompt instance's parameters set that contains a set of variable values.

### [SchemaPromptInstancePromptExecutionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptInstancePromptExecutionDict)

A prompt instance's parameters set that contains a set of variable values.

### [SchemaPromptInstanceVariableValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptInstanceVariableValue)

Represents a prompt instance variable.

### [SchemaPromptInstanceVariableValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptInstanceVariableValueDict)

Represents a prompt instance variable.

### [SchemaPromptSpecAppBuilderData](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecAppBuilderData)

Defines data for an application builder.

### [SchemaPromptSpecAppBuilderDataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecAppBuilderDataDict)

Defines data for an application builder.

### [SchemaPromptSpecAppBuilderDataLinkedResource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecAppBuilderDataLinkedResource)

A linked resource attached to the application by the user.

### [SchemaPromptSpecAppBuilderDataLinkedResourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecAppBuilderDataLinkedResourceDict)

A linked resource attached to the application by the user.

### [SchemaPromptSpecMultimodalPrompt](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecMultimodalPrompt)

Prompt variation that embeds preambles to prompt string.

### [SchemaPromptSpecMultimodalPromptDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecMultimodalPromptDict)

Prompt variation that embeds preambles to prompt string.

### [SchemaPromptSpecPartList](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecPartList)

Represents a prompt spec part list.

### [SchemaPromptSpecPartListDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecPartListDict)

Represents a prompt spec part list.

### [SchemaPromptSpecPromptMessage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecPromptMessage)

Represents a prompt message.

### [SchemaPromptSpecPromptMessageDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecPromptMessageDict)

Represents a prompt message.

### [SchemaPromptSpecReferenceSentencePair](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecReferenceSentencePair)

A pair of sentences used as reference in source and target languages.

### [SchemaPromptSpecReferenceSentencePairDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecReferenceSentencePairDict)

A pair of sentences used as reference in source and target languages.

### [SchemaPromptSpecReferenceSentencePairList](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecReferenceSentencePairList)

A list of reference sentence pairs.

### [SchemaPromptSpecReferenceSentencePairListDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecReferenceSentencePairListDict)

A list of reference sentence pairs.

### [SchemaPromptSpecStructuredPrompt](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecStructuredPrompt)

Represents a structured prompt.

### [SchemaPromptSpecStructuredPromptDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecStructuredPromptDict)

Represents a structured prompt.

### [SchemaPromptSpecTranslationExample](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationExample)

The translation example that contains reference sentences from various sources.

### [SchemaPromptSpecTranslationExampleDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationExampleDict)

The translation example that contains reference sentences from various sources.

### [SchemaPromptSpecTranslationFileInputSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationFileInputSource)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [SchemaPromptSpecTranslationFileInputSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationFileInputSourceDict)

API documentation for `SchemaPromptSpecTranslationFileInputSourceDict` class.

### [SchemaPromptSpecTranslationGcsInputSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationGcsInputSource)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [SchemaPromptSpecTranslationGcsInputSourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationGcsInputSourceDict)

API documentation for `SchemaPromptSpecTranslationGcsInputSourceDict` class.

### [SchemaPromptSpecTranslationOption](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationOption)

Optional settings for translation prompt.

### [SchemaPromptSpecTranslationOptionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationOptionDict)

Optional settings for translation prompt.

### [SchemaPromptSpecTranslationPrompt](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationPrompt)

Prompt variation for Translation use case.

### [SchemaPromptSpecTranslationPromptDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationPromptDict)

Prompt variation for Translation use case.

### [SchemaPromptSpecTranslationSentenceFileInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationSentenceFileInput)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [SchemaPromptSpecTranslationSentenceFileInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaPromptSpecTranslationSentenceFileInputDict)

API documentation for `SchemaPromptSpecTranslationSentenceFileInputDict` class.

### [SchemaTablesDatasetMetadata](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadata)

Represents the metadata schema for multimodal dataset metadata.

### [SchemaTablesDatasetMetadataBigQuerySource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadataBigQuerySource)

Represents the BigQuery source for multimodal dataset metadata.

### [SchemaTablesDatasetMetadataBigQuerySourceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadataBigQuerySourceDict)

Represents the BigQuery source for multimodal dataset metadata.

### [SchemaTablesDatasetMetadataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadataDict)

Represents the metadata schema for multimodal dataset metadata.

### [SchemaTablesDatasetMetadataInputConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadataInputConfig)

Represents the input config for multimodal dataset metadata.

### [SchemaTablesDatasetMetadataInputConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTablesDatasetMetadataInputConfigDict)

Represents the input config for multimodal dataset metadata.

### [SchemaTextPromptDatasetMetadata](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTextPromptDatasetMetadata)

Represents the text prompt dataset metadata.

### [SchemaTextPromptDatasetMetadataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SchemaTextPromptDatasetMetadataDict)

Represents the text prompt dataset metadata.

### [SecretEnvVar](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SecretEnvVar)

Represents an environment variable where the value is a secret in Cloud Secret Manager.

### [SecretEnvVarDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SecretEnvVarDict)

Represents an environment variable where the value is a secret in Cloud Secret Manager.

### [SecretRef](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SecretRef)

Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.

### [SecretRefDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SecretRefDict)

Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.

### [Session](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Session)

A session.

### [SessionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SessionDict)

A session.

### [SessionEvent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SessionEvent)

A session event.

### [SessionEventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SessionEventDict)

A session event.

### [Skill](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Skill)

Represents a Skill resource.

Patches the type from the discovery document.

### [SkillDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillDict)

Represents a Skill resource.

Patches the type from the discovery document.

### [SkillOperation](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillOperation)

Operation that has a skill as a response.

### [SkillOperationDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillOperationDict)

Operation that has a skill as a response.

### [SkillRevision](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillRevision)

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`\]\[pydantic_core.ValidationError\] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

### [SkillRevisionDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillRevisionDict)

API documentation for `SkillRevisionDict` class.

### [SkillState](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SkillState)

State of the Skill.

### [State](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.State)

The new state of the task.

### [Strategy](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Strategy)

This determines which type of scheduling strategy to use.

### [StructuredMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.StructuredMemoryConfig)

Configuration for organizing structured memories within a scope.

### [StructuredMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.StructuredMemoryConfigDict)

Configuration for organizing structured memories within a scope.

### [StructuredMemorySchemaConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.StructuredMemorySchemaConfig)

Represents the OpenAPI schema of the structured memories.

### [StructuredMemorySchemaConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.StructuredMemorySchemaConfigDict)

Represents the OpenAPI schema of the structured memories.

### [SummaryMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SummaryMetric)

Represents a summary metric for an evaluation run.

### [SummaryMetricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.SummaryMetricDict)

Represents a summary metric for an evaluation run.

### [TaskArtifact](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskArtifact)

The artifact of the task event.

### [TaskArtifactChange](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskArtifactChange)

Describes changes to the artifact list.

### [TaskArtifactChangeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskArtifactChangeDict)

Describes changes to the artifact list.

### [TaskArtifactDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskArtifactDict)

The artifact of the task event.

### [TaskEvent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskEvent)

A task event.

### [TaskEventData](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskEventData)

Data for a TaskEvent.

### [TaskEventDataDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskEventDataDict)

Data for a TaskEvent.

### [TaskEventDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskEventDict)

A task event.

### [TaskMessage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskMessage)

The message of the task event.

### [TaskMessageDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskMessageDict)

The message of the task event.

### [TaskMetadataChange](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskMetadataChange)

An event representing a change to the task's top-level metadata. example: metadata_change: { new_metadata: { "name": "My task", } update_mask: { paths: "name" } }

### [TaskMetadataChangeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskMetadataChangeDict)

An event representing a change to the task's top-level metadata. example: metadata_change: { new_metadata: { "name": "My task", } update_mask: { paths: "name" } }

### [TaskOutput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskOutput)

The output of the task event.

### [TaskOutputChange](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskOutputChange)

An event representing a change to the task's outputs.

### [TaskOutputChangeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskOutputChangeDict)

An event representing a change to the task's outputs.

### [TaskOutputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskOutputDict)

The output of the task event.

### [TaskStateChange](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStateChange)

A message representing a change in a task's state.

### [TaskStateChangeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStateChangeDict)

A message representing a change in a task's state.

### [TaskStatusDetails](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStatusDetails)

The status details of the task event.

### [TaskStatusDetailsChange](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStatusDetailsChange)

Represents a change to the task's status details.

### [TaskStatusDetailsChangeDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStatusDetailsChangeDict)

Represents a change to the task's status details.

### [TaskStatusDetailsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TaskStatusDetailsDict)

The status details of the task event.

### [ToolCallValidInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidInput)

Tool call valid input.

### [ToolCallValidInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidInputDict)

Tool call valid input.

### [ToolCallValidInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidInstance)

Tool call valid instance.

### [ToolCallValidInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidInstanceDict)

Tool call valid instance.

### [ToolCallValidMetricValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidMetricValue)

Tool call valid metric value for an instance.

### [ToolCallValidMetricValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidMetricValueDict)

Tool call valid metric value for an instance.

### [ToolCallValidResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidResults)

Results for tool call valid metric.

### [ToolCallValidResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidResultsDict)

Results for tool call valid metric.

### [ToolCallValidSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidSpec)

Spec for tool call valid metric.

### [ToolCallValidSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolCallValidSpecDict)

Spec for tool call valid metric.

### [ToolNameMatchInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchInput)

Tool name match input.

### [ToolNameMatchInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchInputDict)

Tool name match input.

### [ToolNameMatchInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchInstance)

Tool name match instance.

### [ToolNameMatchInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchInstanceDict)

Tool name match instance.

### [ToolNameMatchMetricValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchMetricValue)

Tool name match metric value for an instance.

### [ToolNameMatchMetricValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchMetricValueDict)

Tool name match metric value for an instance.

### [ToolNameMatchResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchResults)

Results for tool name match metric.

### [ToolNameMatchResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchResultsDict)

Results for tool name match metric.

### [ToolNameMatchSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchSpec)

Spec for tool name match metric.

### [ToolNameMatchSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolNameMatchSpecDict)

Spec for tool name match metric.

### [ToolParameterKVMatchInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchInput)

Tool parameter kv match input.

### [ToolParameterKVMatchInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchInputDict)

Tool parameter kv match input.

### [ToolParameterKVMatchInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchInstance)

Tool parameter kv match instance.

### [ToolParameterKVMatchInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchInstanceDict)

Tool parameter kv match instance.

### [ToolParameterKVMatchMetricValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchMetricValue)

Tool parameter key value match metric value for an instance.

### [ToolParameterKVMatchMetricValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchMetricValueDict)

Tool parameter key value match metric value for an instance.

### [ToolParameterKVMatchResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchResults)

Results for tool parameter key value match metric.

### [ToolParameterKVMatchResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchResultsDict)

Results for tool parameter key value match metric.

### [ToolParameterKVMatchSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchSpec)

Spec for tool parameter kv match metric.

### [ToolParameterKVMatchSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKVMatchSpecDict)

Spec for tool parameter kv match metric.

### [ToolParameterKeyMatchInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchInput)

Tool parameter key match input.

### [ToolParameterKeyMatchInputDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchInputDict)

Tool parameter key match input.

### [ToolParameterKeyMatchInstance](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchInstance)

Tool parameter key match instance.

### [ToolParameterKeyMatchInstanceDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchInstanceDict)

Tool parameter key match instance.

### [ToolParameterKeyMatchMetricValue](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchMetricValue)

Tool parameter key match metric value for an instance.

### [ToolParameterKeyMatchMetricValueDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchMetricValueDict)

Tool parameter key match metric value for an instance.

### [ToolParameterKeyMatchResults](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchResults)

Results for tool parameter key match metric.

### [ToolParameterKeyMatchResultsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchResultsDict)

Results for tool parameter key match metric.

### [ToolParameterKeyMatchSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchSpec)

Spec for tool parameter key match metric.

### [ToolParameterKeyMatchSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.ToolParameterKeyMatchSpecDict)

Spec for tool parameter key match metric.

### [TuningResourceUsageAssessmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningResourceUsageAssessmentConfig)

Config for tuning resource usage assessment.

### [TuningResourceUsageAssessmentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningResourceUsageAssessmentConfigDict)

Config for tuning resource usage assessment.

### [TuningResourceUsageAssessmentResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningResourceUsageAssessmentResult)

Result of tuning resource usage assessment.

### [TuningResourceUsageAssessmentResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningResourceUsageAssessmentResultDict)

Result of tuning resource usage assessment.

### [TuningValidationAssessmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningValidationAssessmentConfig)

Config for tuning validation assessment.

### [TuningValidationAssessmentConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningValidationAssessmentConfigDict)

Config for tuning validation assessment.

### [TuningValidationAssessmentResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningValidationAssessmentResult)

The result of a tuning validation assessment.

### [TuningValidationAssessmentResultDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.TuningValidationAssessmentResultDict)

The result of a tuning validation assessment.

### [Type](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.Type)

Specifies the reservation affinity type.

### [UnifiedMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UnifiedMetric)

The unified metric used for evaluation.

### [UnifiedMetricDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UnifiedMetricDict)

The unified metric used for evaluation.

### [UpdateAgentEngineConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineConfig)

Config for updating agent engine.

### [UpdateAgentEngineConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineConfigDict)

Config for updating agent engine.

### [UpdateAgentEngineMemoryConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineMemoryConfig)

Config for updating agent engine memory.

### [UpdateAgentEngineMemoryConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineMemoryConfigDict)

Config for updating agent engine memory.

### [UpdateAgentEngineSessionConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineSessionConfig)

Config for updating agent engine session.

### [UpdateAgentEngineSessionConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateAgentEngineSessionConfigDict)

Config for updating agent engine session.

### [UpdatePromptConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdatePromptConfig)

Config for creating a dataset resource to store prompts.

### [UpdatePromptConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdatePromptConfigDict)

Config for creating a dataset resource to store prompts.

### [UpdateSkillConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateSkillConfig)

Config for updating a skill.

### [UpdateSkillConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.UpdateSkillConfigDict)

Config for updating a skill.

### [VertexBaseConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.VertexBaseConfig)

Base config for Vertex AI.

### [VertexBaseConfigDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.VertexBaseConfigDict)

Base config for Vertex AI.

### [VulnerableTool](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.VulnerableTool)

A tool considered high risk for prompt injection.

### [VulnerableToolDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.VulnerableToolDict)

A tool considered high risk for prompt injection.

### [WinRateStats](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.WinRateStats)

Statistics for win rates for a single metric.

### [WinRateStatsDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.WinRateStatsDict)

Statistics for win rates for a single metric.

### [WorkerPoolSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.WorkerPoolSpec)

Represents the spec of a worker pool in a job.

### [WorkerPoolSpecDict](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.types.WorkerPoolSpecDict)

Represents the spec of a worker pool in a job.

### [AG2Agent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.AG2Agent)

An AG2 Agent.

### [AdkApp](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.AdkApp)

An ADK Application.

### [AgentEngine](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.AgentEngine)

Represents a Vertex AI Agent Engine resource.

### [AsyncQueryable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.AsyncQueryable)

Protocol for Agent Engines that can be queried asynchronously.

### [AsyncStreamQueryable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.AsyncStreamQueryable)

Protocol for Agent Engines that can stream responses asynchronously.

### [Cloneable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.Cloneable)

Protocol for Agent Engines that can be cloned.

### [LangchainAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.LangchainAgent)

A Langchain Agent.

See <https://cloud.google.com/vertex-ai/generative-ai/docs/reasoning-engine/develop>
for details.

### [LanggraphAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.LanggraphAgent)

A LangGraph Agent.

### [ModuleAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.ModuleAgent)

Agent that is defined by a module and an agent name.

This agent is instantiated by importing a module and instantiating an agent
from that module. It also allows to register operations that are defined in
the agent.

### [OperationRegistrable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.OperationRegistrable)

Protocol for agents that have registered operations.

### [Queryable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.Queryable)

Protocol for Agent Engines that can be queried.

### [StreamQueryable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.agent_engines.StreamQueryable)

Protocol for Agent Engines that can stream responses.

### [CustomMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.CustomMetric)

The custom evaluation metric.

A fully-customized CustomMetric that can be used to evaluate a single model
by defining a metric function for a computation-based metric. The
CustomMetric is computed on the client-side using the user-defined metric
function in SDK only, not by the Vertex Gen AI Evaluation Service.

Attributes:
name: The name of the metric.
metric_function: The user-defined evaluation function to compute a metric
score. Must use the dataset row dictionary as the metric function
input and return per-instance metric result as a dictionary output.
The metric score must mapped to the name of the CustomMetric as key.

### [EvalResult](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.EvalResult)

Evaluation result.

### [EvalTask](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.EvalTask)

A class representing an EvalTask.

An evaluation task assesses the ability of a Gen AI model, agent or
application to perform a specific task in response to prompts.
Each evaluation task includes an evaluation dataset, which can be a set of
test cases and a set of metrics for assessment. These tasks provide the
framework for running evaluations in a standardized and repeatable way,
allowing for comparative assessment with varying run-specific parameters.

Dataset Details:

    Default dataset column names:
        * prompt_column_name: "prompt"
        * reference_column_name: "reference"
        * response_column_name: "response"
        * baseline_model_response_column_name: "baseline_model_response"
        * rubrics_column_name: "rubrics"


    Requirement for different use cases:
      * Bring-your-own-response (BYOR): You already have the data that you
          want to evaluate stored in the dataset. Response column name can be
          customized by providing `response_column_name` parameter, or in the
          `metric_column_mapping`. For BYOR pairwise evaluation, the baseline
          model response column name can be customized by providing
          `baseline_model_response_column_name` parameter, or
          in the `metric_column_mapping`. If the `response` column or
          `baseline_model_response` column is present while the
          corresponding model is specified, an error will be raised.

      * Perform model/agent inference without a prompt template: You have a dataset
          containing the input prompts to the model/agent and want to perform
          inference before evaluation. A column named `prompt` is required
          in the evaluation dataset and is used directly as input to the model/agent.

      * Perform model/agent inference with a prompt template: You have a dataset
          containing the input variables to the prompt template and want to
          assemble the prompts for inference. Evaluation dataset
          must contain column names corresponding to the variable names in
          the prompt template. For example, if prompt template is
          "Instruction: {instruction}, context: {context}", the dataset must
          contain `instruction` and `context` columns.

Metrics Details:

    The supported metrics descriptions, rating rubrics, and the required
    input variables can be found on the Vertex AI public documentation page.
    [Evaluation methods and metrics](https://cloud.google.com/vertex-ai/generative-ai/docs/models/determine-eval).

Usage Examples:

    1. To perform bring-your-own-response(BYOR) evaluation, provide the model
    responses in the `response` column in the dataset. If a pairwise metric is
    used for BYOR evaluation, provide the baseline model responses in the
    `baseline_model_response` column.

      ```
      eval_dataset = pd.DataFrame({
              "prompt"  : [...],
              "reference": [...],
              "response" : [...],
              "baseline_model_response": [...],
      })
      eval_task = EvalTask(
        dataset=eval_dataset,
        metrics=[
                "bleu",
                "rouge_l_sum",
                MetricPromptTemplateExamples.Pointwise.FLUENCY,
                MetricPromptTemplateExamples.Pairwise.SAFETY
        ],
        experiment="my-experiment",
      )
      eval_result = eval_task.evaluate(experiment_run_name="eval-experiment-run")
      ```

    2. To perform evaluation with Gemini model inference, specify the `model`
    parameter with a model name string. The input column name to the
    model is `prompt` and must be present in the dataset.

      ```
      eval_dataset = pd.DataFrame({
            "reference": [...],
            "prompt"  : [...],
      })
      result = EvalTask(
          dataset=eval_dataset,
          metrics=["exact_match", "bleu", "rouge_1", "rouge_l_sum"],
          experiment="my-experiment",
      ).evaluate(
          model="gemini-2.5-flash",
          experiment_run_name="gemini-eval-run"
      )
      ```

    3. If a `prompt_template` is specified, the `prompt` column is not required.
    Prompts can be assembled from the evaluation dataset, and all prompt
    template variable names must be present in the dataset columns.
      ```
      eval_dataset = pd.DataFrame({
          "context"    : [...],
          "instruction": [...],
      })
      result = EvalTask(
          dataset=eval_dataset,
          metrics=[MetricPromptTemplateExamples.Pointwise.SUMMARIZATION_QUALITY],
      ).evaluate(
          model="gemini-2.5-flash",
          prompt_template="{instruction}. Article: {context}. Summary:",
      )
      ```

    4. To perform evaluation with custom model inference, specify the `model`
    parameter with a custom inference function. The input column name to the
    custom inference function is `prompt` and must be present in the dataset.

      ```
      from openai import OpenAI
      client = OpenAI()
      def custom_model_fn(input: str) -> str:
        response = client.chat.completions.create(
          model="gpt-3.5-turbo",
          messages=[
            {"role": "user", "content": input}
          ]
        )
        return response.choices[0].message.content

      eval_dataset = pd.DataFrame({
            "prompt"  : [...],
            "reference": [...],
      })
      result = EvalTask(
          dataset=eval_dataset,
          metrics=[MetricPromptTemplateExamples.Pointwise.SAFETY],
          experiment="my-experiment",
      ).evaluate(
          model=custom_model_fn,
          experiment_run_name="gpt-eval-run"
      )
      ```

    5. To perform pairwise metric evaluation with model inference step, specify
    the `baseline_model` input to a `PairwiseMetric` instance and the candidate
    `model` input to the `EvalTask.evaluate()` function. The input column name
    to both models is `prompt` and must be present in the dataset.

      ```
      baseline_model = "gemini-2.5-pro"
      candidate_model = "gemini-2.5-flash"

      pairwise_groundedness = PairwiseMetric(
          metric_prompt_template=MetricPromptTemplateExamples.get_prompt_template(
              "pairwise_groundedness"
          ),
          baseline_model=baseline_model,
      )
      eval_dataset = pd.DataFrame({
            "prompt"  : [...],
      })
      result = EvalTask(
          dataset=eval_dataset,
          metrics=[pairwise_groundedness],
          experiment="my-pairwise-experiment",
      ).evaluate(
          model=candidate_model,
          experiment_run_name="gemini-pairwise-eval-run",
      )
      ```

### [MetricPromptTemplateExamples](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.MetricPromptTemplateExamples)

Examples of metric prompt templates for model-based evaluation.

### [Pairwise](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.MetricPromptTemplateExamples.Pairwise)

Example PairwiseMetric instances.

### [Pointwise](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.MetricPromptTemplateExamples.Pointwise)

Example PointwiseMetric instances.

### [PairwiseMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.PairwiseMetric)

A Model-based Pairwise Metric.

A model-based evaluation metric that compares two generative models' responses
side-by-side, and allows users to A/B test their generative models to
determine which model is performing better.

For more details on when to use pairwise metrics, see
[Evaluation methods and
metrics](https://cloud.google.com/vertex-ai/generative-ai/docs/models/determine-eval#pointwise_versus_pairwise).

Result Details:

    * In `EvalResult.summary_metrics`, win rates for both the baseline and
    candidate model are computed. The win rate is computed as proportion of
    wins of one model's responses to total attempts as a decimal value
    between 0 and 1.

    * In `EvalResult.metrics_table`, a pairwise metric produces two
    evaluation results per dataset row:
        * `pairwise_choice`: The choice shows whether the candidate model or
          the baseline model performs better, or if they are equally good.
        * `explanation`: The rationale behind each verdict using
          chain-of-thought reasoning. The explanation helps users scrutinize
          the judgment and builds appropriate trust in the decisions.

    See [documentation
    page](https://cloud.google.com/vertex-ai/generative-ai/docs/models/determine-eval#understand-results)
    for more details on understanding the metric results.

Usage Examples:

    ```
    baseline_model = "gemini-2.5-pro"
    candidate_model = "gemini-2.5-flash"

    pairwise_groundedness = PairwiseMetric(
        metric_prompt_template=MetricPromptTemplateExamples.get_prompt_template(
            "pairwise_groundedness"
        ),
        baseline_model=baseline_model,
    )
    eval_dataset = pd.DataFrame({
          "prompt"  : [...],
    })
    pairwise_task = EvalTask(
        dataset=eval_dataset,
        metrics=[pairwise_groundedness],
        experiment="my-pairwise-experiment",
    )
    pairwise_result = pairwise_task.evaluate(
        model=candidate_model,
        experiment_run_name="gemini-pairwise-eval-run",
    )
    ```

### [PairwiseMetricPromptTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.PairwiseMetricPromptTemplate)

Pairwise metric prompt template for pairwise model-based metrics.

### [PointwiseMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.PointwiseMetric)

A Model-based Pointwise Metric.

A model-based evaluation metric that evaluate a single generative model's
response.

For more details on when to use model-based pointwise metrics, see
[Evaluation methods and metrics](https://cloud.google.com/vertex-ai/generative-ai/docs/models/determine-eval).

Usage Examples:

    ```
    candidate_model = "gemini-2.5-pro"
    eval_dataset = pd.DataFrame({
        "prompt"  : [...],
    })
    fluency_metric = PointwiseMetric(
        metric="fluency",
        metric_prompt_template=MetricPromptTemplateExamples.get_prompt_template('fluency'),
    )
    pointwise_eval_task = EvalTask(
        dataset=eval_dataset,
        metrics=[
            fluency_metric,
            MetricPromptTemplateExamples.Pointwise.GROUNDEDNESS,
        ],
    )
    pointwise_result = pointwise_eval_task.evaluate(
        model=candidate_model,
    )
    ```

### [PointwiseMetricPromptTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.PointwiseMetricPromptTemplate)

Pointwise metric prompt template for pointwise model-based metrics.

### [PromptTemplate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.PromptTemplate)

A prompt template for creating prompts with variables.

The `PromptTemplate` class allows users to define a template string with
variables represented in curly braces `{variable}`. The variable
names cannot contain spaces and must start with a letter or underscore,
followed by letters, digits, or underscore. These variables can be
replaced with specific values using the `assemble` method, providing
flexibility in generating dynamic prompts.

Usage:

    ```
    template_str = "Hello, {name}! Today is {day}. How are you?"
    prompt_template = PromptTemplate(template_str)
    completed_prompt = prompt_template.assemble(name="John", day="Monday")
    print(completed_prompt)
    ```

### [Rouge](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.evaluation.Rouge)

The ROUGE Metric.

Calculates the recall of n-grams in prediction as compared to reference and
returns a score ranging between 0 and 1. Supported rouge types are
rougen\[1-9\], rougeL, and rougeLsum.

### [Candidate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.Candidate)

A response candidate generated by the model.

### [ChatSession](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.ChatSession)

Chat session holds the chat history.

### [Content](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.Content)

The multi-part content of a message.

Usage:

    ```
    response = model.generate_content(contents=[
        Content(role="user", parts=[Part.from_text("Why is sky blue?")])
    ])
    ```

### [FinishReason](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.FinishReason)

The reason why the model stopped generating tokens.
If empty, the model has not stopped generating the tokens.

### [FunctionCall](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.FunctionCall)

Function call.

### [FunctionDeclaration](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.FunctionDeclaration)

A representation of a function declaration.

Usage:
Create function declaration and tool:

    ```
    get_current_weather_func = generative_models.FunctionDeclaration(
        name="get_current_weather",
        description="Get the current weather in a given location",
        parameters={
            "type": "object",
            "properties": {
                "location": {
                    "type": "string",
                    "description": "The city and state, e.g. San Francisco, CA"
                },
                "unit": {
                    "type": "string",
                    "enum": [
                        "celsius",
                        "fahrenheit",
                    ]
                }
            },
            "required": [
                "location"
            ]
        },
        # Optional:
        response={
            "type": "object",
            "properties": {
                "weather": {
                    "type": "string",
                    "description": "The weather in the city"
                },
            },
        },
    )
    weather_tool = generative_models.Tool(
        function_declarations=[get_current_weather_func],
    )
    ```

    Use tool in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    ))
    ```

    Use tool in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [GenerationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig)

Parameters for the generation.

### [Modality](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.Modality)

The modalities of the response.

### [ModelConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.ModelConfig)

Config for model selection.

### [FeatureSelectionPreference](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.ModelConfig.FeatureSelectionPreference)

Options for feature selection preference.

### [RoutingConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.RoutingConfig)

The configuration for model router requests.
Deprecated, please use ModelConfig to set routing preference instead.

The routing config is either one of the two nested classes:

- AutoRoutingMode: Automated routing.
- ManualRoutingMode: Manual routing.

Usage:

- AutoRoutingMode:

      routing_config=generative_models.RoutingConfig(
          routing_config=generative_models.RoutingConfig.AutoRoutingMode(
              model_routing_preference=generative_models.RoutingConfig.AutoRoutingMode.ModelRoutingPreference.BALANCED,
          ),
      )

- ManualRoutingMode:

      routing_config=generative_models.RoutingConfig(
          routing_config=generative_models.RoutingConfig.ManutalRoutingMode(
              model_name="gemini-1.5-pro-001",
          ),
      )

### [AutoRoutingMode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.RoutingConfig.AutoRoutingMode)

When automated routing is specified, the routing will be
determined by the routing model predicted quality and customer provided
model routing preference.

### [ModelRoutingPreference](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.RoutingConfig.AutoRoutingMode.ModelRoutingPreference)

The model routing preference.

### [ManualRoutingMode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationConfig.RoutingConfig.ManualRoutingMode)

When manual routing is set, the specified model will be used
directly.

### [GenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerationResponse)

The response from the model.

### [GenerativeModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.GenerativeModel)

Initializes GenerativeModel.

Usage:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content("Hello"))
    ```

### [HarmBlockThreshold](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.HarmBlockThreshold)

Probability based thresholds levels for blocking.

### [HarmCategory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.HarmCategory)

Harm categories that will block the content.

### [Image](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.Image)

The image that can be sent to a generative model.

### [Part](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.Part)

A part of a multi-part Content message.

Usage:

    ```
    text_part = Part.from_text("Why is sky blue?")
    image_part = Part.from_image(Image.load_from_file("image.jpg"))
    video_part = Part.from_uri(uri="gs://.../video.mp4", mime_type="video/mp4")
    function_response_part = Part.from_function_response(
        name="get_current_weather",
        response={
            "content": {"weather_there": "super nice"},
        }
    )

    response1 = model.generate_content([text_part, image_part])
    response2 = model.generate_content(video_part)
    response3 = chat.send_message(function_response_part)
    ```

### [ResponseValidationError](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.ResponseValidationError)

API documentation for `ResponseValidationError` class.

### [SafetySetting](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.SafetySetting)

Parameters for the generation.

### [HarmBlockMethod](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.SafetySetting.HarmBlockMethod)

Probability vs severity.

### [HarmBlockThreshold](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.SafetySetting.HarmBlockThreshold)

Probability based thresholds levels for blocking.

### [HarmCategory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.SafetySetting.HarmCategory)

Harm categories that will block the content.

### [Tool](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.Tool)

A collection of functions that the model may use to generate response.

Usage:
Create tool from function declarations:

    ```
    get_current_weather_func = generative_models.FunctionDeclaration(...)
    weather_tool = generative_models.Tool(
        function_declarations=[get_current_weather_func],
    )
    ```

    Use tool in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    ))
    ```

    Use tool in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [ToolConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.ToolConfig)

Config shared for all tools provided in the request.

Usage:
Create ToolConfig

    ```
    tool_config = ToolConfig(
        function_calling_config=ToolConfig.FunctionCallingConfig(
            mode=ToolConfig.FunctionCallingConfig.Mode.ANY,
            allowed_function_names=["get_current_weather_func"],
    ))
    ```

    Use ToolConfig in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
        tool_config=tool_config,
    ))
    ```

    Use ToolConfig in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
        tool_config=tool_config,
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [grounding](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding)

Grounding namespace.

### [DynamicRetrievalConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding.DynamicRetrievalConfig)

Config for dynamic retrieval.

### [Mode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding.DynamicRetrievalConfig.Mode)

The mode of the predictor to be used in dynamic retrieval.

### [GoogleSearchRetrieval](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding.GoogleSearchRetrieval)

Tool to retrieve public web data for grounding, powered by
Google Search.

### [Retrieval](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding.Retrieval)

Defines a retrieval tool that model can call to access external knowledge.

### [VertexAISearch](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.generative_models.grounding.VertexAISearch)

Retrieve from Vertex AI Search data store for grounding.
See <https://cloud.google.com/products/agent-builder>

### [ChatMessage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.ChatMessage)

A chat message.

### [ChatModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.ChatModel)

ChatModel represents a language model that is capable of chat.

Examples::

    chat_model = ChatModel.from_pretrained("chat-bison@001")

    chat = chat_model.start_chat(
        context="My name is Ned. You are my personal assistant. My favorite movies are Lord of the Rings and Hobbit.",
        examples=[
            InputOutputTextPair(
                input_text="Who do you work for?",
                output_text="I work for Ned.",
            ),
            InputOutputTextPair(
                input_text="What do I like?",
                output_text="Ned likes watching movies.",
            ),
        ],
        temperature=0.3,
    )

    chat.send_message("Do you know any cool events this weekend?")

### [ChatSession](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.ChatSession)

ChatSession represents a chat session with a language model.

Within a chat session, the model keeps context and remembers the previous conversation.

### [CodeChatModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.CodeChatModel)

CodeChatModel represents a model that is capable of completing code.

.. rubric:: Examples

code_chat_model = CodeChatModel.from_pretrained("codechat-bison@001")

code_chat = code_chat_model.start_chat(
context="I'm writing a large-scale enterprise application.",
max_output_tokens=128,
temperature=0.2,
)

code_chat.send_message("Please help write a function to calculate the min of two numbers")

### [CodeChatSession](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.CodeChatSession)

CodeChatSession represents a chat session with code chat language model.

Within a code chat session, the model keeps context and remembers the previous converstion.

### [CodeGenerationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.CodeGenerationModel)

Creates a LanguageModel.

This constructor should not be called directly.
Use `LanguageModel.from_pretrained(model_name=...)` instead.

### [GroundingSource](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.GroundingSource)

API documentation for `GroundingSource` class.

### [InlineContext](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.GroundingSource.InlineContext)

InlineContext represents a grounding source using provided inline context.
.. attribute:: inline_context

The content used as inline context.

:type: str

### [VertexAISearch](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.GroundingSource.VertexAISearch)

VertexAISearchDatastore represents a grounding source using Vertex AI Search datastore
.. attribute:: data_store_id

Data store ID of the Vertex AI Search datastore.

:type: str

### [WebSearch](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.GroundingSource.WebSearch)

WebSearch represents a grounding source using public web search.
.. attribute:: disable_attribution

If set to `True`, skip finding claim attributions (i.e not generate grounding citation). Default: False.

:type: bool

### [InputOutputTextPair](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.InputOutputTextPair)

InputOutputTextPair represents a pair of input and output texts.

### [TextEmbedding](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.TextEmbedding)

Text embedding vector and statistics.

### [TextEmbeddingInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.TextEmbeddingInput)

Structural text embedding input.

### [TextEmbeddingModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.TextEmbeddingModel)

Creates a LanguageModel.

This constructor should not be called directly.
Use `LanguageModel.from_pretrained(model_name=...)` instead.

### [TextGenerationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.TextGenerationModel)

Creates a LanguageModel.

This constructor should not be called directly.
Use `LanguageModel.from_pretrained(model_name=...)` instead.

### [TextGenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models.TextGenerationResponse)

TextGenerationResponse represents a response of a language model.
.. attribute:: text

The generated text

:type: str

### [_TunableModelMixin](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models._language_models._TunableModelMixin)

Model that can be tuned with supervised fine tuning (SFT).

### [AutomaticFunctionCallingResponder](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.AutomaticFunctionCallingResponder)

Responder that automatically responds to model's function calls.

### [CallableFunctionDeclaration](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.CallableFunctionDeclaration)

A function declaration plus a function.

### [Candidate](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.Candidate)

A response candidate generated by the model.

### [ChatSession](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.ChatSession)

Chat session holds the chat history.

### [Content](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.Content)

The multi-part content of a message.

Usage:

    ```
    response = model.generate_content(contents=[
        Content(role="user", parts=[Part.from_text("Why is sky blue?")])
    ])
    ```

### [FinishReason](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.FinishReason)

The reason why the model stopped generating tokens.
If empty, the model has not stopped generating the tokens.

### [FunctionCall](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.FunctionCall)

Function call.

### [FunctionDeclaration](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.FunctionDeclaration)

A representation of a function declaration.

Usage:
Create function declaration and tool:

    ```
    get_current_weather_func = generative_models.FunctionDeclaration(
        name="get_current_weather",
        description="Get the current weather in a given location",
        parameters={
            "type": "object",
            "properties": {
                "location": {
                    "type": "string",
                    "description": "The city and state, e.g. San Francisco, CA"
                },
                "unit": {
                    "type": "string",
                    "enum": [
                        "celsius",
                        "fahrenheit",
                    ]
                }
            },
            "required": [
                "location"
            ]
        },
        # Optional:
        response={
            "type": "object",
            "properties": {
                "weather": {
                    "type": "string",
                    "description": "The weather in the city"
                },
            },
        },
    )
    weather_tool = generative_models.Tool(
        function_declarations=[get_current_weather_func],
    )
    ```

    Use tool in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    ))
    ```

    Use tool in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [GenerationConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig)

Parameters for the generation.

### [Modality](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.Modality)

The modalities of the response.

### [ModelConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.ModelConfig)

Config for model selection.

### [FeatureSelectionPreference](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.ModelConfig.FeatureSelectionPreference)

Options for feature selection preference.

### [RoutingConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.RoutingConfig)

The configuration for model router requests.
Deprecated, please use ModelConfig to set routing preference instead.

The routing config is either one of the two nested classes:

- AutoRoutingMode: Automated routing.
- ManualRoutingMode: Manual routing.

Usage:

- AutoRoutingMode:

      routing_config=generative_models.RoutingConfig(
          routing_config=generative_models.RoutingConfig.AutoRoutingMode(
              model_routing_preference=generative_models.RoutingConfig.AutoRoutingMode.ModelRoutingPreference.BALANCED,
          ),
      )

- ManualRoutingMode:

      routing_config=generative_models.RoutingConfig(
          routing_config=generative_models.RoutingConfig.ManutalRoutingMode(
              model_name="gemini-1.5-pro-001",
          ),
      )

### [AutoRoutingMode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.RoutingConfig.AutoRoutingMode)

When automated routing is specified, the routing will be
determined by the routing model predicted quality and customer provided
model routing preference.

### [ModelRoutingPreference](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.RoutingConfig.AutoRoutingMode.ModelRoutingPreference)

The model routing preference.

### [ManualRoutingMode](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationConfig.RoutingConfig.ManualRoutingMode)

When manual routing is set, the specified model will be used
directly.

### [GenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerationResponse)

The response from the model.

### [GenerativeModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.GenerativeModel)

Initializes GenerativeModel.

Usage:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content("Hello"))
    ```

### [HarmBlockThreshold](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.HarmBlockThreshold)

Probability based thresholds levels for blocking.

### [HarmCategory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.HarmCategory)

Harm categories that will block the content.

### [Image](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.Image)

The image that can be sent to a generative model.

### [Part](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.Part)

A part of a multi-part Content message.

Usage:

    ```
    text_part = Part.from_text("Why is sky blue?")
    image_part = Part.from_image(Image.load_from_file("image.jpg"))
    video_part = Part.from_uri(uri="gs://.../video.mp4", mime_type="video/mp4")
    function_response_part = Part.from_function_response(
        name="get_current_weather",
        response={
            "content": {"weather_there": "super nice"},
        }
    )

    response1 = model.generate_content([text_part, image_part])
    response2 = model.generate_content(video_part)
    response3 = chat.send_message(function_response_part)
    ```

### [ResponseBlockedError](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.ResponseBlockedError)

API documentation for `ResponseBlockedError` class.

### [ResponseValidationError](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.ResponseValidationError)

API documentation for `ResponseValidationError` class.

### [SafetySetting](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.SafetySetting)

Parameters for the generation.

### [HarmBlockMethod](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.SafetySetting.HarmBlockMethod)

Probability vs severity.

### [HarmBlockThreshold](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.SafetySetting.HarmBlockThreshold)

Probability based thresholds levels for blocking.

### [HarmCategory](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.SafetySetting.HarmCategory)

Harm categories that will block the content.

### [Tool](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.Tool)

A collection of functions that the model may use to generate response.

Usage:
Create tool from function declarations:

    ```
    get_current_weather_func = generative_models.FunctionDeclaration(...)
    weather_tool = generative_models.Tool(
        function_declarations=[get_current_weather_func],
    )
    ```

    Use tool in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    ))
    ```

    Use tool in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [ToolConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models.ToolConfig)

Config shared for all tools provided in the request.

Usage:
Create ToolConfig

    ```
    tool_config = ToolConfig(
        function_calling_config=ToolConfig.FunctionCallingConfig(
            mode=ToolConfig.FunctionCallingConfig.Mode.ANY,
            allowed_function_names=["get_current_weather_func"],
    ))
    ```

    Use ToolConfig in `GenerativeModel.generate_content`:

    ```
    model = GenerativeModel("gemini-pro")
    print(model.generate_content(
        "What is the weather like in Boston?",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
        tool_config=tool_config,
    ))
    ```

    Use ToolConfig in chat:

    ```
    model = GenerativeModel(
        "gemini-pro",
        # You can specify tools when creating a model to avoid having to send them with every request.
        tools=[weather_tool],
        tool_config=tool_config,
    )
    chat = model.start_chat()
    print(chat.send_message("What is the weather like in Boston?"))
    print(chat.send_message(
        Part.from_function_response(
            name="get_current_weather",
            response={
                "content": {"weather_there": "super nice"},
            }
        ),
    ))
    ```

### [ChatMessage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.ChatMessage)

A chat message.

### [CountTokensResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.CountTokensResponse)

The response from a count_tokens request.
.. attribute:: total_tokens

The total number of tokens counted across all
instances passed to the request.

:type: int

### [EvaluationClassificationMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationClassificationMetric)

The evaluation metric response for classification metrics.

### [EvaluationMetric](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationMetric)

The evaluation metric response.

### [EvaluationQuestionAnsweringSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationQuestionAnsweringSpec)

Spec for question answering model evaluation tasks.

### [EvaluationTextClassificationSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationTextClassificationSpec)

Spec for text classification model evaluation tasks.

### [EvaluationTextGenerationSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationTextGenerationSpec)

Spec for text generation model evaluation tasks.

### [EvaluationTextSummarizationSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.EvaluationTextSummarizationSpec)

Spec for text summarization model evaluation tasks.

### [InputOutputTextPair](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.InputOutputTextPair)

InputOutputTextPair represents a pair of input and output texts.

### [TextEmbedding](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.TextEmbedding)

Text embedding vector and statistics.

### [TextEmbeddingInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.TextEmbeddingInput)

Structural text embedding input.

### [TextGenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.TextGenerationResponse)

TextGenerationResponse represents a response of a language model.
.. attribute:: text

The generated text

:type: str

### [TuningEvaluationSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models.TuningEvaluationSpec)

Specification for model evaluation to perform during tuning.

### [A2aAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.A2aAgent)

A class to initialize and set up an Agent-to-Agent application.

### [AG2Agent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.AG2Agent)

An AG2 Agent.

See <https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/develop/ag2>
for details.

### [AdkApp](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.AdkApp)

An ADK Application.

### [LangchainAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.LangchainAgent)

A Langchain Agent.

See <https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/develop/langchain>
for details.

### [LanggraphAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.LanggraphAgent)

A LangGraph Agent.

See <https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/develop/langgraph>
for details.

### [LlamaIndexQueryPipelineAgent](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.LlamaIndexQueryPipelineAgent)

A LlamaIndex Query Pipeline Agent.

This agent uses a query pipeline for LLAIndex, including prompt, model,
retrieval and summarization steps. More details can be found in
<https://docs.llamaindex.ai/en/stable/module_guides/querying/pipeline/>.

### [Queryable](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.Queryable)

Protocol for Reasoning Engine applications that can be queried.

### [ReasoningEngine](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.reasoning_engines.ReasoningEngine)

Represents a Vertex AI Reasoning Engine resource.

### [SourceModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.tuning.SourceModel)

A model that is used in managed OSS supervised tuning.

Usage:

    model = SourceModel(
        base_model="meta/llama3.1-8b", # OSS model name <publisher>/<model_name>
        custom_base_model="gs://user-bucket/custom-weights",
    )
    sft_tuning_job = sft.train(
        source_model=model,
        train_dataset="gs://my-bucket/train.jsonl",
        validation_dataset="gs://my-bucket/validation.jsonl",
        epochs=4,
        tuned_model_display_name="my-tuned-model",
        output_uri="gs://user-bucket/tuned-model"
    )

    while not sft_tuning_job.has_ended:
        time.sleep(60)
        sft_tuning_job.refresh()

    tuned_model = aiplatform.Model(sft_tuning_job.tuned_model_name)
    ```

### [TuningJob](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.tuning.TuningJob)

Represents a TuningJob that runs with Google owned models.

### [SupervisedTuningJob](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.tuning.sft.SupervisedTuningJob)

Initializes class with project, location, and api_client.

### [ControlImageConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ControlImageConfig)

Control image config.

### [ControlReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ControlReferenceImage)

Control reference image.

This encapsulates the control reference image type.

### [EntityLabel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.EntityLabel)

Entity label holding a text label and any associated confidence score.

### [GeneratedImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.GeneratedImage)

Generated image.

### [GeneratedMask](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.GeneratedMask)

Generated image mask.

### [Image](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.Image)

Image.

### [ImageCaptioningModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageCaptioningModel)

Generates captions from image.

Examples::

    model = ImageCaptioningModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")
    captions = model.get_captions(
        image=image,
        # Optional:
        number_of_results=1,
        language="en",
    )

### [ImageGenerationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageGenerationModel)

Generates images from text prompt.

Examples::

    model = ImageGenerationModel.from_pretrained("imagegeneration@002")
    response = model.generate_images(
        prompt="Astronaut riding a horse",
        # Optional:
        number_of_images=1,
        seed=0,
    )
    response[0].show()
    response[0].save("image1.png")

### [ImageGenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageGenerationResponse)

Image generation response.

### [ImageQnAModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageQnAModel)

Answers questions about an image.

Examples::

    model = ImageQnAModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")
    answers = model.ask_question(
        image=image,
        question="What color is the car in this image?",
        # Optional:
        number_of_results=1,
    )

### [ImageSegmentationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageSegmentationModel)

Segments an image.

### [ImageSegmentationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageSegmentationResponse)

Image Segmentation response.

### [ImageTextModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ImageTextModel)

Generates text from images.

Examples::

    model = ImageTextModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")

    captions = model.get_captions(
        image=image,
        # Optional:
        number_of_results=1,
        language="en",
    )

    answers = model.ask_question(
        image=image,
        question="What color is the car in this image?",
        # Optional:
        number_of_results=1,
    )

### [MaskImageConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.MaskImageConfig)

Mask image config.

### [MaskReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.MaskReferenceImage)

Mask reference image. This encapsulates the mask reference image type.

### [MultiModalEmbeddingModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.MultiModalEmbeddingModel)

Generates embedding vectors from images and videos.

Examples::

    model = MultiModalEmbeddingModel.from_pretrained("multimodalembedding@001")
    image = Image.load_from_file("image.png")
    video = Video.load_from_file("video.mp4")

    embeddings = model.get_embeddings(
        image=image,
        video=video,
        contextual_text="Hello world",
    )
    image_embedding = embeddings.image_embedding
    video_embeddings = embeddings.video_embeddings
    text_embedding = embeddings.text_embedding

### [MultiModalEmbeddingResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.MultiModalEmbeddingResponse)

The multimodal embedding response.

### [RawReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.RawReferenceImage)

Raw reference image.

This encapsulates the raw reference image type.

### [ReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.ReferenceImage)

Reference image.

This is a new base API object for Imagen 3.0 Capabilities.

### [Scribble](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.Scribble)

Input scribble for image segmentation.

### [StyleImageConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.StyleImageConfig)

Style image config.

### [StyleReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.StyleReferenceImage)

Style reference image. This encapsulates the style reference image type.

### [SubjectImageConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.SubjectImageConfig)

Subject image config.

### [SubjectReferenceImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.SubjectReferenceImage)

Subject reference image.

This encapsulates the subject reference image type.

### [Video](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.Video)

Video.

### [VideoEmbedding](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.VideoEmbedding)

Embeddings generated from video with offset times.

### [VideoSegmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.VideoSegmentConfig)

The specific video segments (in seconds) the embeddings are generated for.

### [WatermarkVerificationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.WatermarkVerificationModel)

Verifies if an image has a watermark.

### [WatermarkVerificationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models.WatermarkVerificationResponse)

WatermarkVerificationResponse(_prediction_response: Any, watermark_verification_result: Optional\[str\] = None)

### [ModelMonitor](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.ModelMonitor)

Initializer for ModelMonitor.

### [ModelMonitoringJob](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.ModelMonitoringJob)

Initializer for ModelMonitoringJob.

Example Usage:

     my_monitoring_job = aiplatform.ModelMonitoringJob(
         model_monitoring_job_name='projects/123/locations/us-central1/modelMonitors/\
         my_model_monitor_id/modelMonitoringJobs/my_monitoring_job_id'
     )
     or
     my_monitoring_job = aiplatform.aiplatform.ModelMonitoringJob(
         model_monitoring_job_name='my_monitoring_job_id',
         model_monitor_id='my_model_monitor_id',
     )

### [DataDriftSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.DataDriftSpec)

Data drift monitoring spec.

Data drift measures the distribution distance between the current dataset
and a baseline dataset. A typical use case is to detect data drift between
the recent production serving dataset and the training dataset, or to
compare the recent production dataset with a dataset from a previous period.

.. rubric:: Example

feature_drift_spec=DataDriftSpec(
features=\["feature1"\]
categorical_metric_type="l_infinity",
numeric_metric_type="jensen_shannon_divergence",
default_categorical_alert_threshold=0.01,
default_numeric_alert_threshold=0.02,
feature_alert_thresholds={"feature1":0.02, "feature2":0.01},
)

### [FeatureAttributionSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.FeatureAttributionSpec)

Feature attribution spec.

.. rubric:: Example

feature_attribution_spec=FeatureAttributionSpec(
features=\["feature1"\]
default_alert_threshold=0.01,
feature_alert_thresholds={"feature1":0.02, "feature2":0.01},
batch_dedicated_resources=BatchDedicatedResources(
starting_replica_count=1,
max_replica_count=2,
machine_spec=my_machine_spec,
),
)

### [FieldSchema](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.FieldSchema)

Field Schema.

The class identifies the data type of a single feature,
which combines together to form the Schema for different fields in
ModelMonitoringSchema.

### [ModelMonitoringSchema](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.ModelMonitoringSchema)

Initializer for ModelMonitoringSchema.

### [MonitoringInput](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.MonitoringInput)

Model monitoring data input spec.

### [NotificationSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.NotificationSpec)

Initializer for NotificationSpec.

### [ObjectiveSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.ObjectiveSpec)

Initializer for ObjectiveSpec.

### [OutputSpec](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.OutputSpec)

Initializer for OutputSpec.

### [TabularObjective](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.resources.preview.ml_monitoring.spec.TabularObjective)

Initializer for TabularObjective.

### [GeneratedImage](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.GeneratedImage)

Generated image.

### [Image](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.Image)

Image.

### [ImageCaptioningModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.ImageCaptioningModel)

Generates captions from image.

Examples::

    model = ImageCaptioningModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")
    captions = model.get_captions(
        image=image,
        # Optional:
        number_of_results=1,
        language="en",
    )

### [ImageGenerationModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.ImageGenerationModel)

Generates images from text prompt.

Examples::

    model = ImageGenerationModel.from_pretrained("imagegeneration@002")
    response = model.generate_images(
        prompt="Astronaut riding a horse",
        # Optional:
        number_of_images=1,
        seed=0,
    )
    response[0].show()
    response[0].save("image1.png")

### [ImageGenerationResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.ImageGenerationResponse)

Image generation response.

### [ImageQnAModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.ImageQnAModel)

Answers questions about an image.

Examples::

    model = ImageQnAModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")
    answers = model.ask_question(
        image=image,
        question="What color is the car in this image?",
        # Optional:
        number_of_results=1,
    )

### [ImageTextModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.ImageTextModel)

Generates text from images.

Examples::

    model = ImageTextModel.from_pretrained("imagetext@001")
    image = Image.load_from_file("image.png")

    captions = model.get_captions(
        image=image,
        # Optional:
        number_of_results=1,
        language="en",
    )

    answers = model.ask_question(
        image=image,
        question="What color is the car in this image?",
        # Optional:
        number_of_results=1,
    )

### [MultiModalEmbeddingModel](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.MultiModalEmbeddingModel)

Generates embedding vectors from images and videos.

Examples::

    model = MultiModalEmbeddingModel.from_pretrained("multimodalembedding@001")
    image = Image.load_from_file("image.png")
    video = Video.load_from_file("video.mp4")

    embeddings = model.get_embeddings(
        image=image,
        video=video,
        contextual_text="Hello world",
    )
    image_embedding = embeddings.image_embedding
    video_embeddings = embeddings.video_embeddings
    text_embedding = embeddings.text_embedding

### [MultiModalEmbeddingResponse](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.MultiModalEmbeddingResponse)

The multimodal embedding response.

### [Video](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.Video)

Video.

### [VideoEmbedding](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.VideoEmbedding)

Embeddings generated from video with offset times.

### [VideoSegmentConfig](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.vision_models.VideoSegmentConfig)

The specific video segments (in seconds) the embeddings are generated for.

## Modules

### [agent_engines](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.agent_engines)

API documentation for `agent_engines` module.

### [evals](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.evals)

API documentation for `evals` module.

### [memories](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memories)

API documentation for `memories` module.

### [memory_revisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.memory_revisions)

API documentation for `memory_revisions` module.

### [prompt_optimizer](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompt_optimizer)

API documentation for `prompt_optimizer` module.

### [prompts](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.prompts)

API documentation for `prompts` module.

### [session_events](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.session_events)

API documentation for `session_events` module.

### [sessions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.sessions)

API documentation for `sessions` module.

### [skill_revisions](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skill_revisions)

API documentation for `skill_revisions` module.

### [skills](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai._genai.skills)

API documentation for `skills` module.

### [_language_models](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.language_models._language_models)

Classes for working with language models.

### [generative_models](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.generative_models)

Classes for working with the Gemini models.

### [language_models](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.language_models)

Classes for working with language models.

### [sft](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.tuning.sft)

Classes for supervised tuning.

### [vision_models](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.vision_models)

Classes for working with vision models.