Package generativelanguage is an auto-generated package for the Generative Language API.
The Gemini API allows developers to build generative AI applications using Gemini models. Gemini is our most capable model, built from the ground up to be multimodal. It can generalize and seamlessly understand, operate across, and combine different types of information including language, images, audio, video, and code. You can use the Gemini API for use cases like reasoning across text and images, content generation, dialogue agents, summarization and classification systems, and more.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/ai/generativelanguage/apiv1alpha@latest ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := generativelanguage.NewCacheClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := &generativelanguagepb.CreateCachedContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateCachedContentRequest. } resp, err := c.CreateCachedContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewCacheClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
CacheCallOptions
type CacheCallOptions struct {
ListCachedContents []gax.CallOption
CreateCachedContent []gax.CallOption
GetCachedContent []gax.CallOption
UpdateCachedContent []gax.CallOption
DeleteCachedContent []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}CacheCallOptions contains the retry settings for each method of CacheClient.
CacheClient
type CacheClient struct {
// The call options for this service.
CallOptions *CacheCallOptions
// contains filtered or unexported fields
}CacheClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
API for managing cache of content (CachedContent resources) that can be used in GenerativeService requests. This way generate content requests can benefit from preprocessing work being done earlier, possibly lowering their computational cost. It is intended to be used with large contexts.
func NewCacheClient
func NewCacheClient(ctx context.Context, opts ...option.ClientOption) (*CacheClient, error)NewCacheClient creates a new cache service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
API for managing cache of content (CachedContent resources) that can be used in GenerativeService requests. This way generate content requests can benefit from preprocessing work being done earlier, possibly lowering their computational cost. It is intended to be used with large contexts.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewCacheRESTClient
func NewCacheRESTClient(ctx context.Context, opts ...option.ClientOption) (*CacheClient, error)NewCacheRESTClient creates a new cache service rest client.
API for managing cache of content (CachedContent resources) that can be used in GenerativeService requests. This way generate content requests can benefit from preprocessing work being done earlier, possibly lowering their computational cost. It is intended to be used with large contexts.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*CacheClient) Close
func (c *CacheClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CacheClient) Connection (deprecated)
func (c *CacheClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*CacheClient) CreateCachedContent
func (c *CacheClient) CreateCachedContent(ctx context.Context, req *generativelanguagepb.CreateCachedContentRequest, opts ...gax.CallOption) (*generativelanguagepb.CachedContent, error)CreateCachedContent creates CachedContent resource.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateCachedContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateCachedContentRequest.
}
resp, err := c.CreateCachedContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CacheClient) DeleteCachedContent
func (c *CacheClient) DeleteCachedContent(ctx context.Context, req *generativelanguagepb.DeleteCachedContentRequest, opts ...gax.CallOption) errorDeleteCachedContent deletes CachedContent resource.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteCachedContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteCachedContentRequest.
}
err = c.DeleteCachedContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*CacheClient) GetCachedContent
func (c *CacheClient) GetCachedContent(ctx context.Context, req *generativelanguagepb.GetCachedContentRequest, opts ...gax.CallOption) (*generativelanguagepb.CachedContent, error)GetCachedContent reads CachedContent resource.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetCachedContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetCachedContentRequest.
}
resp, err := c.GetCachedContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CacheClient) GetOperation
func (c *CacheClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CacheClient) ListCachedContents
func (c *CacheClient) ListCachedContents(ctx context.Context, req *generativelanguagepb.ListCachedContentsRequest, opts ...gax.CallOption) *CachedContentIteratorListCachedContents lists CachedContents.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListCachedContentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListCachedContentsRequest.
}
it := c.ListCachedContents(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListCachedContentsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListCachedContentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListCachedContentsRequest.
}
for resp, err := range c.ListCachedContents(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*CacheClient) ListOperations
func (c *CacheClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*CacheClient) UpdateCachedContent
func (c *CacheClient) UpdateCachedContent(ctx context.Context, req *generativelanguagepb.UpdateCachedContentRequest, opts ...gax.CallOption) (*generativelanguagepb.CachedContent, error)UpdateCachedContent updates CachedContent resource (only expiration is updatable).
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewCacheClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdateCachedContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdateCachedContentRequest.
}
resp, err := c.UpdateCachedContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CachedContentIterator
type CachedContentIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.CachedContent, nextPageToken string, err error)
// contains filtered or unexported fields
}CachedContentIterator manages a stream of *generativelanguagepb.CachedContent.
func (*CachedContentIterator) All
func (it *CachedContentIterator) All() iter.Seq2[*generativelanguagepb.CachedContent, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*CachedContentIterator) Next
func (it *CachedContentIterator) Next() (*generativelanguagepb.CachedContent, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CachedContentIterator) PageInfo
func (it *CachedContentIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ChunkIterator
type ChunkIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.Chunk, nextPageToken string, err error)
// contains filtered or unexported fields
}ChunkIterator manages a stream of *generativelanguagepb.Chunk.
func (*ChunkIterator) All
func (it *ChunkIterator) All() iter.Seq2[*generativelanguagepb.Chunk, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ChunkIterator) Next
func (it *ChunkIterator) Next() (*generativelanguagepb.Chunk, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ChunkIterator) PageInfo
func (it *ChunkIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CorpusIterator
type CorpusIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.Corpus, nextPageToken string, err error)
// contains filtered or unexported fields
}CorpusIterator manages a stream of *generativelanguagepb.Corpus.
func (*CorpusIterator) All
func (it *CorpusIterator) All() iter.Seq2[*generativelanguagepb.Corpus, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*CorpusIterator) Next
func (it *CorpusIterator) Next() (*generativelanguagepb.Corpus, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CorpusIterator) PageInfo
func (it *CorpusIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CreateTunedModelOperation
type CreateTunedModelOperation struct {
// contains filtered or unexported fields
}CreateTunedModelOperation manages a long-running operation from CreateTunedModel.
func (*CreateTunedModelOperation) Done
func (op *CreateTunedModelOperation) Done() boolDone reports whether the long-running operation has completed.
func (*CreateTunedModelOperation) Metadata
func (op *CreateTunedModelOperation) Metadata() (*generativelanguagepb.CreateTunedModelMetadata, error)Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateTunedModelOperation) Name
func (op *CreateTunedModelOperation) Name() stringName returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateTunedModelOperation) Poll
func (op *CreateTunedModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*generativelanguagepb.TunedModel, error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateTunedModelOperation) Wait
func (op *CreateTunedModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*generativelanguagepb.TunedModel, error)Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DiscussCallOptions
type DiscussCallOptions struct {
GenerateMessage []gax.CallOption
CountMessageTokens []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}DiscussCallOptions contains the retry settings for each method of DiscussClient.
DiscussClient
type DiscussClient struct {
// The call options for this service.
CallOptions *DiscussCallOptions
// contains filtered or unexported fields
}DiscussClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
An API for using Generative Language Models (GLMs) in dialog applications.
Also known as large language models (LLMs), this API provides models that are trained for multi-turn dialog.
func NewDiscussClient
func NewDiscussClient(ctx context.Context, opts ...option.ClientOption) (*DiscussClient, error)NewDiscussClient creates a new discuss service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
An API for using Generative Language Models (GLMs) in dialog applications.
Also known as large language models (LLMs), this API provides models that are trained for multi-turn dialog.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewDiscussRESTClient
func NewDiscussRESTClient(ctx context.Context, opts ...option.ClientOption) (*DiscussClient, error)NewDiscussRESTClient creates a new discuss service rest client.
An API for using Generative Language Models (GLMs) in dialog applications.
Also known as large language models (LLMs), this API provides models that are trained for multi-turn dialog.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*DiscussClient) Close
func (c *DiscussClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DiscussClient) Connection (deprecated)
func (c *DiscussClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DiscussClient) CountMessageTokens
func (c *DiscussClient) CountMessageTokens(ctx context.Context, req *generativelanguagepb.CountMessageTokensRequest, opts ...gax.CallOption) (*generativelanguagepb.CountMessageTokensResponse, error)CountMessageTokens runs a model’s tokenizer on a string and returns the token count.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CountMessageTokensRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CountMessageTokensRequest.
}
resp, err := c.CountMessageTokens(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DiscussClient) GenerateMessage
func (c *DiscussClient) GenerateMessage(ctx context.Context, req *generativelanguagepb.GenerateMessageRequest, opts ...gax.CallOption) (*generativelanguagepb.GenerateMessageResponse, error)GenerateMessage generates a response from the model given an input MessagePrompt.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GenerateMessageRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GenerateMessageRequest.
}
resp, err := c.GenerateMessage(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DiscussClient) GetOperation
func (c *DiscussClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DiscussClient) ListOperations
func (c *DiscussClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewDiscussClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
DocumentIterator
type DocumentIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.Document, nextPageToken string, err error)
// contains filtered or unexported fields
}DocumentIterator manages a stream of *generativelanguagepb.Document.
func (*DocumentIterator) All
func (it *DocumentIterator) All() iter.Seq2[*generativelanguagepb.Document, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*DocumentIterator) Next
func (it *DocumentIterator) Next() (*generativelanguagepb.Document, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DocumentIterator) PageInfo
func (it *DocumentIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
FileCallOptions
type FileCallOptions struct {
CreateFile []gax.CallOption
ListFiles []gax.CallOption
GetFile []gax.CallOption
DeleteFile []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}FileCallOptions contains the retry settings for each method of FileClient.
FileClient
type FileClient struct {
// The call options for this service.
CallOptions *FileCallOptions
// contains filtered or unexported fields
}FileClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
An API for uploading and managing files.
func NewFileClient
func NewFileClient(ctx context.Context, opts ...option.ClientOption) (*FileClient, error)NewFileClient creates a new file service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
An API for uploading and managing files.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewFileRESTClient
func NewFileRESTClient(ctx context.Context, opts ...option.ClientOption) (*FileClient, error)NewFileRESTClient creates a new file service rest client.
An API for uploading and managing files.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*FileClient) Close
func (c *FileClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*FileClient) Connection (deprecated)
func (c *FileClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*FileClient) CreateFile
func (c *FileClient) CreateFile(ctx context.Context, req *generativelanguagepb.CreateFileRequest, opts ...gax.CallOption) (*generativelanguagepb.CreateFileResponse, error)CreateFile creates a File.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateFileRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateFileRequest.
}
resp, err := c.CreateFile(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*FileClient) DeleteFile
func (c *FileClient) DeleteFile(ctx context.Context, req *generativelanguagepb.DeleteFileRequest, opts ...gax.CallOption) errorDeleteFile deletes the File.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteFileRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteFileRequest.
}
err = c.DeleteFile(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*FileClient) GetFile
func (c *FileClient) GetFile(ctx context.Context, req *generativelanguagepb.GetFileRequest, opts ...gax.CallOption) (*generativelanguagepb.File, error)GetFile gets the metadata for the given File.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetFileRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetFileRequest.
}
resp, err := c.GetFile(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*FileClient) GetOperation
func (c *FileClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*FileClient) ListFiles
func (c *FileClient) ListFiles(ctx context.Context, req *generativelanguagepb.ListFilesRequest, opts ...gax.CallOption) *FileIteratorListFiles lists the metadata for Files owned by the requesting project.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListFilesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListFilesRequest.
}
it := c.ListFiles(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListFilesResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListFilesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListFilesRequest.
}
for resp, err := range c.ListFiles(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*FileClient) ListOperations
func (c *FileClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewFileClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
FileIterator
type FileIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.File, nextPageToken string, err error)
// contains filtered or unexported fields
}FileIterator manages a stream of *generativelanguagepb.File.
func (*FileIterator) All
func (it *FileIterator) All() iter.Seq2[*generativelanguagepb.File, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*FileIterator) Next
func (it *FileIterator) Next() (*generativelanguagepb.File, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*FileIterator) PageInfo
func (it *FileIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
GenerativeCallOptions
type GenerativeCallOptions struct {
GenerateContent []gax.CallOption
GenerateAnswer []gax.CallOption
StreamGenerateContent []gax.CallOption
EmbedContent []gax.CallOption
BatchEmbedContents []gax.CallOption
CountTokens []gax.CallOption
BidiGenerateContent []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}GenerativeCallOptions contains the retry settings for each method of GenerativeClient.
GenerativeClient
type GenerativeClient struct {
// The call options for this service.
CallOptions *GenerativeCallOptions
// contains filtered or unexported fields
}GenerativeClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
API for using Large Models that generate multimodal content and have additional capabilities beyond text generation.
func NewGenerativeClient
func NewGenerativeClient(ctx context.Context, opts ...option.ClientOption) (*GenerativeClient, error)NewGenerativeClient creates a new generative service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
API for using Large Models that generate multimodal content and have additional capabilities beyond text generation.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewGenerativeRESTClient
func NewGenerativeRESTClient(ctx context.Context, opts ...option.ClientOption) (*GenerativeClient, error)NewGenerativeRESTClient creates a new generative service rest client.
API for using Large Models that generate multimodal content and have additional capabilities beyond text generation.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*GenerativeClient) BatchEmbedContents
func (c *GenerativeClient) BatchEmbedContents(ctx context.Context, req *generativelanguagepb.BatchEmbedContentsRequest, opts ...gax.CallOption) (*generativelanguagepb.BatchEmbedContentsResponse, error)BatchEmbedContents generates multiple embedding vectors from the input Content which consists of a batch of strings represented as EmbedContentRequest objects.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.BatchEmbedContentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#BatchEmbedContentsRequest.
}
resp, err := c.BatchEmbedContents(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) BidiGenerateContent
func (c *GenerativeClient) BidiGenerateContent(ctx context.Context, opts ...gax.CallOption) (generativelanguagepb.GenerativeService_BidiGenerateContentClient, error)BidiGenerateContent low-Latency bidirectional streaming API that supports audio and video streaming inputs can produce multimodal output streams (audio and text).
This method is not supported for the REST transport.
Example
package main
import (
"context"
"io"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
stream, err := c.BidiGenerateContent(ctx)
if err != nil {
// TODO: Handle error.
}
go func() {
reqs := []*generativelanguagepb.BidiGenerateContentClientMessage{
// TODO: Create requests.
}
for _, req := range reqs {
if err := stream.Send(req); err != nil {
// TODO: Handle error.
}
}
stream.CloseSend()
}()
for {
resp, err := stream.Recv()
if err == io.EOF {
break
}
if err != nil {
// TODO: handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*GenerativeClient) Close
func (c *GenerativeClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*GenerativeClient) Connection (deprecated)
func (c *GenerativeClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*GenerativeClient) CountTokens
func (c *GenerativeClient) CountTokens(ctx context.Context, req *generativelanguagepb.CountTokensRequest, opts ...gax.CallOption) (*generativelanguagepb.CountTokensResponse, error)CountTokens runs a model’s tokenizer on input Content and returns the token count. Refer to the tokens guide (at https://ai.google.dev/gemini-api/docs/tokens) to learn more about tokens.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CountTokensRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CountTokensRequest.
}
resp, err := c.CountTokens(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) EmbedContent
func (c *GenerativeClient) EmbedContent(ctx context.Context, req *generativelanguagepb.EmbedContentRequest, opts ...gax.CallOption) (*generativelanguagepb.EmbedContentResponse, error)EmbedContent generates a text embedding vector from the input Content using the specified Gemini Embedding model (at https://ai.google.dev/gemini-api/docs/models/gemini#text-embedding).
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.EmbedContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#EmbedContentRequest.
}
resp, err := c.EmbedContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) GenerateAnswer
func (c *GenerativeClient) GenerateAnswer(ctx context.Context, req *generativelanguagepb.GenerateAnswerRequest, opts ...gax.CallOption) (*generativelanguagepb.GenerateAnswerResponse, error)GenerateAnswer generates a grounded answer from the model given an input GenerateAnswerRequest.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GenerateAnswerRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GenerateAnswerRequest.
}
resp, err := c.GenerateAnswer(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) GenerateContent
func (c *GenerativeClient) GenerateContent(ctx context.Context, req *generativelanguagepb.GenerateContentRequest, opts ...gax.CallOption) (*generativelanguagepb.GenerateContentResponse, error)GenerateContent generates a model response given an input GenerateContentRequest. Refer to the text generation guide (at https://ai.google.dev/gemini-api/docs/text-generation) for detailed usage information. Input capabilities differ between models, including tuned models. Refer to the model guide (at https://ai.google.dev/gemini-api/docs/models/gemini) and tuning guide (at https://ai.google.dev/gemini-api/docs/model-tuning) for details.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GenerateContentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GenerateContentRequest.
}
resp, err := c.GenerateContent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) GetOperation
func (c *GenerativeClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*GenerativeClient) ListOperations
func (c *GenerativeClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewGenerativeClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*GenerativeClient) StreamGenerateContent
func (c *GenerativeClient) StreamGenerateContent(ctx context.Context, req *generativelanguagepb.GenerateContentRequest, opts ...gax.CallOption) (generativelanguagepb.GenerativeService_StreamGenerateContentClient, error)StreamGenerateContent generates a streamed response (at https://ai.google.dev/gemini-api/docs/text-generation?lang=python#generate-a-text-stream) from the model given an input GenerateContentRequest.
ModelCallOptions
type ModelCallOptions struct {
GetModel []gax.CallOption
ListModels []gax.CallOption
GetTunedModel []gax.CallOption
ListTunedModels []gax.CallOption
CreateTunedModel []gax.CallOption
UpdateTunedModel []gax.CallOption
DeleteTunedModel []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}ModelCallOptions contains the retry settings for each method of ModelClient.
ModelClient
type ModelClient struct {
// The call options for this service.
CallOptions *ModelCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient *lroauto.OperationsClient
// contains filtered or unexported fields
}ModelClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Provides methods for getting metadata information about Generative Models.
func NewModelClient
func NewModelClient(ctx context.Context, opts ...option.ClientOption) (*ModelClient, error)NewModelClient creates a new model service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Provides methods for getting metadata information about Generative Models.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewModelRESTClient
func NewModelRESTClient(ctx context.Context, opts ...option.ClientOption) (*ModelClient, error)NewModelRESTClient creates a new model service rest client.
Provides methods for getting metadata information about Generative Models.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*ModelClient) Close
func (c *ModelClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ModelClient) Connection (deprecated)
func (c *ModelClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*ModelClient) CreateTunedModel
func (c *ModelClient) CreateTunedModel(ctx context.Context, req *generativelanguagepb.CreateTunedModelRequest, opts ...gax.CallOption) (*CreateTunedModelOperation, error)CreateTunedModel creates a tuned model. Check intermediate tuning progress (if any) through the [google.longrunning.Operations] service.
Access status and results through the Operations service. Example: GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateTunedModelRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateTunedModelRequest.
}
op, err := c.CreateTunedModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) CreateTunedModelOperation
func (c *ModelClient) CreateTunedModelOperation(name string) *CreateTunedModelOperationCreateTunedModelOperation returns a new CreateTunedModelOperation from a given name. The name must be that of a previously created CreateTunedModelOperation, possibly from a different process.
func (*ModelClient) DeleteTunedModel
func (c *ModelClient) DeleteTunedModel(ctx context.Context, req *generativelanguagepb.DeleteTunedModelRequest, opts ...gax.CallOption) errorDeleteTunedModel deletes a tuned model.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteTunedModelRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteTunedModelRequest.
}
err = c.DeleteTunedModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*ModelClient) GetModel
func (c *ModelClient) GetModel(ctx context.Context, req *generativelanguagepb.GetModelRequest, opts ...gax.CallOption) (*generativelanguagepb.Model, error)GetModel gets information about a specific Model such as its version number, token limits, parameters (at https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters) and other metadata. Refer to the Gemini models guide (at https://ai.google.dev/gemini-api/docs/models/gemini) for detailed model information.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetModelRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetModelRequest.
}
resp, err := c.GetModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) GetOperation
func (c *ModelClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) GetTunedModel
func (c *ModelClient) GetTunedModel(ctx context.Context, req *generativelanguagepb.GetTunedModelRequest, opts ...gax.CallOption) (*generativelanguagepb.TunedModel, error)GetTunedModel gets information about a specific TunedModel.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetTunedModelRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetTunedModelRequest.
}
resp, err := c.GetTunedModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) ListModels
func (c *ModelClient) ListModels(ctx context.Context, req *generativelanguagepb.ListModelsRequest, opts ...gax.CallOption) *ModelIteratorListModels lists the Models (at https://ai.google.dev/gemini-api/docs/models/gemini) available through the Gemini API.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListModelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListModelsRequest.
}
it := c.ListModels(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListModelsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListModelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListModelsRequest.
}
for resp, err := range c.ListModels(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) ListOperations
func (c *ModelClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) ListTunedModels
func (c *ModelClient) ListTunedModels(ctx context.Context, req *generativelanguagepb.ListTunedModelsRequest, opts ...gax.CallOption) *TunedModelIteratorListTunedModels lists created tuned models.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListTunedModelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListTunedModelsRequest.
}
it := c.ListTunedModels(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListTunedModelsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListTunedModelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListTunedModelsRequest.
}
for resp, err := range c.ListTunedModels(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) UpdateTunedModel
func (c *ModelClient) UpdateTunedModel(ctx context.Context, req *generativelanguagepb.UpdateTunedModelRequest, opts ...gax.CallOption) (*generativelanguagepb.TunedModel, error)UpdateTunedModel updates a tuned model.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdateTunedModelRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdateTunedModelRequest.
}
resp, err := c.UpdateTunedModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
ModelIterator
type ModelIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.Model, nextPageToken string, err error)
// contains filtered or unexported fields
}ModelIterator manages a stream of *generativelanguagepb.Model.
func (*ModelIterator) All
func (it *ModelIterator) All() iter.Seq2[*generativelanguagepb.Model, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ModelIterator) Next
func (it *ModelIterator) Next() (*generativelanguagepb.Model, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ModelIterator) PageInfo
func (it *ModelIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
OperationIterator
type OperationIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error)
// contains filtered or unexported fields
}OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next
func (it *OperationIterator) Next() (*longrunningpb.Operation, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func (it *OperationIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
PermissionCallOptions
type PermissionCallOptions struct {
CreatePermission []gax.CallOption
GetPermission []gax.CallOption
ListPermissions []gax.CallOption
UpdatePermission []gax.CallOption
DeletePermission []gax.CallOption
TransferOwnership []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}PermissionCallOptions contains the retry settings for each method of PermissionClient.
PermissionClient
type PermissionClient struct {
// The call options for this service.
CallOptions *PermissionCallOptions
// contains filtered or unexported fields
}PermissionClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Provides methods for managing permissions to PaLM API resources.
func NewPermissionClient
func NewPermissionClient(ctx context.Context, opts ...option.ClientOption) (*PermissionClient, error)NewPermissionClient creates a new permission service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Provides methods for managing permissions to PaLM API resources.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewPermissionRESTClient
func NewPermissionRESTClient(ctx context.Context, opts ...option.ClientOption) (*PermissionClient, error)NewPermissionRESTClient creates a new permission service rest client.
Provides methods for managing permissions to PaLM API resources.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*PermissionClient) Close
func (c *PermissionClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*PermissionClient) Connection (deprecated)
func (c *PermissionClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*PermissionClient) CreatePermission
func (c *PermissionClient) CreatePermission(ctx context.Context, req *generativelanguagepb.CreatePermissionRequest, opts ...gax.CallOption) (*generativelanguagepb.Permission, error)CreatePermission create a permission to a specific resource.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreatePermissionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreatePermissionRequest.
}
resp, err := c.CreatePermission(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PermissionClient) DeletePermission
func (c *PermissionClient) DeletePermission(ctx context.Context, req *generativelanguagepb.DeletePermissionRequest, opts ...gax.CallOption) errorDeletePermission deletes the permission.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeletePermissionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeletePermissionRequest.
}
err = c.DeletePermission(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*PermissionClient) GetOperation
func (c *PermissionClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PermissionClient) GetPermission
func (c *PermissionClient) GetPermission(ctx context.Context, req *generativelanguagepb.GetPermissionRequest, opts ...gax.CallOption) (*generativelanguagepb.Permission, error)GetPermission gets information about a specific Permission.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetPermissionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetPermissionRequest.
}
resp, err := c.GetPermission(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PermissionClient) ListOperations
func (c *PermissionClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*PermissionClient) ListPermissions
func (c *PermissionClient) ListPermissions(ctx context.Context, req *generativelanguagepb.ListPermissionsRequest, opts ...gax.CallOption) *PermissionIteratorListPermissions lists permissions for the specific resource.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListPermissionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListPermissionsRequest.
}
it := c.ListPermissions(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListPermissionsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListPermissionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListPermissionsRequest.
}
for resp, err := range c.ListPermissions(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*PermissionClient) TransferOwnership
func (c *PermissionClient) TransferOwnership(ctx context.Context, req *generativelanguagepb.TransferOwnershipRequest, opts ...gax.CallOption) (*generativelanguagepb.TransferOwnershipResponse, error)TransferOwnership transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.TransferOwnershipRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#TransferOwnershipRequest.
}
resp, err := c.TransferOwnership(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PermissionClient) UpdatePermission
func (c *PermissionClient) UpdatePermission(ctx context.Context, req *generativelanguagepb.UpdatePermissionRequest, opts ...gax.CallOption) (*generativelanguagepb.Permission, error)UpdatePermission updates the permission.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPermissionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdatePermissionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdatePermissionRequest.
}
resp, err := c.UpdatePermission(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
PermissionIterator
type PermissionIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.Permission, nextPageToken string, err error)
// contains filtered or unexported fields
}PermissionIterator manages a stream of *generativelanguagepb.Permission.
func (*PermissionIterator) All
func (it *PermissionIterator) All() iter.Seq2[*generativelanguagepb.Permission, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PermissionIterator) Next
func (it *PermissionIterator) Next() (*generativelanguagepb.Permission, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*PermissionIterator) PageInfo
func (it *PermissionIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
PredictionCallOptions
type PredictionCallOptions struct {
Predict []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}PredictionCallOptions contains the retry settings for each method of PredictionClient.
PredictionClient
type PredictionClient struct {
// The call options for this service.
CallOptions *PredictionCallOptions
// contains filtered or unexported fields
}PredictionClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for online predictions and explanations.
func NewPredictionClient
func NewPredictionClient(ctx context.Context, opts ...option.ClientOption) (*PredictionClient, error)NewPredictionClient creates a new prediction service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for online predictions and explanations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewPredictionRESTClient
func NewPredictionRESTClient(ctx context.Context, opts ...option.ClientOption) (*PredictionClient, error)NewPredictionRESTClient creates a new prediction service rest client.
A service for online predictions and explanations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*PredictionClient) Close
func (c *PredictionClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*PredictionClient) Connection (deprecated)
func (c *PredictionClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*PredictionClient) GetOperation
func (c *PredictionClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PredictionClient) ListOperations
func (c *PredictionClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*PredictionClient) Predict
func (c *PredictionClient) Predict(ctx context.Context, req *generativelanguagepb.PredictRequest, opts ...gax.CallOption) (*generativelanguagepb.PredictResponse, error)Predict performs a prediction request.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.PredictRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#PredictRequest.
}
resp, err := c.Predict(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
RetrieverCallOptions
type RetrieverCallOptions struct {
CreateCorpus []gax.CallOption
GetCorpus []gax.CallOption
UpdateCorpus []gax.CallOption
DeleteCorpus []gax.CallOption
ListCorpora []gax.CallOption
QueryCorpus []gax.CallOption
CreateDocument []gax.CallOption
GetDocument []gax.CallOption
UpdateDocument []gax.CallOption
DeleteDocument []gax.CallOption
ListDocuments []gax.CallOption
QueryDocument []gax.CallOption
CreateChunk []gax.CallOption
BatchCreateChunks []gax.CallOption
GetChunk []gax.CallOption
UpdateChunk []gax.CallOption
BatchUpdateChunks []gax.CallOption
DeleteChunk []gax.CallOption
BatchDeleteChunks []gax.CallOption
ListChunks []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}RetrieverCallOptions contains the retry settings for each method of RetrieverClient.
RetrieverClient
type RetrieverClient struct {
// The call options for this service.
CallOptions *RetrieverCallOptions
// contains filtered or unexported fields
}RetrieverClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
An API for semantic search over a corpus of user uploaded content.
func NewRetrieverClient
func NewRetrieverClient(ctx context.Context, opts ...option.ClientOption) (*RetrieverClient, error)NewRetrieverClient creates a new retriever service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
An API for semantic search over a corpus of user uploaded content.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewRetrieverRESTClient
func NewRetrieverRESTClient(ctx context.Context, opts ...option.ClientOption) (*RetrieverClient, error)NewRetrieverRESTClient creates a new retriever service rest client.
An API for semantic search over a corpus of user uploaded content.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*RetrieverClient) BatchCreateChunks
func (c *RetrieverClient) BatchCreateChunks(ctx context.Context, req *generativelanguagepb.BatchCreateChunksRequest, opts ...gax.CallOption) (*generativelanguagepb.BatchCreateChunksResponse, error)BatchCreateChunks batch create Chunks.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.BatchCreateChunksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#BatchCreateChunksRequest.
}
resp, err := c.BatchCreateChunks(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) BatchDeleteChunks
func (c *RetrieverClient) BatchDeleteChunks(ctx context.Context, req *generativelanguagepb.BatchDeleteChunksRequest, opts ...gax.CallOption) errorBatchDeleteChunks batch delete Chunks.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.BatchDeleteChunksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#BatchDeleteChunksRequest.
}
err = c.BatchDeleteChunks(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*RetrieverClient) BatchUpdateChunks
func (c *RetrieverClient) BatchUpdateChunks(ctx context.Context, req *generativelanguagepb.BatchUpdateChunksRequest, opts ...gax.CallOption) (*generativelanguagepb.BatchUpdateChunksResponse, error)BatchUpdateChunks batch update Chunks.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.BatchUpdateChunksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#BatchUpdateChunksRequest.
}
resp, err := c.BatchUpdateChunks(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) Close
func (c *RetrieverClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*RetrieverClient) Connection (deprecated)
func (c *RetrieverClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*RetrieverClient) CreateChunk
func (c *RetrieverClient) CreateChunk(ctx context.Context, req *generativelanguagepb.CreateChunkRequest, opts ...gax.CallOption) (*generativelanguagepb.Chunk, error)CreateChunk creates a Chunk.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateChunkRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateChunkRequest.
}
resp, err := c.CreateChunk(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) CreateCorpus
func (c *RetrieverClient) CreateCorpus(ctx context.Context, req *generativelanguagepb.CreateCorpusRequest, opts ...gax.CallOption) (*generativelanguagepb.Corpus, error)CreateCorpus creates an empty Corpus.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateCorpusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateCorpusRequest.
}
resp, err := c.CreateCorpus(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) CreateDocument
func (c *RetrieverClient) CreateDocument(ctx context.Context, req *generativelanguagepb.CreateDocumentRequest, opts ...gax.CallOption) (*generativelanguagepb.Document, error)CreateDocument creates an empty Document.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CreateDocumentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CreateDocumentRequest.
}
resp, err := c.CreateDocument(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) DeleteChunk
func (c *RetrieverClient) DeleteChunk(ctx context.Context, req *generativelanguagepb.DeleteChunkRequest, opts ...gax.CallOption) errorDeleteChunk deletes a Chunk.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteChunkRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteChunkRequest.
}
err = c.DeleteChunk(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*RetrieverClient) DeleteCorpus
func (c *RetrieverClient) DeleteCorpus(ctx context.Context, req *generativelanguagepb.DeleteCorpusRequest, opts ...gax.CallOption) errorDeleteCorpus deletes a Corpus.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteCorpusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteCorpusRequest.
}
err = c.DeleteCorpus(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*RetrieverClient) DeleteDocument
func (c *RetrieverClient) DeleteDocument(ctx context.Context, req *generativelanguagepb.DeleteDocumentRequest, opts ...gax.CallOption) errorDeleteDocument deletes a Document.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.DeleteDocumentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#DeleteDocumentRequest.
}
err = c.DeleteDocument(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*RetrieverClient) GetChunk
func (c *RetrieverClient) GetChunk(ctx context.Context, req *generativelanguagepb.GetChunkRequest, opts ...gax.CallOption) (*generativelanguagepb.Chunk, error)GetChunk gets information about a specific Chunk.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetChunkRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetChunkRequest.
}
resp, err := c.GetChunk(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) GetCorpus
func (c *RetrieverClient) GetCorpus(ctx context.Context, req *generativelanguagepb.GetCorpusRequest, opts ...gax.CallOption) (*generativelanguagepb.Corpus, error)GetCorpus gets information about a specific Corpus.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetCorpusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetCorpusRequest.
}
resp, err := c.GetCorpus(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) GetDocument
func (c *RetrieverClient) GetDocument(ctx context.Context, req *generativelanguagepb.GetDocumentRequest, opts ...gax.CallOption) (*generativelanguagepb.Document, error)GetDocument gets information about a specific Document.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GetDocumentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GetDocumentRequest.
}
resp, err := c.GetDocument(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) GetOperation
func (c *RetrieverClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) ListChunks
func (c *RetrieverClient) ListChunks(ctx context.Context, req *generativelanguagepb.ListChunksRequest, opts ...gax.CallOption) *ChunkIteratorListChunks lists all Chunks in a Document.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListChunksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListChunksRequest.
}
it := c.ListChunks(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListChunksResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListChunksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListChunksRequest.
}
for resp, err := range c.ListChunks(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*RetrieverClient) ListCorpora
func (c *RetrieverClient) ListCorpora(ctx context.Context, req *generativelanguagepb.ListCorporaRequest, opts ...gax.CallOption) *CorpusIteratorListCorpora lists all Corpora owned by the user.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListCorporaRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListCorporaRequest.
}
it := c.ListCorpora(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListCorporaResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListCorporaRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListCorporaRequest.
}
for resp, err := range c.ListCorpora(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*RetrieverClient) ListDocuments
func (c *RetrieverClient) ListDocuments(ctx context.Context, req *generativelanguagepb.ListDocumentsRequest, opts ...gax.CallOption) *DocumentIteratorListDocuments lists all Documents in a Corpus.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListDocumentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListDocumentsRequest.
}
it := c.ListDocuments(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*generativelanguagepb.ListDocumentsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.ListDocumentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#ListDocumentsRequest.
}
for resp, err := range c.ListDocuments(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*RetrieverClient) ListOperations
func (c *RetrieverClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*RetrieverClient) QueryCorpus
func (c *RetrieverClient) QueryCorpus(ctx context.Context, req *generativelanguagepb.QueryCorpusRequest, opts ...gax.CallOption) (*generativelanguagepb.QueryCorpusResponse, error)QueryCorpus performs semantic search over a Corpus.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.QueryCorpusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#QueryCorpusRequest.
}
resp, err := c.QueryCorpus(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) QueryDocument
func (c *RetrieverClient) QueryDocument(ctx context.Context, req *generativelanguagepb.QueryDocumentRequest, opts ...gax.CallOption) (*generativelanguagepb.QueryDocumentResponse, error)QueryDocument performs semantic search over a Document.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.QueryDocumentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#QueryDocumentRequest.
}
resp, err := c.QueryDocument(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) UpdateChunk
func (c *RetrieverClient) UpdateChunk(ctx context.Context, req *generativelanguagepb.UpdateChunkRequest, opts ...gax.CallOption) (*generativelanguagepb.Chunk, error)UpdateChunk updates a Chunk.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdateChunkRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdateChunkRequest.
}
resp, err := c.UpdateChunk(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) UpdateCorpus
func (c *RetrieverClient) UpdateCorpus(ctx context.Context, req *generativelanguagepb.UpdateCorpusRequest, opts ...gax.CallOption) (*generativelanguagepb.Corpus, error)UpdateCorpus updates a Corpus.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdateCorpusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdateCorpusRequest.
}
resp, err := c.UpdateCorpus(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*RetrieverClient) UpdateDocument
func (c *RetrieverClient) UpdateDocument(ctx context.Context, req *generativelanguagepb.UpdateDocumentRequest, opts ...gax.CallOption) (*generativelanguagepb.Document, error)UpdateDocument updates a Document.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewRetrieverClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.UpdateDocumentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#UpdateDocumentRequest.
}
resp, err := c.UpdateDocument(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
TextCallOptions
type TextCallOptions struct {
GenerateText []gax.CallOption
EmbedText []gax.CallOption
BatchEmbedText []gax.CallOption
CountTextTokens []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}TextCallOptions contains the retry settings for each method of TextClient.
TextClient
type TextClient struct {
// The call options for this service.
CallOptions *TextCallOptions
// contains filtered or unexported fields
}TextClient is a client for interacting with Generative Language API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
API for using Generative Language Models (GLMs) trained to generate text.
Also known as Large Language Models (LLM)s, these generate text given an input prompt from the user.
func NewTextClient
func NewTextClient(ctx context.Context, opts ...option.ClientOption) (*TextClient, error)NewTextClient creates a new text service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
API for using Generative Language Models (GLMs) trained to generate text.
Also known as Large Language Models (LLM)s, these generate text given an input prompt from the user.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewTextRESTClient
func NewTextRESTClient(ctx context.Context, opts ...option.ClientOption) (*TextClient, error)NewTextRESTClient creates a new text service rest client.
API for using Generative Language Models (GLMs) trained to generate text.
Also known as Large Language Models (LLM)s, these generate text given an input prompt from the user.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*TextClient) BatchEmbedText
func (c *TextClient) BatchEmbedText(ctx context.Context, req *generativelanguagepb.BatchEmbedTextRequest, opts ...gax.CallOption) (*generativelanguagepb.BatchEmbedTextResponse, error)BatchEmbedText generates multiple embeddings from the model given input text in a synchronous call.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.BatchEmbedTextRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#BatchEmbedTextRequest.
}
resp, err := c.BatchEmbedText(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*TextClient) Close
func (c *TextClient) Close() errorClose closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*TextClient) Connection (deprecated)
func (c *TextClient) Connection() *grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*TextClient) CountTextTokens
func (c *TextClient) CountTextTokens(ctx context.Context, req *generativelanguagepb.CountTextTokensRequest, opts ...gax.CallOption) (*generativelanguagepb.CountTextTokensResponse, error)CountTextTokens runs a model’s tokenizer on a text and returns the token count.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.CountTextTokensRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#CountTextTokensRequest.
}
resp, err := c.CountTextTokens(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*TextClient) EmbedText
func (c *TextClient) EmbedText(ctx context.Context, req *generativelanguagepb.EmbedTextRequest, opts ...gax.CallOption) (*generativelanguagepb.EmbedTextResponse, error)EmbedText generates an embedding from the model given an input message.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.EmbedTextRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#EmbedTextRequest.
}
resp, err := c.EmbedText(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*TextClient) GenerateText
func (c *TextClient) GenerateText(ctx context.Context, req *generativelanguagepb.GenerateTextRequest, opts ...gax.CallOption) (*generativelanguagepb.GenerateTextResponse, error)GenerateText generates a response from the model given an input message.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
generativelanguagepb "cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &generativelanguagepb.GenerateTextRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/ai/generativelanguage/apiv1alpha/generativelanguagepb#GenerateTextRequest.
}
resp, err := c.GenerateText(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*TextClient) GetOperation
func (c *TextClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*TextClient) ListOperations
func (c *TextClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
generativelanguage "cloud.google.com/go/ai/generativelanguage/apiv1alpha"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := generativelanguage.NewTextClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
TunedModelIterator
type TunedModelIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*generativelanguagepb.TunedModel, nextPageToken string, err error)
// contains filtered or unexported fields
}TunedModelIterator manages a stream of *generativelanguagepb.TunedModel.
func (*TunedModelIterator) All
func (it *TunedModelIterator) All() iter.Seq2[*generativelanguagepb.TunedModel, error]All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*TunedModelIterator) Next
func (it *TunedModelIterator) Next() (*generativelanguagepb.TunedModel, error)Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*TunedModelIterator) PageInfo
func (it *TunedModelIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.