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.

EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.

EnvVar

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

EventActions

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

EventMetadata

Metadata relating to a LLM response event.

ExecuteCodeAgentEngineSandboxConfig

Config for executing code in an Agent Engine sandbox.

ExecuteCodeAgentEngineSandboxRequestParameters

Parameters for executing code in an agent engine sandbox.

GenerateMemoriesConfig

Config for generating memories.

GenerateMemoriesOperation

Operation that generates memories with a Memory Bank.

GenerateMemoriesRequestDirectContentsSource

The direct contents source for generating memories.

GenerateMemoriesRequestDirectContentsSourceEvent

GenerateMemoriesRequestDirectMemoriesSource

The direct memories source for generating memories.

GenerateMemoriesRequestDirectMemoriesSourceDirectMemory

A direct memory to upload to Memory Bank.

GenerateMemoriesRequestParameters

Parameters for generating memories.

GenerateMemoriesRequestVertexSessionSource

The vertex session source for generating memories.

GetAgentEngineConfig

Config for create agent engine.

GetAgentEngineOperationConfig

GetAgentEngineOperationParameters

Parameters for getting an operation with an agent engine as a response.

GetAgentEngineRequestParameters

Parameters for getting agent engines.

GetAgentEngineSandboxConfig

Config for getting an Agent Engine Memory.

GetAgentEngineSandboxOperationParameters

Parameters for getting an operation with a sandbox as a response.

GetAgentEngineSandboxRequestParameters

Parameters for getting an agent engine sandbox.

GetAgentEngineSandboxSnapshotOperationParameters

Parameters for getting an operation with a sandbox snapshot as a response.

GetAgentEngineSessionConfig

Config for getting an Agent Engine Session.

GetAgentEngineSessionOperationParameters

Parameters for getting an operation with a session as a response.

GetAgentEngineSessionRequestParameters

Parameters for getting an agent engine session.

GetDatasetOperationConfig

Config for getting a dataset version operation.

GetDatasetOperationParameters

Parameters for getting a dataset operation.

GetDatasetParameters

Parameters for getting a dataset resource to store prompts.

GetDatasetVersionParameters

Parameters for getting a dataset resource to store prompts.

GetGenerateMemoriesOperationParameters

Parameters for getting an operation with generated memories as a response.

GetMemoryBankConfig

Config for getting a Memory Bank.

GetMemoryBankOperationConfig

GetMemoryBankOperationParameters

Parameters for getting an operation with a memory bank as a response.

GetMemoryBankRequestParameters

Parameters for getting a Memory Bank.

GetMemoryConfig

Config for getting a Memory.

GetMemoryOperationParameters

Parameters for getting an operation with a memory as a response.

GetMemoryRequestParameters

Parameters for getting a Memory.

GetMemoryRevisionConfig

Config for getting a Memory Revision.

GetMemoryRevisionRequestParameters

Parameters for getting a memory revision.

GetPromptConfig

Config for getting a prompt.

GetSandboxEnvironmentSnapshotConfig

Config for getting a Sandbox Environment Snapshot.

GetSandboxEnvironmentSnapshotRequestParameters

Parameters for getting a sandbox environment snapshot.

GetSandboxEnvironmentTemplateConfig

Config for getting a Sandbox Template.

GetSandboxEnvironmentTemplateOperationParameters

Parameters for getting an operation with a sandbox template as a response.

GetSandboxEnvironmentTemplateRequestParameters

Parameters for getting a sandbox template.

GetSkillConfig

Config for getting a skill.

GetSkillOperationConfig

GetSkillOperationParameters

Parameters for getting an operation.

GetSkillRequestParameters

Parameters for GetSkillRequest.

GetSkillRevisionConfig

Configuration for getting a Skill Revision.

GetSkillRevisionRequestParameters

Parameters for getting a Skill Revision.

GoogleTypeDate

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

GroundingChunk

A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a GroundingChunk that contains a reference to the source of the information.

GroundingChunkImage

An Image chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information.

GroundingChunkMaps

A Maps chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information.

GroundingChunkMapsPlaceAnswerSources

The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.

GroundingChunkMapsPlaceAnswerSourcesReviewSnippet

A review snippet that is used to generate the answer.

GroundingChunkMapsRoute

Route information from Google Maps.

GroundingChunkRetrievedContext

Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.

GroundingChunkWeb

A Web chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.

GroundingMetadata

Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.

GroundingMetadataSourceFlaggingUri

A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.

GroundingSupport

A collection of supporting references for a segment or part of the model's response.

IngestEventsConfig

