Skip to content

Commit

Permalink
docs: [vertexai] Update javadoc of VertexAI and Transport. (#10296)
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 602404969

Co-authored-by: Zhenyi Qi <zhenyiqi@google.com>
  • Loading branch information
copybara-service[bot] and ZhenyiQ committed Jan 31, 2024
1 parent e87ef32 commit 2729b0b
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@

/** Transport used for sending request. */
public enum Transport {
/** When used, the clients will send REST requests to the backing service. */
REST,
/**
* When used, the clients will send gRPC to the backing service. This is usually more efficient
* and is the default transport.
*/
GRPC
}
Original file line number Diff line number Diff line change
Expand Up @@ -123,27 +123,48 @@ public VertexAI(String projectId, String location, Transport transport, String..
this.transport = transport;
}

/** Returns the default {@link Transport} layer to use to send API requests. */
/**
* Returns the default {@link Transport} layer to use to send API requests.
*
* @return {@link Transport} layer used when sending API requests.
*/
public Transport getTransport() {
return this.transport;
}

/** Returns the default project to use when making API calls. */
/**
* Returns the default project to use when making API calls.
*
* @return Project ID in string format.
*/
public String getProjectId() {
return this.projectId;
}

/** Returns the default location to use when making API calls. */
/**
* Returns the default location to use when making API calls.
*
* @return Location in string format.
*/
public String getLocation() {
return this.location;
}

/** Returns the default endpoint to use when making API calls. */
/**
* Returns the default endpoint to use when making API calls.
*
* @return API endpoint in string format.
*/
public String getApiEndpoint() {
return this.apiEndpoint;
}

/** Returns the default credentials to use when making API calls. */
/**
* Returns the default credentials to use when making API calls.
*
* @return {@link Credentials} if the user has provided either scopes or credentials to the
* VertexAI object.
*/
public Credentials getCredentials() throws IOException {
return credentialsProvider.getCredentials();
}
Expand Down Expand Up @@ -211,6 +232,9 @@ public PredictionServiceClient getPredictionServiceClient() throws IOException {
/**
* Returns the {@link PredictionServiceClient} with REST. The client will be instantiated when the
* first prediction API call is made.
*
* @return {@link PredictionServiceClient} that send REST requests to the backing service through
* method calls that map to the API methods.
*/
public PredictionServiceClient getPredictionServiceRestClient() throws IOException {
if (predictionServiceRestClient == null) {
Expand Down Expand Up @@ -240,8 +264,11 @@ public PredictionServiceClient getPredictionServiceRestClient() throws IOExcepti
}

/**
* Returns the {@link PredictionServiceClient} with GRPC. The client will be instantiated when the
* Returns the {@link LlmUtilityServiceClient} with GRPC. The client will be instantiated when the
* first prediction API call is made.
*
* @return {@link LlmUtilityServiceClient} that makes gRPC calls to the backing service through
* method calls that map to the API methods.
*/
public LlmUtilityServiceClient getLlmUtilityClient() throws IOException {
if (llmUtilityClient == null) {
Expand Down Expand Up @@ -270,8 +297,11 @@ public LlmUtilityServiceClient getLlmUtilityClient() throws IOException {
}

/**
* Returns the {@link PredictionServiceClient} with GRPC. The client will be instantiated when the
* Returns the {@link LlmUtilityServiceClient} with REST. The client will be instantiated when the
* first prediction API call is made.
*
* @return {@link LlmUtilityServiceClient} that makes REST requests to the backing service through
* method calls that map to the API methods.
*/
public LlmUtilityServiceClient getLlmUtilityRestClient() throws IOException {
if (llmUtilityRestClient == null) {
Expand Down

0 comments on commit 2729b0b

Please sign in to comment.