Skip to main content
Documentation
Technology areas
close
AI and ML
Application development
Application hosting
Compute
Data analytics and pipelines
Databases
Distributed, hybrid, and multicloud
Generative AI
Industry solutions
Networking
Observability and monitoring
Security
Storage
Cross-product tools
close
Access and resources management
Costs and usage management
Google Cloud SDK, languages, frameworks, and tools
Infrastructure as code
Migration
Related sites
close
Google Cloud Home
Free Trial and Free Tier
Architecture Center
Blog
Contact Sales
Google Cloud Developer Center
Google Developer Center
Google Cloud Marketplace
Google Cloud Marketplace Documentation
Google Cloud Skills Boost
Google Cloud Solution Center
Google Cloud Support
Google Cloud Tech Youtube Channel
/
English
Deutsch
Español – América Latina
Français
Indonesia
Italiano
Português – Brasil
中文 – 简体
日本語
한국어
Console
Sign in
Generative AI on Vertex AI
Guides
API reference
Vertex AI Cookbook
Prompt gallery
Resources
FAQ
Contact Us
Start free
Documentation
Guides
API reference
Vertex AI Cookbook
Prompt gallery
Resources
FAQ
Technology areas
More
Cross-product tools
More
Related sites
More
Console
Contact Us
Start free
API reference
Gemini API
Generate content
Function calling
Prompt classes
Grounding
Code execution API
Live API
API errors
Embeddings API
Text embeddings
Multimodal embeddings
Imagen API
Generate images
Edit images
Customize images (few-shot)
Virtual Try-On API
Product Recontext API
Image captioning
Visual question answering (VQA)
Veo video generation API
Lyria music generation API
Batch prediction API
Tuning API
Gen AI Evaluation API
RAG API
RAG API v1beta1
RAG API v1
Retrieval and generation output of RAG
CountTokens API
MedLM API
REST and RPC reference
Vertex AI in express mode
REST API reference
v1
Overview
countTokens
generateContent
streamGenerateContent
v1beta1
Overview
countTokens
generateContent
streamGenerateContent
REST
All methods
v1
REST Resources
media
Overview
upload
projects
Overview
getCacheConfig
updateCacheConfig
projects.locations
Overview
augmentPrompt
corroborateContent
evaluateDataset
evaluateInstances
generateInstanceRubrics
generateSyntheticData
getRagEngineConfig
retrieveContexts
updateRagEngineConfig
projects.locations.cachedContents
Overview
create
delete
get
list
patch
projects.locations.endpoints
Overview
fetchPredictOperation
generateContent
predict
predictLongRunning
rawPredict
serverStreamingPredict
streamGenerateContent
streamRawPredict
projects.locations.endpoints.chat
Overview
completions
projects.locations.endpoints.deployedModels.invoke
Overview
invoke
projects.locations.endpoints.invoke
Overview
invoke
projects.locations.endpoints.openapi
Overview
embeddings
projects.locations.evaluationItems
Overview
create
delete
get
list
projects.locations.evaluationRuns
Overview
cancel
create
delete
get
list
projects.locations.evaluationSets
Overview
create
delete
get
list
patch
projects.locations.models
Overview
getIamPolicy
setIamPolicy
testIamPermissions
projects.locations.operations
Overview
cancel
delete
get
list
wait
projects.locations.publishers.models
Overview
fetchPredictOperation
generateContent
predict
predictLongRunning
rawPredict
serverStreamingPredict
streamGenerateContent
streamRawPredict
projects.locations.ragCorpora
Overview
create
delete
get
list
patch
projects.locations.ragCorpora.ragFiles
Overview
delete
get
import
list
projects.locations.reasoningEngines
Overview
create
delete
get
list
patch
query
streamQuery
projects.locations.tuningJobs
Overview
cancel
create
get
list
rebaseTunedModel
Types
ApiAuth
ApiKeyConfig
AutoraterConfig
BleuSpec
Content
CustomOutputFormatConfig
EncryptionSpec
ExactMatchSpec
Fact
GenerateContentResponse
HarmBlockThreshold
HarmCategory
Metric
ModelArmorConfig
PairwiseMetricSpec
PointwiseMetricSpec
PredefinedMetricSpec
PredictResponse
RagChunk
RagEngineConfig
RagFileTransformationConfig
RougeSpec
Rubric
RubricGenerationSpec
SafetySetting
Schema
StreamingPredictResponse
Tensor
v1beta1
REST Resources
media
Overview
upload
projects
Overview
getCacheConfig
updateCacheConfig
projects.locations
Overview
augmentPrompt
corroborateContent
evaluateDataset
evaluateInstances
generateInstanceRubrics
generateSyntheticData
getRagEngineConfig
retrieveContexts
updateRagEngineConfig
projects.locations.cachedContents
Overview
create
delete
get
list
patch
projects.locations.endpoints
Overview
countTokens
fetchPredictOperation
generateContent
getIamPolicy
predict
predictLongRunning
rawPredict
serverStreamingPredict
setIamPolicy
streamGenerateContent
streamRawPredict
testIamPermissions
projects.locations.endpoints.chat
Overview
completions
projects.locations.endpoints.deployedModels.invoke
Overview
invoke
projects.locations.endpoints.invoke
Overview
invoke
projects.locations.endpoints.openapi
Overview
embeddings
projects.locations.evaluationItems
Overview
create
delete
get
list
projects.locations.evaluationRuns
Overview
cancel
create
delete
get
list
projects.locations.evaluationSets
Overview
create
delete
get
list
patch
projects.locations.extensions
Overview
delete
execute
get
import
list
patch
query
projects.locations.models
Overview
getIamPolicy
setIamPolicy
testIamPermissions
projects.locations.operations
Overview
cancel
delete
get
list
wait
projects.locations.publishers
Overview
getIamPolicy
projects.locations.publishers.models
Overview
countTokens
fetchPredictOperation
generateContent
getIamPolicy
predict
predictLongRunning
rawPredict
serverStreamingPredict
streamGenerateContent
streamRawPredict
projects.locations.ragCorpora
Overview
create
delete
get
list
patch
projects.locations.ragCorpora.ragFiles
Overview
delete
get
import
list
projects.locations.reasoningEngines
Overview
create
delete
get
list
patch
query
streamQuery
projects.locations.reasoningEngines.a2a.v1
Overview
card
projects.locations.reasoningEngines.a2a.v1.message
Overview
send
stream
projects.locations.reasoningEngines.a2a.v1.tasks
Overview
a2aGetReasoningEngine
cancel
pushNotificationConfigs
subscribe
projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs
Overview
a2aGetReasoningEngine
projects.locations.reasoningEngines.memories
Overview
create
delete
generate
get
list
patch
retrieve
projects.locations.reasoningEngines.sessions
Overview
appendEvent
create
delete
get
list
patch
projects.locations.reasoningEngines.sessions.events
Overview
list
projects.locations.tuningJobs
Overview
cancel
create
get
list
optimizePrompt
rebaseTunedModel
Types
ApiAuth
ApiKeyConfig
AuthConfig
CacheConfig
Content
CountTokensResponse
EncryptionSpec
Fact
FunctionDeclaration
GcsDestination
GcsSource
GenerateContentResponse
GroundingMetadata
HarmBlockThreshold
HarmCategory
ModalityTokenCount
ModelArmorConfig
PredictResponse
RagChunk
RagEngineConfig
RagFileChunkingConfig
RagFileMetadataConfig
RagFileParsingConfig
RagFileTransformationConfig
Rubric
SafetySetting
Schema
SessionEvent
StreamingPredictResponse
Tensor
Shared types
Types
AuditConfig
Binding
CacheConfig
CancelOperationRequest
Date
DeleteOperationRequest
GetIamPolicyRequest
GetOperationRequest
HttpBody
LatLng
ListOperationsRequest
ListOperationsResponse
LogType
Policy
SetIamPolicyRequest
TestIamPermissionsRequest
TestIamPermissionsResponse
WaitOperationRequest
RPC
Overview
cloud.ai.platform.common
google.api
google.cloud.aiplatform.v1
google.cloud.aiplatform.v1beta1
google.iam.v1
google.longrunning
google.rpc
google.type
Google Gen AI SDK
Overview
Python
Go
Java
Node.js
Vertex AI SDK
Overview
Python
Node.js
vertexai
Quickstart
Overview
Classes
ChatSession
ChatSessionPreview
ClientError
GenerateContentResponseHandler
GenerativeModel
GenerativeModelPreview
GoogleApiError
GoogleAuthError
GoogleGenerativeAIError
IllegalArgumentError
VertexAI
Interfaces
BaseModelParams
BasePart
CachedContent
CachedContentUsageMetadata
Citation
CitationMetadata
Content
CountTokensRequest
CountTokensResponse
ErrorDetails
FileData
FileDataPart
FunctionCall
FunctionCallPart
FunctionCallingConfig
FunctionDeclaration
FunctionDeclarationSchema
FunctionDeclarationsTool
FunctionResponse
FunctionResponsePart
GenerateContentCandidate
GenerateContentRequest
GenerateContentResponse
GenerateContentResult
GenerationConfig
GenerativeContentBlob
GetGenerativeModelParams
GoogleDate
GoogleSearchRetrieval
GoogleSearchRetrievalTool
GroundingAttributionRetrievedContext
GroundingAttributionSegment
GroundingAttributionWeb
GroundingChunk
GroundingChunkRetrievedContext
GroundingChunkWeb
GroundingMetadata
GroundingSupport
GroundingSupportSegment
InlineDataPart
ListCachedContentsResponse
ModelParams
PromptFeedback
RagResource
RequestOptions
ResponseSchema
Retrieval
RetrievalTool
SafetyRating
SafetySetting
Schema
SearchEntryPoint
StartChatParams
StartChatSessionRequest
StreamGenerateContentResult
TextPart
ToolConfig
UsageMetadata
VertexAISearch
VertexInit
VertexRagStore
Enums
BlockedReason
FinishReason
FunctionCallingMode
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Java
google-cloud-vertexai
Overview
Version history
com.google.cloud.vertexai
Package summary
Classes
Constants
VertexAI
VertexAI.Builder
Enums
Transport
com.google.cloud.vertexai.api
Package summary
Interfaces
ApiAuth.ApiKeyConfigOrBuilder
ApiAuthOrBuilder
AttributionOrBuilder
AutomaticResourcesOrBuilder
AutoscalingMetricSpecOrBuilder
AvroSourceOrBuilder
BatchDedicatedResourcesOrBuilder
BigQueryDestinationOrBuilder
BigQuerySourceOrBuilder
BlobOrBuilder
BlurBaselineConfigOrBuilder
BoolArrayOrBuilder
CachedContent.UsageMetadataOrBuilder
CachedContentOrBuilder
CandidateOrBuilder
CitationMetadataOrBuilder
CitationOrBuilder
ClientConnectionConfigOrBuilder
CodeExecutionResultOrBuilder
ComputeTokensRequestOrBuilder
ComputeTokensResponseOrBuilder
ContainerRegistryDestinationOrBuilder
ContentOrBuilder
CountTokensRequestOrBuilder
CountTokensResponseOrBuilder
CreateEndpointOperationMetadataOrBuilder
CreateEndpointRequestOrBuilder
CsvDestinationOrBuilder
CsvSourceOrBuilder
DedicatedResourcesOrBuilder
DeleteEndpointRequestOrBuilder
DeleteOperationMetadataOrBuilder
DeployModelOperationMetadataOrBuilder
DeployModelRequestOrBuilder
DeployModelResponseOrBuilder
DeployedModel.StatusOrBuilder
DeployedModelOrBuilder
DirectPredictRequestOrBuilder
DirectPredictResponseOrBuilder
DirectRawPredictRequestOrBuilder
DirectRawPredictResponseOrBuilder
DirectUploadSourceOrBuilder
DiskSpecOrBuilder
DoubleArrayOrBuilder
DynamicRetrievalConfigOrBuilder
EncryptionSpecOrBuilder
EndpointOrBuilder
EndpointServiceGrpc.AsyncService
EnterpriseWebSearchOrBuilder
Examples.ExampleGcsSourceOrBuilder
ExamplesOrBuilder
ExamplesOverrideOrBuilder
ExamplesRestrictionsNamespaceOrBuilder
ExecutableCodeOrBuilder
ExplainRequestOrBuilder
ExplainResponseOrBuilder
ExplanationMetadata.InputMetadata.FeatureValueDomainOrBuilder
ExplanationMetadata.InputMetadata.VisualizationOrBuilder
ExplanationMetadata.InputMetadataOrBuilder
ExplanationMetadata.OutputMetadataOrBuilder
ExplanationMetadataOrBuilder
ExplanationMetadataOverride.InputMetadataOverrideOrBuilder
ExplanationMetadataOverrideOrBuilder
ExplanationOrBuilder
ExplanationParametersOrBuilder
ExplanationSpecOrBuilder
ExplanationSpecOverrideOrBuilder
FasterDeploymentConfigOrBuilder
FeatureNoiseSigma.NoiseSigmaForFeatureOrBuilder
FeatureNoiseSigmaOrBuilder
FileDataOrBuilder
FunctionCallOrBuilder
FunctionCallingConfigOrBuilder
FunctionDeclarationOrBuilder
FunctionResponseOrBuilder
GcsDestinationOrBuilder
GcsSourceOrBuilder
GenerateContentRequestOrBuilder
GenerateContentResponse.PromptFeedbackOrBuilder
GenerateContentResponse.UsageMetadataOrBuilder
GenerateContentResponseOrBuilder
GenerationConfig.RoutingConfig.AutoRoutingModeOrBuilder
GenerationConfig.RoutingConfig.ManualRoutingModeOrBuilder
GenerationConfig.RoutingConfigOrBuilder
GenerationConfigOrBuilder
GenericOperationMetadataOrBuilder
GetEndpointRequestOrBuilder
GoogleDriveSource.ResourceIdOrBuilder
GoogleDriveSourceOrBuilder
GoogleSearchRetrievalOrBuilder
GroundingChunk.RetrievedContextOrBuilder
GroundingChunk.WebOrBuilder
GroundingChunkOrBuilder
GroundingMetadataOrBuilder
GroundingSupportOrBuilder
Int64ArrayOrBuilder
IntegratedGradientsAttributionOrBuilder
JiraSource.JiraQueriesOrBuilder
JiraSourceOrBuilder
ListEndpointsRequestOrBuilder
ListEndpointsResponseOrBuilder
LlmUtilityServiceGrpc.AsyncService
LogprobsResult.CandidateOrBuilder
LogprobsResult.TopCandidatesOrBuilder
LogprobsResultOrBuilder
MachineSpecOrBuilder
ModalityTokenCountOrBuilder
ModelExplanationOrBuilder
MutateDeployedModelOperationMetadataOrBuilder
MutateDeployedModelRequestOrBuilder
MutateDeployedModelResponseOrBuilder
NeighborOrBuilder
NfsMountOrBuilder
PSCAutomationConfigOrBuilder
PartOrBuilder
PersistentDiskSpecOrBuilder
PredictRequestOrBuilder
PredictRequestResponseLoggingConfigOrBuilder
PredictResponseOrBuilder
PredictionServiceGrpc.AsyncService
PresetsOrBuilder
PrivateEndpointsOrBuilder
PrivateServiceConnectConfigOrBuilder
PscAutomatedEndpointsOrBuilder
RagRetrievalConfig.FilterOrBuilder
RagRetrievalConfig.Ranking.LlmRankerOrBuilder
RagRetrievalConfig.Ranking.RankServiceOrBuilder
RagRetrievalConfig.RankingOrBuilder
RagRetrievalConfigOrBuilder
RawPredictRequestOrBuilder
ReservationAffinityOrBuilder
ResourcesConsumedOrBuilder
RetrievalConfigOrBuilder
RetrievalMetadataOrBuilder
RetrievalOrBuilder
SafetyRatingOrBuilder
SafetySettingOrBuilder
SampledShapleyAttributionOrBuilder
SchemaOrBuilder
SearchEntryPointOrBuilder
SegmentOrBuilder
SharePointSources.SharePointSourceOrBuilder
SharePointSourcesOrBuilder
ShieldedVmConfigOrBuilder
SlackSource.SlackChannels.SlackChannelOrBuilder
SlackSource.SlackChannelsOrBuilder
SlackSourceOrBuilder
SmoothGradConfigOrBuilder
SpeculativeDecodingSpec.DraftModelSpeculationOrBuilder
SpeculativeDecodingSpec.NgramSpeculationOrBuilder
SpeculativeDecodingSpecOrBuilder
StreamDirectPredictRequestOrBuilder
StreamDirectPredictResponseOrBuilder
StreamDirectRawPredictRequestOrBuilder