Config for ingesting events.

IngestEventsRequestParameters

Parameters for ingesting events to Memory Bank.

IngestionDirectContentsSource

The direct contents source for ingesting events.

IngestionDirectContentsSourceEvent

The direct contents source event for ingesting events.

IntermediateExtractedMemory

An extracted memory that is the intermediate result before consolidation.

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.

KeepAliveProbeHttpGet

Specifies the HTTP GET configuration for the probe.

ListAgentEngineConfig

Config for listing agent engines.

ListAgentEngineRequestParameters

Parameters for listing agent engines.

ListAgentEngineSandboxesConfig

Config for listing agent engine sandboxes.

ListAgentEngineSandboxesRequestParameters

Parameters for listing agent engine sandboxes.

ListAgentEngineSessionEventsConfig

Config for listing agent engine session events.

ListAgentEngineSessionEventsRequestParameters

Parameters for listing agent engine session events.

ListAgentEngineSessionsConfig

Config for listing agent engine sessions.

ListAgentEngineSessionsRequestParameters

Parameters for listing agent engines.

ListDatasetsRequestParameters

Parameters for listing prompt datasets.

ListDatasetVersionsRequestParameters

Parameters for listing dataset versions.

ListMemoriesConfig

Config for listing memories.

ListMemoriesRequestParameters

Parameters for listing memories.

ListMemoryBanksConfig

Config for listing Memory Banks.

ListMemoryBanksRequestParameters

Parameters for listing Memory Banks.

ListMemoryRevisionsConfig

Config for listing memory revisions.

ListMemoryRevisionsRequestParameters

Parameters for listing memory revisions.

ListPromptsConfig

Config for listing prompt datasets and dataset versions.

ListSandboxEnvironmentSnapshotsConfig

Config for listing sandbox environment snapshots.

ListSandboxEnvironmentSnapshotsRequestParameters

Parameters for listing sandbox environment snapshots.

ListSandboxEnvironmentTemplatesConfig

Config for listing sandbox templates.

ListSandboxEnvironmentTemplatesRequestParameters

Parameters for listing sandbox templates.

ListSkillRevisionsConfig

Configuration for listing Skill Revisions.

ListSkillRevisionsRequestParameters

Parameters for ListSkillRevisionsRequest.

ListSkillsConfig

Config for listing skills.

ListSkillsRequestParameters

Parameters for listing skills.

ManagedSemanticMemoryConfig

The configuration for managed semantic memory.

ManagedSemanticMemoryConfigGenerationConfig

The configuration for generating memories.

ManagedSemanticMemoryConfigSimilaritySearchConfig

The configuration for similarity search.

ManagedSemanticMemoryConfigTtlConfig

The configuration for automatic TTL ('time-to-live') of the memories.

ManagedSemanticMemoryConfigTtlConfigGranularTtlConfig

The configuration for granular TTL.

Memory

A memory.

MemoryBank

A memory bank.

MemoryBankCustomizationConfig

Represents configuration for organizing natural language memories.

MemoryBankCustomizationConfigConsolidationConfig

Represents configuration for customizing how memories are consolidated.

MemoryBankCustomizationConfigGenerateMemoriesExample

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

MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource

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

MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent

The conversation source event for generating memories.

MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory

A memory generated by the operation.

MemoryBankCustomizationConfigMemoryTopic

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

MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic

A custom memory topic defined by the developer.

MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic

A managed memory topic defined by the system.

MemoryBankIngestEventsOperation

Operation that ingests events into a memory bank.

MemoryBankOperation

Operation that has an memory bank as a response.

MemoryConfig

Config for creating a Memory.

MemoryConjunctionFilter

The conjunction filter for memories.

MemoryFilter

Filter to apply when retrieving memories.

MemoryGenerationTriggerConfig

The configuration for triggering memory generation for ingested events.

MemoryGenerationTriggerConfigGenerationTriggerRule

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

MemoryMetadataValue

The metadata values for memories.

MemoryOperation

Operation that has a memory as a response.

MemoryProfile

A memory profile.

MemoryRevision

A memory revision.

MemoryStructuredContent

Represents the structured value of the memory.

MemoryTopicId

The topic ID for a memory.

Metadata

Metadata for a chunk.

PauseAgentEngineSandboxConfig

Config for pausing an Agent Engine sandbox.

PauseAgentEngineSandboxRequestParameters

Parameters for pausing an Agent Engine sandbox.

PrivateServiceConnectConfig

Represents configuration for private service connect.

Prompt

Represents a prompt.

PromptRef

