cloud.google.com/go/aiplatform@v1.106.0/apiv1/doc.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated by protoc-gen-go_gapic. DO NOT EDIT.
    16  
    17  // Package aiplatform is an auto-generated package for the
    18  // Vertex AI API.
    19  //
    20  // Train high-quality custom machine learning models with minimal machine
    21  // learning expertise and effort.
    22  //
    23  // # General documentation
    24  //
    25  // For information that is relevant for all client libraries please reference
    26  // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
    27  // page includes:
    28  //
    29  //   - [Authentication and Authorization]
    30  //   - [Timeouts and Cancellation]
    31  //   - [Testing against Client Libraries]
    32  //   - [Debugging Client Libraries]
    33  //   - [Inspecting errors]
    34  //
    35  // # Example usage
    36  //
    37  // To get started with this package, create a client.
    38  //
    39  //	// go get cloud.google.com/go/aiplatform/apiv1@latest
    40  //	ctx := context.Background()
    41  //	// This snippet has been automatically generated and should be regarded as a code template only.
    42  //	// It will require modifications to work:
    43  //	// - It may require correct/in-range values for request initialization.
    44  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    45  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    46  //	c, err := aiplatform.NewDataFoundryClient(ctx)
    47  //	if err != nil {
    48  //		// TODO: Handle error.
    49  //	}
    50  //	defer c.Close()
    51  //
    52  // The client will use your default application credentials. Clients should be reused instead of created as needed.
    53  // The methods of Client are safe for concurrent use by multiple goroutines.
    54  // The returned client must be Closed when it is done being used.
    55  //
    56  // # Using the Client
    57  //
    58  // The following is an example of making an API call with the newly created client, mentioned above.
    59  //
    60  //	req := &aiplatformpb.GenerateSyntheticDataRequest{
    61  //		// TODO: Fill request struct fields.
    62  //		// See https://pkg.go.dev/cloud.google.com/go/aiplatform/apiv1/aiplatformpb#GenerateSyntheticDataRequest.
    63  //	}
    64  //	resp, err := c.GenerateSyntheticData(ctx, req)
    65  //	if err != nil {
    66  //		// TODO: Handle error.
    67  //	}
    68  //	// TODO: Use resp.
    69  //	_ = resp
    70  //
    71  // # Use of Context
    72  //
    73  // The ctx passed to NewDataFoundryClient is used for authentication requests and
    74  // for creating the underlying connection, but is not used for subsequent calls.
    75  // Individual methods on the client use the ctx given to them.
    76  //
    77  // To close the open connection, use the Close() method.
    78  //
    79  // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
    80  // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
    81  // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
    82  // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
    83  // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
    84  package aiplatform // import "cloud.google.com/go/aiplatform/apiv1"