Package com.google.cloud.vertexai.api (1.2.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.vertexai.api.EndpointServiceClient Service Description: A service for managing Vertex AI's Endpoints.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.vertexai.api.LlmUtilityServiceClient Service Description: Service for LLM related utility functions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.vertexai.api.PredictionServiceClient Service Description: A service for online predictions and explanations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.vertexai.api.EndpointServiceSettings Settings class to configure an instance of EndpointServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.vertexai.api.LlmUtilityServiceSettings Settings class to configure an instance of LlmUtilityServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.vertexai.api.PredictionServiceSettings Settings class to configure an instance of PredictionServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.vertexai.api.AcceleratorTypeProto
com.google.cloud.vertexai.api.Attribution Attribution that explains a particular prediction output.
com.google.cloud.vertexai.api.Attribution.Builder Attribution that explains a particular prediction output.
com.google.cloud.vertexai.api.AutomaticResources A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.
com.google.cloud.vertexai.api.AutomaticResources.Builder A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.
com.google.cloud.vertexai.api.AutoscalingMetricSpec The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
com.google.cloud.vertexai.api.AutoscalingMetricSpec.Builder The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
com.google.cloud.vertexai.api.AvroSource The storage details for Avro input content.
com.google.cloud.vertexai.api.AvroSource.Builder The storage details for Avro input content.
com.google.cloud.vertexai.api.BatchDedicatedResources A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.
com.google.cloud.vertexai.api.BatchDedicatedResources.Builder A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.
com.google.cloud.vertexai.api.BigQueryDestination The BigQuery location for the output content.
com.google.cloud.vertexai.api.BigQueryDestination.Builder The BigQuery location for the output content.
com.google.cloud.vertexai.api.BigQuerySource The BigQuery location for the input content.
com.google.cloud.vertexai.api.BigQuerySource.Builder The BigQuery location for the input content.
com.google.cloud.vertexai.api.Blob Content blob. It's preferred to send as text
com.google.cloud.vertexai.api.Blob.Builder Content blob. It's preferred to send as text
com.google.cloud.vertexai.api.BlurBaselineConfig Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input
com.google.cloud.vertexai.api.BlurBaselineConfig.Builder Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input
com.google.cloud.vertexai.api.BoolArray A list of boolean values.
com.google.cloud.vertexai.api.BoolArray.Builder A list of boolean values.
com.google.cloud.vertexai.api.Candidate A response candidate generated from the model.
com.google.cloud.vertexai.api.Candidate.Builder A response candidate generated from the model.
com.google.cloud.vertexai.api.Citation Source attributions for content.
com.google.cloud.vertexai.api.Citation.Builder Source attributions for content.
com.google.cloud.vertexai.api.CitationMetadata A collection of source attributions for a piece of content.
com.google.cloud.vertexai.api.CitationMetadata.Builder A collection of source attributions for a piece of content.
com.google.cloud.vertexai.api.ComputeTokensRequest Request message for ComputeTokens RPC call.
com.google.cloud.vertexai.api.ComputeTokensRequest.Builder Request message for ComputeTokens RPC call.
com.google.cloud.vertexai.api.ComputeTokensResponse Response message for ComputeTokens RPC call.
com.google.cloud.vertexai.api.ComputeTokensResponse.Builder Response message for ComputeTokens RPC call.
com.google.cloud.vertexai.api.ContainerRegistryDestination The Container Registry location for the container image.
com.google.cloud.vertexai.api.ContainerRegistryDestination.Builder The Container Registry location for the container image.
com.google.cloud.vertexai.api.Content The base structured datatype containing multi-part content of a message. A Content includes a role field designating the producer of the Content
com.google.cloud.vertexai.api.Content.Builder The base structured datatype containing multi-part content of a message. A Content includes a role field designating the producer of the Content
com.google.cloud.vertexai.api.ContentProto
com.google.cloud.vertexai.api.CountTokensRequest Request message for [PredictionService.CountTokens][].
com.google.cloud.vertexai.api.CountTokensRequest.Builder Request message for [PredictionService.CountTokens][].
com.google.cloud.vertexai.api.CountTokensResponse Response message for [PredictionService.CountTokens][].
com.google.cloud.vertexai.api.CountTokensResponse.Builder Response message for [PredictionService.CountTokens][].
com.google.cloud.vertexai.api.CreateEndpointOperationMetadata Runtime operation information for EndpointService.CreateEndpoint.
com.google.cloud.vertexai.api.CreateEndpointOperationMetadata.Builder Runtime operation information for EndpointService.CreateEndpoint.
com.google.cloud.vertexai.api.CreateEndpointRequest Request message for EndpointService.CreateEndpoint.
com.google.cloud.vertexai.api.CreateEndpointRequest.Builder Request message for EndpointService.CreateEndpoint.
com.google.cloud.vertexai.api.CsvDestination The storage details for CSV output content.
com.google.cloud.vertexai.api.CsvDestination.Builder The storage details for CSV output content.
com.google.cloud.vertexai.api.CsvSource The storage details for CSV input content.
com.google.cloud.vertexai.api.CsvSource.Builder The storage details for CSV input content.
com.google.cloud.vertexai.api.DedicatedResources A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.
com.google.cloud.vertexai.api.DedicatedResources.Builder A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.
com.google.cloud.vertexai.api.DeleteEndpointRequest Request message for EndpointService.DeleteEndpoint.
com.google.cloud.vertexai.api.DeleteEndpointRequest.Builder Request message for EndpointService.DeleteEndpoint.
com.google.cloud.vertexai.api.DeleteOperationMetadata Details of operations that perform deletes of any entities.
com.google.cloud.vertexai.api.DeleteOperationMetadata.Builder Details of operations that perform deletes of any entities.
com.google.cloud.vertexai.api.DeployModelOperationMetadata Runtime operation information for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployModelOperationMetadata.Builder Runtime operation information for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployModelRequest Request message for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployModelRequest.Builder Request message for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployModelResponse Response message for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployModelResponse.Builder Response message for EndpointService.DeployModel.
com.google.cloud.vertexai.api.DeployedModel A deployment of a Model. Endpoints contain one or more DeployedModels.
com.google.cloud.vertexai.api.DeployedModel.Builder A deployment of a Model. Endpoints contain one or more DeployedModels.
com.google.cloud.vertexai.api.DirectPredictRequest Request message for PredictionService.DirectPredict.
com.google.cloud.vertexai.api.DirectPredictRequest.Builder Request message for PredictionService.DirectPredict.
com.google.cloud.vertexai.api.DirectPredictResponse Response message for PredictionService.DirectPredict.
com.google.cloud.vertexai.api.DirectPredictResponse.Builder Response message for PredictionService.DirectPredict.
com.google.cloud.vertexai.api.DirectRawPredictRequest Request message for PredictionService.DirectRawPredict.
com.google.cloud.vertexai.api.DirectRawPredictRequest.Builder Request message for PredictionService.DirectRawPredict.
com.google.cloud.vertexai.api.DirectRawPredictResponse Response message for PredictionService.DirectRawPredict.
com.google.cloud.vertexai.api.DirectRawPredictResponse.Builder Response message for PredictionService.DirectRawPredict.
com.google.cloud.vertexai.api.DiskSpec Represents the spec of disk options.
com.google.cloud.vertexai.api.DiskSpec.Builder Represents the spec of disk options.
com.google.cloud.vertexai.api.DoubleArray A list of double values.
com.google.cloud.vertexai.api.DoubleArray.Builder A list of double values.
com.google.cloud.vertexai.api.EncryptionSpec Represents a customer-managed encryption key spec that can be applied to a top-level resource.
com.google.cloud.vertexai.api.EncryptionSpec.Builder Represents a customer-managed encryption key spec that can be applied to a top-level resource.
com.google.cloud.vertexai.api.EncryptionSpecProto
com.google.cloud.vertexai.api.Endpoint Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
com.google.cloud.vertexai.api.Endpoint.Builder Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
com.google.cloud.vertexai.api.EndpointName
com.google.cloud.vertexai.api.EndpointName.Builder Builder for projects/{project}/locations/{location}/endpoints/{endpoint}.
com.google.cloud.vertexai.api.EndpointName.ProjectLocationPublisherModelBuilder Builder for projects/{project}/locations/{location}/publishers/{publisher}/models/{model}.
com.google.cloud.vertexai.api.EndpointProto
com.google.cloud.vertexai.api.EndpointServiceClient.ListEndpointsFixedSizeCollection
com.google.cloud.vertexai.api.EndpointServiceClient.ListEndpointsPage
com.google.cloud.vertexai.api.EndpointServiceClient.ListEndpointsPagedResponse
com.google.cloud.vertexai.api.EndpointServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.vertexai.api.EndpointServiceClient.ListLocationsPage
com.google.cloud.vertexai.api.EndpointServiceClient.ListLocationsPagedResponse
com.google.cloud.vertexai.api.EndpointServiceGrpc A service for managing Vertex AI's Endpoints.
com.google.cloud.vertexai.api.EndpointServiceGrpc.EndpointServiceImplBase Base class for the server implementation of the service EndpointService. A service for managing Vertex AI's Endpoints.
com.google.cloud.vertexai.api.EndpointServiceProto
com.google.cloud.vertexai.api.EndpointServiceSettings.Builder Builder for EndpointServiceSettings.
com.google.cloud.vertexai.api.Examples Example-based explainability that returns the nearest neighbors from the provided dataset.
com.google.cloud.vertexai.api.Examples.Builder Example-based explainability that returns the nearest neighbors from the provided dataset.
com.google.cloud.vertexai.api.Examples.ExampleGcsSource The Cloud Storage input instances.
com.google.cloud.vertexai.api.Examples.ExampleGcsSource.Builder The Cloud Storage input instances.
com.google.cloud.vertexai.api.ExamplesOverride Overrides for example-based explanations.
com.google.cloud.vertexai.api.ExamplesOverride.Builder Overrides for example-based explanations.
com.google.cloud.vertexai.api.ExamplesRestrictionsNamespace Restrictions namespace for example-based explanations overrides.
com.google.cloud.vertexai.api.ExamplesRestrictionsNamespace.Builder Restrictions namespace for example-based explanations overrides.
com.google.cloud.vertexai.api.ExplainRequest Request message for PredictionService.Explain.
com.google.cloud.vertexai.api.ExplainRequest.Builder Request message for PredictionService.Explain.
com.google.cloud.vertexai.api.ExplainResponse Response message for PredictionService.Explain.
com.google.cloud.vertexai.api.ExplainResponse.Builder Response message for PredictionService.Explain.
com.google.cloud.vertexai.api.Explanation Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given
com.google.cloud.vertexai.api.Explanation.Builder Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given
com.google.cloud.vertexai.api.ExplanationMetadata Metadata describing the Model's input and output for explanation.
com.google.cloud.vertexai.api.ExplanationMetadata.Builder Metadata describing the Model's input and output for explanation.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata Metadata of the input of a feature. Fields other than
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Builder Metadata of the input of a feature. Fields other than
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.FeatureValueDomain Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization Visualization configurations for image explanation.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization.Builder Visualization configurations for image explanation.
com.google.cloud.vertexai.api.ExplanationMetadata.OutputMetadata Metadata of the prediction output to be explained.
com.google.cloud.vertexai.api.ExplanationMetadata.OutputMetadata.Builder Metadata of the prediction output to be explained.
com.google.cloud.vertexai.api.ExplanationMetadataOverride The ExplanationMetadata entries that can be overridden at online explanation time.
com.google.cloud.vertexai.api.ExplanationMetadataOverride.Builder The ExplanationMetadata entries that can be overridden at online explanation time.
com.google.cloud.vertexai.api.ExplanationMetadataOverride.InputMetadataOverride The input metadata entries to be overridden.
com.google.cloud.vertexai.api.ExplanationMetadataOverride.InputMetadataOverride.Builder The input metadata entries to be overridden.
com.google.cloud.vertexai.api.ExplanationMetadataProto
com.google.cloud.vertexai.api.ExplanationParameters Parameters to configure explaining for Model's predictions.
com.google.cloud.vertexai.api.ExplanationParameters.Builder Parameters to configure explaining for Model's predictions.
com.google.cloud.vertexai.api.ExplanationProto
com.google.cloud.vertexai.api.ExplanationSpec Specification of Model explanation.
com.google.cloud.vertexai.api.ExplanationSpec.Builder Specification of Model explanation.
com.google.cloud.vertexai.api.ExplanationSpecOverride The ExplanationSpec entries that can be overridden at online explanation time.
com.google.cloud.vertexai.api.ExplanationSpecOverride.Builder The ExplanationSpec entries that can be overridden at online explanation time.
com.google.cloud.vertexai.api.FeatureNoiseSigma Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.
com.google.cloud.vertexai.api.FeatureNoiseSigma.Builder Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.
com.google.cloud.vertexai.api.FeatureNoiseSigma.NoiseSigmaForFeature Noise sigma for a single feature.
com.google.cloud.vertexai.api.FeatureNoiseSigma.NoiseSigmaForFeature.Builder Noise sigma for a single feature.
com.google.cloud.vertexai.api.FileData URI based data.
com.google.cloud.vertexai.api.FileData.Builder URI based data.
com.google.cloud.vertexai.api.FunctionCall A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.
com.google.cloud.vertexai.api.FunctionCall.Builder A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.
com.google.cloud.vertexai.api.FunctionDeclaration Structured representation of a function declaration as defined by the OpenAPI 3.0 specification. Included in this declaration are the function name and parameters. This
com.google.cloud.vertexai.api.FunctionDeclaration.Builder Structured representation of a function declaration as defined by the OpenAPI 3.0 specification. Included in this declaration are the function name and parameters. This
com.google.cloud.vertexai.api.FunctionResponse The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain
com.google.cloud.vertexai.api.FunctionResponse.Builder The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain
com.google.cloud.vertexai.api.GcsDestination The Google Cloud Storage location where the output is to be written to.
com.google.cloud.vertexai.api.GcsDestination.Builder The Google Cloud Storage location where the output is to be written to.
com.google.cloud.vertexai.api.GcsSource The Google Cloud Storage location for the input content.
com.google.cloud.vertexai.api.GcsSource.Builder The Google Cloud Storage location for the input content.
com.google.cloud.vertexai.api.GenerateContentRequest Request message for [PredictionService.GenerateContent].
com.google.cloud.vertexai.api.GenerateContentRequest.Builder Request message for [PredictionService.GenerateContent].
com.google.cloud.vertexai.api.GenerateContentResponse Response message for [PredictionService.GenerateContent].
com.google.cloud.vertexai.api.GenerateContentResponse.Builder Response message for [PredictionService.GenerateContent].
com.google.cloud.vertexai.api.GenerateContentResponse.PromptFeedback Content filter results for a prompt sent in the request.
com.google.cloud.vertexai.api.GenerateContentResponse.PromptFeedback.Builder Content filter results for a prompt sent in the request.
com.google.cloud.vertexai.api.GenerateContentResponse.UsageMetadata Usage metadata about response(s).
com.google.cloud.vertexai.api.GenerateContentResponse.UsageMetadata.Builder Usage metadata about response(s).
com.google.cloud.vertexai.api.GenerationConfig Generation config.
com.google.cloud.vertexai.api.GenerationConfig.Builder Generation config.
com.google.cloud.vertexai.api.GenericOperationMetadata Generic Metadata shared by all operations.
com.google.cloud.vertexai.api.GenericOperationMetadata.Builder Generic Metadata shared by all operations.
com.google.cloud.vertexai.api.GetEndpointRequest Request message for EndpointService.GetEndpoint
com.google.cloud.vertexai.api.GetEndpointRequest.Builder Request message for EndpointService.GetEndpoint
com.google.cloud.vertexai.api.GoogleSearchRetrieval Tool to retrieve public web data for grounding, powered by Google.
com.google.cloud.vertexai.api.GoogleSearchRetrieval.Builder Tool to retrieve public web data for grounding, powered by Google.
com.google.cloud.vertexai.api.GroundingAttribution Grounding attribution.
com.google.cloud.vertexai.api.GroundingAttribution.Builder Grounding attribution.
com.google.cloud.vertexai.api.GroundingAttribution.Web Attribution from the web.
com.google.cloud.vertexai.api.GroundingAttribution.Web.Builder Attribution from the web.
com.google.cloud.vertexai.api.GroundingMetadata Metadata returned to client when grounding is enabled.
com.google.cloud.vertexai.api.GroundingMetadata.Builder Metadata returned to client when grounding is enabled.
com.google.cloud.vertexai.api.Int64Array A list of int64 values.
com.google.cloud.vertexai.api.Int64Array.Builder A list of int64 values.
com.google.cloud.vertexai.api.IntegratedGradientsAttribution An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
com.google.cloud.vertexai.api.IntegratedGradientsAttribution.Builder An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
com.google.cloud.vertexai.api.IoProto
com.google.cloud.vertexai.api.ListEndpointsRequest Request message for EndpointService.ListEndpoints.
com.google.cloud.vertexai.api.ListEndpointsRequest.Builder Request message for EndpointService.ListEndpoints.
com.google.cloud.vertexai.api.ListEndpointsResponse Response message for EndpointService.ListEndpoints.
com.google.cloud.vertexai.api.ListEndpointsResponse.Builder Response message for EndpointService.ListEndpoints.
com.google.cloud.vertexai.api.LlmUtilityServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.vertexai.api.LlmUtilityServiceClient.ListLocationsPage
com.google.cloud.vertexai.api.LlmUtilityServiceClient.ListLocationsPagedResponse
com.google.cloud.vertexai.api.LlmUtilityServiceGrpc Service for LLM related utility functions.
com.google.cloud.vertexai.api.LlmUtilityServiceGrpc.LlmUtilityServiceImplBase Base class for the server implementation of the service LlmUtilityService. Service for LLM related utility functions.
com.google.cloud.vertexai.api.LlmUtilityServiceProto
com.google.cloud.vertexai.api.LlmUtilityServiceSettings.Builder Builder for LlmUtilityServiceSettings.
com.google.cloud.vertexai.api.LocationName
com.google.cloud.vertexai.api.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.vertexai.api.MachineResourcesProto
com.google.cloud.vertexai.api.MachineSpec Specification of a single machine.
com.google.cloud.vertexai.api.MachineSpec.Builder Specification of a single machine.
com.google.cloud.vertexai.api.ModelExplanation Aggregated explanation metrics for a Model over a set of instances.
com.google.cloud.vertexai.api.ModelExplanation.Builder Aggregated explanation metrics for a Model over a set of instances.
com.google.cloud.vertexai.api.MutateDeployedModelOperationMetadata Runtime operation information for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.MutateDeployedModelOperationMetadata.Builder Runtime operation information for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.MutateDeployedModelRequest Request message for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.MutateDeployedModelRequest.Builder Request message for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.MutateDeployedModelResponse Response message for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.MutateDeployedModelResponse.Builder Response message for EndpointService.MutateDeployedModel.
com.google.cloud.vertexai.api.Neighbor Neighbors for example-based explanations.
com.google.cloud.vertexai.api.Neighbor.Builder Neighbors for example-based explanations.
com.google.cloud.vertexai.api.NfsMount Represents a mount configuration for Network File System (NFS) to mount.
com.google.cloud.vertexai.api.NfsMount.Builder Represents a mount configuration for Network File System (NFS) to mount.
com.google.cloud.vertexai.api.OpenApiProto
com.google.cloud.vertexai.api.OperationProto
com.google.cloud.vertexai.api.Part A datatype containing media that is part of a multi-part Content message. A Part consists of data which has an associated datatype. A Part can only
com.google.cloud.vertexai.api.Part.Builder A datatype containing media that is part of a multi-part Content message. A Part consists of data which has an associated datatype. A Part can only
com.google.cloud.vertexai.api.PersistentDiskSpec Represents the spec of persistent disk options.
com.google.cloud.vertexai.api.PersistentDiskSpec.Builder Represents the spec of persistent disk options.
com.google.cloud.vertexai.api.PredictRequest Request message for PredictionService.Predict.
com.google.cloud.vertexai.api.PredictRequest.Builder Request message for PredictionService.Predict.
com.google.cloud.vertexai.api.PredictRequestResponseLoggingConfig Configuration for logging request-response to a BigQuery table.
com.google.cloud.vertexai.api.PredictRequestResponseLoggingConfig.Builder Configuration for logging request-response to a BigQuery table.
com.google.cloud.vertexai.api.PredictResponse Response message for PredictionService.Predict.
com.google.cloud.vertexai.api.PredictResponse.Builder Response message for PredictionService.Predict.
com.google.cloud.vertexai.api.PredictionServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.vertexai.api.PredictionServiceClient.ListLocationsPage
com.google.cloud.vertexai.api.PredictionServiceClient.ListLocationsPagedResponse
com.google.cloud.vertexai.api.PredictionServiceGrpc A service for online predictions and explanations.
com.google.cloud.vertexai.api.PredictionServiceGrpc.PredictionServiceImplBase Base class for the server implementation of the service PredictionService. A service for online predictions and explanations.
com.google.cloud.vertexai.api.PredictionServiceProto
com.google.cloud.vertexai.api.PredictionServiceSettings.Builder Builder for PredictionServiceSettings.
com.google.cloud.vertexai.api.Presets Preset configuration for example-based explanations
com.google.cloud.vertexai.api.Presets.Builder Preset configuration for example-based explanations
com.google.cloud.vertexai.api.PrivateEndpoints PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri,
com.google.cloud.vertexai.api.PrivateEndpoints.Builder PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri,
com.google.cloud.vertexai.api.RawPredictRequest Request message for PredictionService.RawPredict.
com.google.cloud.vertexai.api.RawPredictRequest.Builder Request message for PredictionService.RawPredict.
com.google.cloud.vertexai.api.ResourcesConsumed Statistics information about resource consumption.
com.google.cloud.vertexai.api.ResourcesConsumed.Builder Statistics information about resource consumption.
com.google.cloud.vertexai.api.Retrieval Defines a retrieval tool that model can call to access external knowledge.
com.google.cloud.vertexai.api.Retrieval.Builder Defines a retrieval tool that model can call to access external knowledge.
com.google.cloud.vertexai.api.SafetyRating Safety rating corresponding to the generated content.
com.google.cloud.vertexai.api.SafetyRating.Builder Safety rating corresponding to the generated content.
com.google.cloud.vertexai.api.SafetySetting Safety settings.
com.google.cloud.vertexai.api.SafetySetting.Builder Safety settings.
com.google.cloud.vertexai.api.SampledShapleyAttribution An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
com.google.cloud.vertexai.api.SampledShapleyAttribution.Builder An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
com.google.cloud.vertexai.api.Schema Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be
com.google.cloud.vertexai.api.Schema.Builder Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be
com.google.cloud.vertexai.api.Segment Segment of the content.
com.google.cloud.vertexai.api.Segment.Builder Segment of the content.
com.google.cloud.vertexai.api.ShieldedVmConfig A set of Shielded Instance options. See Images using supported Shielded VM features.
com.google.cloud.vertexai.api.ShieldedVmConfig.Builder A set of Shielded Instance options. See Images using supported Shielded VM features.
com.google.cloud.vertexai.api.SmoothGradConfig Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from
com.google.cloud.vertexai.api.SmoothGradConfig.Builder Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from
com.google.cloud.vertexai.api.StreamDirectPredictRequest Request message for PredictionService.StreamDirectPredict.
com.google.cloud.vertexai.api.StreamDirectPredictRequest.Builder Request message for PredictionService.StreamDirectPredict.
com.google.cloud.vertexai.api.StreamDirectPredictResponse Response message for PredictionService.StreamDirectPredict.
com.google.cloud.vertexai.api.StreamDirectPredictResponse.Builder Response message for PredictionService.StreamDirectPredict.
com.google.cloud.vertexai.api.StreamDirectRawPredictRequest Request message for PredictionService.StreamDirectRawPredict.
com.google.cloud.vertexai.api.StreamDirectRawPredictRequest.Builder Request message for PredictionService.StreamDirectRawPredict.
com.google.cloud.vertexai.api.StreamDirectRawPredictResponse Response message for PredictionService.StreamDirectRawPredict.
com.google.cloud.vertexai.api.StreamDirectRawPredictResponse.Builder Response message for PredictionService.StreamDirectRawPredict.
com.google.cloud.vertexai.api.StreamRawPredictRequest Request message for PredictionService.StreamRawPredict.
com.google.cloud.vertexai.api.StreamRawPredictRequest.Builder Request message for PredictionService.StreamRawPredict.
com.google.cloud.vertexai.api.StreamingPredictRequest Request message for PredictionService.StreamingPredict.
com.google.cloud.vertexai.api.StreamingPredictRequest.Builder Request message for PredictionService.StreamingPredict.
com.google.cloud.vertexai.api.StreamingPredictResponse Response message for PredictionService.StreamingPredict.
com.google.cloud.vertexai.api.StreamingPredictResponse.Builder Response message for PredictionService.StreamingPredict.
com.google.cloud.vertexai.api.StreamingRawPredictRequest Request message for PredictionService.StreamingRawPredict.
com.google.cloud.vertexai.api.StreamingRawPredictRequest.Builder Request message for PredictionService.StreamingRawPredict.
com.google.cloud.vertexai.api.StreamingRawPredictResponse Response message for PredictionService.StreamingRawPredict.
com.google.cloud.vertexai.api.StreamingRawPredictResponse.Builder Response message for PredictionService.StreamingRawPredict.
com.google.cloud.vertexai.api.StringArray A list of string values.
com.google.cloud.vertexai.api.StringArray.Builder A list of string values.
com.google.cloud.vertexai.api.TFRecordDestination The storage details for TFRecord output content.
com.google.cloud.vertexai.api.TFRecordDestination.Builder The storage details for TFRecord output content.
com.google.cloud.vertexai.api.Tensor A tensor value type.
com.google.cloud.vertexai.api.Tensor.Builder A tensor value type.
com.google.cloud.vertexai.api.TokensInfo Tokens info with a list of tokens and the corresponding list of token ids.
com.google.cloud.vertexai.api.TokensInfo.Builder Tokens info with a list of tokens and the corresponding list of token ids.
com.google.cloud.vertexai.api.Tool Tool details that the model may use to generate response. A Tool is a piece of code that enables the system to interact with
com.google.cloud.vertexai.api.Tool.Builder Tool details that the model may use to generate response. A Tool is a piece of code that enables the system to interact with
com.google.cloud.vertexai.api.ToolProto
com.google.cloud.vertexai.api.TypesProto
com.google.cloud.vertexai.api.UndeployModelOperationMetadata Runtime operation information for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UndeployModelOperationMetadata.Builder Runtime operation information for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UndeployModelRequest Request message for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UndeployModelRequest.Builder Request message for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UndeployModelResponse Response message for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UndeployModelResponse.Builder Response message for EndpointService.UndeployModel.
com.google.cloud.vertexai.api.UpdateEndpointRequest Request message for EndpointService.UpdateEndpoint.
com.google.cloud.vertexai.api.UpdateEndpointRequest.Builder Request message for EndpointService.UpdateEndpoint.
com.google.cloud.vertexai.api.VertexAISearch Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation
com.google.cloud.vertexai.api.VertexAISearch.Builder Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation
com.google.cloud.vertexai.api.VideoMetadata Metadata describes the input video content.
com.google.cloud.vertexai.api.VideoMetadata.Builder Metadata describes the input video content.
com.google.cloud.vertexai.api.XraiAttribution An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details:
com.google.cloud.vertexai.api.XraiAttribution.Builder An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details:

Interfaces

Interface Description
com.google.cloud.vertexai.api.AttributionOrBuilder
com.google.cloud.vertexai.api.AutomaticResourcesOrBuilder
com.google.cloud.vertexai.api.AutoscalingMetricSpecOrBuilder
com.google.cloud.vertexai.api.AvroSourceOrBuilder
com.google.cloud.vertexai.api.BatchDedicatedResourcesOrBuilder
com.google.cloud.vertexai.api.BigQueryDestinationOrBuilder
com.google.cloud.vertexai.api.BigQuerySourceOrBuilder
com.google.cloud.vertexai.api.BlobOrBuilder
com.google.cloud.vertexai.api.BlurBaselineConfigOrBuilder
com.google.cloud.vertexai.api.BoolArrayOrBuilder
com.google.cloud.vertexai.api.CandidateOrBuilder
com.google.cloud.vertexai.api.CitationMetadataOrBuilder
com.google.cloud.vertexai.api.CitationOrBuilder
com.google.cloud.vertexai.api.ComputeTokensRequestOrBuilder
com.google.cloud.vertexai.api.ComputeTokensResponseOrBuilder
com.google.cloud.vertexai.api.ContainerRegistryDestinationOrBuilder
com.google.cloud.vertexai.api.ContentOrBuilder
com.google.cloud.vertexai.api.CountTokensRequestOrBuilder
com.google.cloud.vertexai.api.CountTokensResponseOrBuilder
com.google.cloud.vertexai.api.CreateEndpointOperationMetadataOrBuilder
com.google.cloud.vertexai.api.CreateEndpointRequestOrBuilder
com.google.cloud.vertexai.api.CsvDestinationOrBuilder
com.google.cloud.vertexai.api.CsvSourceOrBuilder
com.google.cloud.vertexai.api.DedicatedResourcesOrBuilder
com.google.cloud.vertexai.api.DeleteEndpointRequestOrBuilder
com.google.cloud.vertexai.api.DeleteOperationMetadataOrBuilder
com.google.cloud.vertexai.api.DeployModelOperationMetadataOrBuilder
com.google.cloud.vertexai.api.DeployModelRequestOrBuilder
com.google.cloud.vertexai.api.DeployModelResponseOrBuilder
com.google.cloud.vertexai.api.DeployedModelOrBuilder
com.google.cloud.vertexai.api.DirectPredictRequestOrBuilder
com.google.cloud.vertexai.api.DirectPredictResponseOrBuilder
com.google.cloud.vertexai.api.DirectRawPredictRequestOrBuilder
com.google.cloud.vertexai.api.DirectRawPredictResponseOrBuilder
com.google.cloud.vertexai.api.DiskSpecOrBuilder
com.google.cloud.vertexai.api.DoubleArrayOrBuilder
com.google.cloud.vertexai.api.EncryptionSpecOrBuilder
com.google.cloud.vertexai.api.EndpointOrBuilder
com.google.cloud.vertexai.api.EndpointServiceGrpc.AsyncService A service for managing Vertex AI's Endpoints.
com.google.cloud.vertexai.api.Examples.ExampleGcsSourceOrBuilder
com.google.cloud.vertexai.api.ExamplesOrBuilder
com.google.cloud.vertexai.api.ExamplesOverrideOrBuilder
com.google.cloud.vertexai.api.ExamplesRestrictionsNamespaceOrBuilder
com.google.cloud.vertexai.api.ExplainRequestOrBuilder
com.google.cloud.vertexai.api.ExplainResponseOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.FeatureValueDomainOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.VisualizationOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadataOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadata.OutputMetadataOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadataOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadataOverride.InputMetadataOverrideOrBuilder
com.google.cloud.vertexai.api.ExplanationMetadataOverrideOrBuilder
com.google.cloud.vertexai.api.ExplanationOrBuilder
com.google.cloud.vertexai.api.ExplanationParametersOrBuilder
com.google.cloud.vertexai.api.ExplanationSpecOrBuilder
com.google.cloud.vertexai.api.ExplanationSpecOverrideOrBuilder
com.google.cloud.vertexai.api.FeatureNoiseSigma.NoiseSigmaForFeatureOrBuilder
com.google.cloud.vertexai.api.FeatureNoiseSigmaOrBuilder
com.google.cloud.vertexai.api.FileDataOrBuilder
com.google.cloud.vertexai.api.FunctionCallOrBuilder
com.google.cloud.vertexai.api.FunctionDeclarationOrBuilder
com.google.cloud.vertexai.api.FunctionResponseOrBuilder
com.google.cloud.vertexai.api.GcsDestinationOrBuilder
com.google.cloud.vertexai.api.GcsSourceOrBuilder
com.google.cloud.vertexai.api.GenerateContentRequestOrBuilder
com.google.cloud.vertexai.api.GenerateContentResponse.PromptFeedbackOrBuilder
com.google.cloud.vertexai.api.GenerateContentResponse.UsageMetadataOrBuilder
com.google.cloud.vertexai.api.GenerateContentResponseOrBuilder
com.google.cloud.vertexai.api.GenerationConfigOrBuilder
com.google.cloud.vertexai.api.GenericOperationMetadataOrBuilder
com.google.cloud.vertexai.api.GetEndpointRequestOrBuilder
com.google.cloud.vertexai.api.GoogleSearchRetrievalOrBuilder
com.google.cloud.vertexai.api.GroundingAttribution.WebOrBuilder
com.google.cloud.vertexai.api.GroundingAttributionOrBuilder
com.google.cloud.vertexai.api.GroundingMetadataOrBuilder
com.google.cloud.vertexai.api.Int64ArrayOrBuilder
com.google.cloud.vertexai.api.IntegratedGradientsAttributionOrBuilder
com.google.cloud.vertexai.api.ListEndpointsRequestOrBuilder
com.google.cloud.vertexai.api.ListEndpointsResponseOrBuilder
com.google.cloud.vertexai.api.LlmUtilityServiceGrpc.AsyncService Service for LLM related utility functions.
com.google.cloud.vertexai.api.MachineSpecOrBuilder
com.google.cloud.vertexai.api.ModelExplanationOrBuilder
com.google.cloud.vertexai.api.MutateDeployedModelOperationMetadataOrBuilder
com.google.cloud.vertexai.api.MutateDeployedModelRequestOrBuilder
com.google.cloud.vertexai.api.MutateDeployedModelResponseOrBuilder
com.google.cloud.vertexai.api.NeighborOrBuilder
com.google.cloud.vertexai.api.NfsMountOrBuilder
com.google.cloud.vertexai.api.PartOrBuilder
com.google.cloud.vertexai.api.PersistentDiskSpecOrBuilder
com.google.cloud.vertexai.api.PredictRequestOrBuilder
com.google.cloud.vertexai.api.PredictRequestResponseLoggingConfigOrBuilder
com.google.cloud.vertexai.api.PredictResponseOrBuilder
com.google.cloud.vertexai.api.PredictionServiceGrpc.AsyncService A service for online predictions and explanations.
com.google.cloud.vertexai.api.PresetsOrBuilder
com.google.cloud.vertexai.api.PrivateEndpointsOrBuilder
com.google.cloud.vertexai.api.RawPredictRequestOrBuilder
com.google.cloud.vertexai.api.ResourcesConsumedOrBuilder
com.google.cloud.vertexai.api.RetrievalOrBuilder
com.google.cloud.vertexai.api.SafetyRatingOrBuilder
com.google.cloud.vertexai.api.SafetySettingOrBuilder
com.google.cloud.vertexai.api.SampledShapleyAttributionOrBuilder
com.google.cloud.vertexai.api.SchemaOrBuilder
com.google.cloud.vertexai.api.SegmentOrBuilder
com.google.cloud.vertexai.api.ShieldedVmConfigOrBuilder
com.google.cloud.vertexai.api.SmoothGradConfigOrBuilder
com.google.cloud.vertexai.api.StreamDirectPredictRequestOrBuilder
com.google.cloud.vertexai.api.StreamDirectPredictResponseOrBuilder
com.google.cloud.vertexai.api.StreamDirectRawPredictRequestOrBuilder
com.google.cloud.vertexai.api.StreamDirectRawPredictResponseOrBuilder
com.google.cloud.vertexai.api.StreamRawPredictRequestOrBuilder
com.google.cloud.vertexai.api.StreamingPredictRequestOrBuilder
com.google.cloud.vertexai.api.StreamingPredictResponseOrBuilder
com.google.cloud.vertexai.api.StreamingRawPredictRequestOrBuilder
com.google.cloud.vertexai.api.StreamingRawPredictResponseOrBuilder
com.google.cloud.vertexai.api.StringArrayOrBuilder
com.google.cloud.vertexai.api.TFRecordDestinationOrBuilder
com.google.cloud.vertexai.api.TensorOrBuilder
com.google.cloud.vertexai.api.TokensInfoOrBuilder
com.google.cloud.vertexai.api.ToolOrBuilder
com.google.cloud.vertexai.api.UndeployModelOperationMetadataOrBuilder
com.google.cloud.vertexai.api.UndeployModelRequestOrBuilder
com.google.cloud.vertexai.api.UndeployModelResponseOrBuilder
com.google.cloud.vertexai.api.UpdateEndpointRequestOrBuilder
com.google.cloud.vertexai.api.VertexAISearchOrBuilder
com.google.cloud.vertexai.api.VideoMetadataOrBuilder
com.google.cloud.vertexai.api.XraiAttributionOrBuilder

Enums

Enum Description
com.google.cloud.vertexai.api.AcceleratorType Represents a hardware accelerator type.
com.google.cloud.vertexai.api.Candidate.FinishReason The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
com.google.cloud.vertexai.api.DeployedModel.PredictionResourcesCase
com.google.cloud.vertexai.api.Examples.ConfigCase
com.google.cloud.vertexai.api.Examples.ExampleGcsSource.DataFormat The format of the input example instances.
com.google.cloud.vertexai.api.Examples.SourceCase
com.google.cloud.vertexai.api.ExamplesOverride.DataFormat Data format enum.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Encoding Defines how a feature is encoded. Defaults to IDENTITY.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization.ColorMap The color scheme used for highlighting areas.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization.OverlayType How the original image is displayed in the visualization.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization.Polarity Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
com.google.cloud.vertexai.api.ExplanationMetadata.InputMetadata.Visualization.Type Type of the image visualization. Only applicable to Integrated Gradients attribution.
com.google.cloud.vertexai.api.ExplanationMetadata.OutputMetadata.DisplayNameMappingCase
com.google.cloud.vertexai.api.ExplanationParameters.MethodCase
com.google.cloud.vertexai.api.GenerateContentResponse.PromptFeedback.BlockedReason Blocked reason enumeration.
com.google.cloud.vertexai.api.GroundingAttribution.ReferenceCase
com.google.cloud.vertexai.api.HarmCategory Harm categories that will block the content.
com.google.cloud.vertexai.api.Part.DataCase
com.google.cloud.vertexai.api.Part.MetadataCase
com.google.cloud.vertexai.api.Presets.Modality Preset option controlling parameters for different modalities
com.google.cloud.vertexai.api.Presets.Query Preset option controlling parameters for query speed-precision trade-off
com.google.cloud.vertexai.api.Retrieval.SourceCase
com.google.cloud.vertexai.api.SafetyRating.HarmProbability Harm probability levels in the content.
com.google.cloud.vertexai.api.SafetyRating.HarmSeverity Harm severity levels.
com.google.cloud.vertexai.api.SafetySetting.HarmBlockMethod Probability vs severity.
com.google.cloud.vertexai.api.SafetySetting.HarmBlockThreshold Probability based thresholds levels for blocking.
com.google.cloud.vertexai.api.SmoothGradConfig.GradientNoiseSigmaCase
com.google.cloud.vertexai.api.Tensor.DataType Data type of the tensor.
com.google.cloud.vertexai.api.Type Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/