Reference to a prompt.

PromptVersionRef

Reference to a prompt version.

PSCAutomationConfig

PSC config that is used to automatically create PSC endpoints in the user projects.

PscInterfaceConfig

Configuration for PSC-I.

PurgeMemoriesConfig

Config for purging memories.

PurgeMemoriesOperation

Operation that purges memories from a Memory Bank.

PurgeMemoriesRequestParameters

Parameters for purging memories.

QueryAgentEngineConfig

Config for querying agent engines.

QueryAgentEngineRequestParameters

Parameters for querying agent engines.

RagChunk

A RagChunk includes the content of a chunk of a RagFile, and associated metadata.

RagChunkPageSpan

Represents where the chunk starts and ends in the document.

ReasoningEngine

An agent engine.

ReasoningEngineContextSpec

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

ReasoningEngineContextSpecMemoryBankConfig

Specification for a Memory Bank.

ReasoningEngineContextSpecMemoryBankConfigGenerationConfig

Configuration for how to generate memories.

ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig

Configuration for how to perform similarity search on memories.

ReasoningEngineContextSpecMemoryBankConfigTtlConfig

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

ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig

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

ReasoningEngineRevisionGarbageCollectionStrategy

Configures garbage collection of Runtime Revisions.

ReasoningEngineRevisionGarbageCollectionStrategyKeepNLatest

Keeps only the latest N Runtime Revisions active.

ReasoningEngineSpec

The specification of an agent engine.

ReasoningEngineSpecContainerSpec

Specification for deploying from a container image.

ReasoningEngineSpecDeploymentSpec

The specification of a Reasoning Engine deployment.

ReasoningEngineSpecDeploymentSpecAgentGatewayConfig

Agent Gateway configuration for a Reasoning Engine deployment.

ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig

Configuration for traffic originating from a Reasoning Engine.

ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig

Configuration for traffic targeting a Reasoning Engine.

ReasoningEngineSpecPackageSpec

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

ReasoningEngineSpecSourceCodeSpec

Specification for deploying from source code.

ReasoningEngineSpecSourceCodeSpecAgentConfigSource

Specification for the deploying from agent config.

ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig

Configuration for the Agent Development Kit (ADK).

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.

ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource

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

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.

ReasoningEngineSpecSourceCodeSpecInlineSource

Specifies source code provided as a byte stream.

ReasoningEngineSpecSourceCodeSpecPythonSpec

Specification for running a Python application from source.

ReasoningEngineTrafficConfig

Traffic distribution configuration.

ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest

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

ReasoningEngineTrafficConfigTrafficSplitManual

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

ReasoningEngineTrafficConfigTrafficSplitManualTarget

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

RestoreVersionConfig

Config for restoring a prompt version.

RestoreVersionOperation

Represents the restore version operation.

RestoreVersionRequestParameters

Parameters for restoring a prompt version.

ResumeAgentEngineSandboxConfig

Config for resuming an Agent Engine sandbox.

ResumeAgentEngineSandboxRequestParameters

Parameters for resuming an Agent Engine sandbox.

RetrievalMetadata

Metadata related to the retrieval grounding source. This is part of the GroundingMetadata returned when grounding is enabled.

RetrievedSkill

A retrieved skill from semantic search.

RetrieveMemoriesConfig

Config for retrieving memories.

RetrieveMemoriesRequestParameters

Parameters for retrieving memories.

RetrieveMemoriesRequestSimilaritySearchParams

The parameters for semantic similarity search based retrieval.

RetrieveMemoriesRequestSimpleRetrievalParams

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

RetrieveMemoryProfilesConfig

Config for retrieving memory profiles.

RetrieveMemoryProfilesRequestParameters

Parameters for retrieving memory profiles.

RetrieveSkillsConfig

Config for retrieving skills.

RetrieveSkillsRequestParameters

Parameters for retrieving skills.

RollbackMemoryConfig

Config for rolling back a memory.

RollbackMemoryOperation

Operation that rolls back a memory.

RollbackMemoryRequestParameters

Parameters for generating memories.

RunQueryJobAgentEngineConfig

Config for checking a query job on an agent engine.

RunQueryJobResult

Result of running a query job.

SandboxEnvironment

A sandbox environment.

SandboxEnvironmentConnectionInfo

The connection information of the SandboxEnvironment.

SandboxEnvironmentSnapshot

A sandbox environment snapshot.

SandboxEnvironmentSpec

The specification of a sandbox environment.

SandboxEnvironmentSpecCodeExecutionEnvironment

The code execution environment with customized settings.

SandboxEnvironmentSpecComputerUseEnvironment

The computer use environment with customized settings.

SandboxEnvironmentSpecShellEnvironment

The shell environment.

SandboxEnvironmentTemplate

A sandbox environment template.

SandboxEnvironmentTemplateCustomContainerEnvironment

The customized sandbox runtime environment for BYOC.

SandboxEnvironmentTemplateCustomContainerSpec

Specification for deploying from a custom container image.

SandboxEnvironmentTemplateDefaultContainerEnvironment

The default sandbox runtime environment for default container workloads.

SandboxEnvironmentTemplateEgressControlConfig

Configuration for egress control of sandbox instances.

SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig

Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.

SandboxEnvironmentTemplateNetworkPort

Represents a network port in a container.

SandboxEnvironmentTemplateOperation

Operation that has an agent engine sandbox as a response.

SandboxEnvironmentTemplatePersistentDiskConfig

Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down.

SandboxEnvironmentTemplateResourceRequirements

Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.

SavedQuery

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

SchemaPredictParamsGroundingConfig

The configuration for grounding checking.

SchemaPredictParamsGroundingConfigSourceEntry

Single source entry for the grounding checking.

SchemaPromptApiSchema

The A2 schema of a prompt.

SchemaPromptInstancePromptExecution

A prompt instance's parameters set that contains a set of variable values.

SchemaPromptInstanceVariableValue

Represents a prompt instance variable.

SchemaPromptSpecAppBuilderData

Defines data for an application builder.

SchemaPromptSpecAppBuilderDataLinkedResource

A linked resource attached to the application by the user.

SchemaPromptSpecContentMetadata

Metadata the model returned alongside the content it generated.

SchemaPromptSpecInteractionData

Defines data for an interaction prompt.

SchemaPromptSpecMultimodalPrompt

Prompt variation that embeds preambles to prompt string.

SchemaPromptSpecPartList

Represents a prompt spec part list.

SchemaPromptSpecPromptMessage

Represents a prompt message.

SchemaPromptSpecReferenceSentencePair

A pair of sentences used as reference in source and target languages.

SchemaPromptSpecReferenceSentencePairList

A list of reference sentence pairs.

SchemaPromptSpecStructuredPrompt

Represents a structured prompt.

SchemaPromptSpecTranslationExample

The translation example that contains reference sentences from various sources.

SchemaPromptSpecTranslationFileInputSource

SchemaPromptSpecTranslationGcsInputSource

SchemaPromptSpecTranslationOption

Optional settings for translation prompt.

SchemaPromptSpecTranslationPrompt

Prompt variation for Translation use case.

SchemaPromptSpecTranslationSentenceFileInput

SchemaTextPromptDatasetMetadata

Represents the text prompt dataset metadata.

SearchEntryPoint

An entry point for displaying Google Search results. A SearchEntryPoint is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.

SecretEnvVar

Represents an environment variable where the value is a secret in Cloud Secret Manager.

SecretRef

Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.

Segment

A segment of the content.

Session

A session.

SessionEvent

A session event.

Skill

Represents a Skill resource.

Patches the type from the discovery document.

SkillOperation

Operation that has a skill as a response.

SkillRevision

A single revision of a Skill.

StructuredMemoryConfig

Configuration for organizing structured memories within a scope.

StructuredMemorySchemaConfig

Represents the OpenAPI schema of the structured memories.

UpdateAgentEngineConfig

Config for updating agent engine.

UpdateAgentEngineRequestParameters

Parameters for updating agent engines.

UpdateAgentEngineSessionConfig

Config for updating agent engine session.

UpdateAgentEngineSessionRequestParameters

Parameters for updating agent engine sessions.

UpdateDatasetParameters

Parameters for creating a dataset resource to store prompts.

UpdateMemoryBankConfig

Config for updating a memory bank.

UpdateMemoryBankRequestParameters

Parameters for updating memory banks.

UpdateMemoryConfig

Config for updating a memory.

UpdateMemoryRequestParameters

Parameters for updating memories.

UpdatePromptConfig

Config for creating a dataset resource to store prompts.

UpdateSkillConfig

Config for updating a skill.

UpdateSkillRequestParameters

Parameters for updating a skill.

Type Aliases

ParsedResponseUnion

export type ParsedResponseUnion = any;

PromptData

export type PromptData = SchemaPromptSpecPromptMessage;

VertexBaseConfig

export type VertexBaseConfig = any;

Package @google-cloud/agentplatform (0.16.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Interfaces

Package @google-cloud/agentplatform (0.16.0)