// Copyright 2025 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Code generated by protoc-gen-go_gapic. DO NOT EDIT. package retail import ( "bytes" "context" "errors" "fmt" "log/slog" "math" "net/http" "net/url" "time" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" retailpb "cloud.google.com/go/retail/apiv2/retailpb" gax "github.com/googleapis/gax-go/v2" "google.golang.org/api/iterator" "google.golang.org/api/option" "google.golang.org/api/option/internaloption" gtransport "google.golang.org/api/transport/grpc" httptransport "google.golang.org/api/transport/http" "google.golang.org/grpc" "google.golang.org/grpc/codes" "google.golang.org/grpc/metadata" "google.golang.org/protobuf/encoding/protojson" "google.golang.org/protobuf/proto" ) var newConversationalSearchClientHook clientHook // ConversationalSearchCallOptions contains the retry settings for each method of ConversationalSearchClient. type ConversationalSearchCallOptions struct { ConversationalSearch []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption } func defaultConversationalSearchGRPCClientOptions() []option.ClientOption { return []option.ClientOption{ internaloption.WithDefaultEndpoint("retail.googleapis.com:443"), internaloption.WithDefaultEndpointTemplate("retail.UNIVERSE_DOMAIN:443"), internaloption.WithDefaultMTLSEndpoint("retail.mtls.googleapis.com:443"), internaloption.WithDefaultUniverseDomain("googleapis.com"), internaloption.WithDefaultAudience("https://retail.googleapis.com/"), internaloption.WithDefaultScopes(DefaultAuthScopes()...), internaloption.EnableJwtWithScope(), internaloption.EnableNewAuthLibrary(), option.WithGRPCDialOption(grpc.WithDefaultCallOptions( grpc.MaxCallRecvMsgSize(math.MaxInt32))), } } func defaultConversationalSearchCallOptions() *ConversationalSearchCallOptions { return &ConversationalSearchCallOptions{ ConversationalSearch: []gax.CallOption{}, GetOperation: []gax.CallOption{}, ListOperations: []gax.CallOption{ gax.WithTimeout(300000 * time.Millisecond), gax.WithRetry(func() gax.Retryer { return gax.OnCodes([]codes.Code{ codes.Unavailable, codes.DeadlineExceeded, }, gax.Backoff{ Initial: 100 * time.Millisecond, Max: 300000 * time.Millisecond, Multiplier: 1.30, }) }), }, } } func defaultConversationalSearchRESTCallOptions() *ConversationalSearchCallOptions { return &ConversationalSearchCallOptions{ ConversationalSearch: []gax.CallOption{}, GetOperation: []gax.CallOption{}, ListOperations: []gax.CallOption{ gax.WithTimeout(300000 * time.Millisecond), gax.WithRetry(func() gax.Retryer { return gax.OnHTTPCodes(gax.Backoff{ Initial: 100 * time.Millisecond, Max: 300000 * time.Millisecond, Multiplier: 1.30, }, http.StatusServiceUnavailable, http.StatusGatewayTimeout) }), }, } } // internalConversationalSearchClient is an interface that defines the methods available from Vertex AI Search for commerce API. type internalConversationalSearchClient interface { Close() error setGoogleClientInfo(...string) Connection() *grpc.ClientConn ConversationalSearch(context.Context, *retailpb.ConversationalSearchRequest, ...gax.CallOption) (retailpb.ConversationalSearchService_ConversationalSearchClient, error) GetOperation(context.Context, *longrunningpb.GetOperationRequest, ...gax.CallOption) (*longrunningpb.Operation, error) ListOperations(context.Context, *longrunningpb.ListOperationsRequest, ...gax.CallOption) *OperationIterator } // ConversationalSearchClient is a client for interacting with Vertex AI Search for commerce API. // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. // // Service for retail conversational search. // // This feature is only available for users who have Retail Conversational // Search enabled. Enable Retail Conversational Search on Cloud Console // before using this feature. type ConversationalSearchClient struct { // The internal transport-dependent client. internalClient internalConversationalSearchClient // The call options for this service. CallOptions *ConversationalSearchCallOptions } // Wrapper methods routed to the internal client. // Close closes the connection to the API service. The user should invoke this when // the client is no longer required. func (c *ConversationalSearchClient) Close() error { return c.internalClient.Close() } // setGoogleClientInfo sets the name and version of the application in // the `x-goog-api-client` header passed on each request. Intended for // use by Google-written clients. func (c *ConversationalSearchClient) setGoogleClientInfo(keyval ...string) { c.internalClient.setGoogleClientInfo(keyval...) } // Connection returns a connection to the API service. // // Deprecated: Connections are now pooled so this method does not always // return the same resource. func (c *ConversationalSearchClient) Connection() *grpc.ClientConn { return c.internalClient.Connection() } // ConversationalSearch performs a conversational search. // // This feature is only available for users who have Conversational Search // enabled. func (c *ConversationalSearchClient) ConversationalSearch(ctx context.Context, req *retailpb.ConversationalSearchRequest, opts ...gax.CallOption) (retailpb.ConversationalSearchService_ConversationalSearchClient, error) { return c.internalClient.ConversationalSearch(ctx, req, opts...) } // GetOperation is a utility method from google.longrunning.Operations. func (c *ConversationalSearchClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) { return c.internalClient.GetOperation(ctx, req, opts...) } // ListOperations is a utility method from google.longrunning.Operations. func (c *ConversationalSearchClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator { return c.internalClient.ListOperations(ctx, req, opts...) } // conversationalSearchGRPCClient is a client for interacting with Vertex AI Search for commerce API over gRPC transport. // // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. type conversationalSearchGRPCClient struct { // Connection pool of gRPC connections to the service. connPool gtransport.ConnPool // Points back to the CallOptions field of the containing ConversationalSearchClient CallOptions **ConversationalSearchCallOptions // The gRPC API client. conversationalSearchClient retailpb.ConversationalSearchServiceClient operationsClient longrunningpb.OperationsClient // The x-goog-* metadata to be sent with each request. xGoogHeaders []string logger *slog.Logger } // NewConversationalSearchClient creates a new conversational search service client based on gRPC. // The returned client must be Closed when it is done being used to clean up its underlying connections. // // Service for retail conversational search. // // This feature is only available for users who have Retail Conversational // Search enabled. Enable Retail Conversational Search on Cloud Console // before using this feature. func NewConversationalSearchClient(ctx context.Context, opts ...option.ClientOption) (*ConversationalSearchClient, error) { clientOpts := defaultConversationalSearchGRPCClientOptions() if newConversationalSearchClientHook != nil { hookOpts, err := newConversationalSearchClientHook(ctx, clientHookParams{}) if err != nil { return nil, err } clientOpts = append(clientOpts, hookOpts...) } connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...) if err != nil { return nil, err } client := ConversationalSearchClient{CallOptions: defaultConversationalSearchCallOptions()} c := &conversationalSearchGRPCClient{ connPool: connPool, conversationalSearchClient: retailpb.NewConversationalSearchServiceClient(connPool), CallOptions: &client.CallOptions, logger: internaloption.GetLogger(opts), operationsClient: longrunningpb.NewOperationsClient(connPool), } c.setGoogleClientInfo() client.internalClient = c return &client, nil } // Connection returns a connection to the API service. // // Deprecated: Connections are now pooled so this method does not always // return the same resource. func (c *conversationalSearchGRPCClient) Connection() *grpc.ClientConn { return c.connPool.Conn() } // setGoogleClientInfo sets the name and version of the application in // the `x-goog-api-client` header passed on each request. Intended for // use by Google-written clients. func (c *conversationalSearchGRPCClient) setGoogleClientInfo(keyval ...string) { kv := append([]string{"gl-go", gax.GoVersion}, keyval...) kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "grpc", grpc.Version, "pb", protoVersion) c.xGoogHeaders = []string{ "x-goog-api-client", gax.XGoogHeader(kv...), } } // Close closes the connection to the API service. The user should invoke this when // the client is no longer required. func (c *conversationalSearchGRPCClient) Close() error { return c.connPool.Close() } // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. type conversationalSearchRESTClient struct { // The http endpoint to connect to. endpoint string // The http client. httpClient *http.Client // The x-goog-* headers to be sent with each request. xGoogHeaders []string // Points back to the CallOptions field of the containing ConversationalSearchClient CallOptions **ConversationalSearchCallOptions logger *slog.Logger } // NewConversationalSearchRESTClient creates a new conversational search service rest client. // // Service for retail conversational search. // // This feature is only available for users who have Retail Conversational // Search enabled. Enable Retail Conversational Search on Cloud Console // before using this feature. func NewConversationalSearchRESTClient(ctx context.Context, opts ...option.ClientOption) (*ConversationalSearchClient, error) { clientOpts := append(defaultConversationalSearchRESTClientOptions(), opts...) httpClient, endpoint, err := httptransport.NewClient(ctx, clientOpts...) if err != nil { return nil, err } callOpts := defaultConversationalSearchRESTCallOptions() c := &conversationalSearchRESTClient{ endpoint: endpoint, httpClient: httpClient, CallOptions: &callOpts, logger: internaloption.GetLogger(opts), } c.setGoogleClientInfo() return &ConversationalSearchClient{internalClient: c, CallOptions: callOpts}, nil } func defaultConversationalSearchRESTClientOptions() []option.ClientOption { return []option.ClientOption{ internaloption.WithDefaultEndpoint("https://retail.googleapis.com"), internaloption.WithDefaultEndpointTemplate("https://retail.UNIVERSE_DOMAIN"), internaloption.WithDefaultMTLSEndpoint("https://retail.mtls.googleapis.com"), internaloption.WithDefaultUniverseDomain("googleapis.com"), internaloption.WithDefaultAudience("https://retail.googleapis.com/"), internaloption.WithDefaultScopes(DefaultAuthScopes()...), internaloption.EnableNewAuthLibrary(), } } // setGoogleClientInfo sets the name and version of the application in // the `x-goog-api-client` header passed on each request. Intended for // use by Google-written clients. func (c *conversationalSearchRESTClient) setGoogleClientInfo(keyval ...string) { kv := append([]string{"gl-go", gax.GoVersion}, keyval...) kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "rest", "UNKNOWN", "pb", protoVersion) c.xGoogHeaders = []string{ "x-goog-api-client", gax.XGoogHeader(kv...), } } // Close closes the connection to the API service. The user should invoke this when // the client is no longer required. func (c *conversationalSearchRESTClient) Close() error { // Replace httpClient with nil to force cleanup. c.httpClient = nil return nil } // Connection returns a connection to the API service. // // Deprecated: This method always returns nil. func (c *conversationalSearchRESTClient) Connection() *grpc.ClientConn { return nil } func (c *conversationalSearchGRPCClient) ConversationalSearch(ctx context.Context, req *retailpb.ConversationalSearchRequest, opts ...gax.CallOption) (retailpb.ConversationalSearchService_ConversationalSearchClient, error) { hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "placement", url.QueryEscape(req.GetPlacement()))} hds = append(c.xGoogHeaders, hds...) ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) opts = append((*c.CallOptions).ConversationalSearch[0:len((*c.CallOptions).ConversationalSearch):len((*c.CallOptions).ConversationalSearch)], opts...) var resp retailpb.ConversationalSearchService_ConversationalSearchClient err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { var err error c.logger.DebugContext(ctx, "api streaming client request", "serviceName", serviceName, "rpcName", "ConversationalSearch") resp, err = c.conversationalSearchClient.ConversationalSearch(ctx, req, settings.GRPC...) c.logger.DebugContext(ctx, "api streaming client response", "serviceName", serviceName, "rpcName", "ConversationalSearch") return err }, opts...) if err != nil { return nil, err } return resp, nil } func (c *conversationalSearchGRPCClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) { hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} hds = append(c.xGoogHeaders, hds...) ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) opts = append((*c.CallOptions).GetOperation[0:len((*c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...) var resp *longrunningpb.Operation err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { var err error resp, err = executeRPC(ctx, c.operationsClient.GetOperation, req, settings.GRPC, c.logger, "GetOperation") return err }, opts...) if err != nil { return nil, err } return resp, nil } func (c *conversationalSearchGRPCClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator { hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} hds = append(c.xGoogHeaders, hds...) ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) opts = append((*c.CallOptions).ListOperations[0:len((*c.CallOptions).ListOperations):len((*c.CallOptions).ListOperations)], opts...) it := &OperationIterator{} req = proto.Clone(req).(*longrunningpb.ListOperationsRequest) it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) { resp := &longrunningpb.ListOperationsResponse{} if pageToken != "" { req.PageToken = pageToken } if pageSize > math.MaxInt32 { req.PageSize = math.MaxInt32 } else if pageSize != 0 { req.PageSize = int32(pageSize) } err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { var err error resp, err = executeRPC(ctx, c.operationsClient.ListOperations, req, settings.GRPC, c.logger, "ListOperations") return err }, opts...) if err != nil { return nil, "", err } it.Response = resp return resp.GetOperations(), resp.GetNextPageToken(), nil } fetch := func(pageSize int, pageToken string) (string, error) { items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) if err != nil { return "", err } it.items = append(it.items, items...) return nextPageToken, nil } it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) it.pageInfo.MaxSize = int(req.GetPageSize()) it.pageInfo.Token = req.GetPageToken() return it } // ConversationalSearch performs a conversational search. // // This feature is only available for users who have Conversational Search // enabled. func (c *conversationalSearchRESTClient) ConversationalSearch(ctx context.Context, req *retailpb.ConversationalSearchRequest, opts ...gax.CallOption) (retailpb.ConversationalSearchService_ConversationalSearchClient, error) { m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} jsonReq, err := m.Marshal(req) if err != nil { return nil, err } baseUrl, err := url.Parse(c.endpoint) if err != nil { return nil, err } baseUrl.Path += fmt.Sprintf("/v2/%v:conversationalSearch", req.GetPlacement()) params := url.Values{} params.Add("$alt", "json;enum-encoding=int") baseUrl.RawQuery = params.Encode() // Build HTTP headers from client and context metadata. hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "placement", url.QueryEscape(req.GetPlacement()))} hds = append(c.xGoogHeaders, hds...) hds = append(hds, "Content-Type", "application/json") headers := gax.BuildHeaders(ctx, hds...) var streamClient *conversationalSearchRESTStreamClient e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { if settings.Path != "" { baseUrl.Path = settings.Path } httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) if err != nil { return err } httpReq = httpReq.WithContext(ctx) httpReq.Header = headers httpRsp, err := executeStreamingHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "ConversationalSearch") if err != nil { return err } streamClient = &conversationalSearchRESTStreamClient{ ctx: ctx, md: metadata.MD(httpRsp.Header), stream: gax.NewProtoJSONStreamReader(httpRsp.Body, (&retailpb.ConversationalSearchResponse{}).ProtoReflect().Type()), } return nil }, opts...) return streamClient, e } // conversationalSearchRESTStreamClient is the stream client used to consume the server stream created by // the REST implementation of ConversationalSearch. type conversationalSearchRESTStreamClient struct { ctx context.Context md metadata.MD stream *gax.ProtoJSONStream } func (c *conversationalSearchRESTStreamClient) Recv() (*retailpb.ConversationalSearchResponse, error) { if err := c.ctx.Err(); err != nil { defer c.stream.Close() return nil, err } msg, err := c.stream.Recv() if err != nil { defer c.stream.Close() return nil, err } res := msg.(*retailpb.ConversationalSearchResponse) return res, nil } func (c *conversationalSearchRESTStreamClient) Header() (metadata.MD, error) { return c.md, nil } func (c *conversationalSearchRESTStreamClient) Trailer() metadata.MD { return c.md } func (c *conversationalSearchRESTStreamClient) CloseSend() error { // This is a no-op to fulfill the interface. return errors.New("this method is not implemented for a server-stream") } func (c *conversationalSearchRESTStreamClient) Context() context.Context { return c.ctx } func (c *conversationalSearchRESTStreamClient) SendMsg(m interface{}) error { // This is a no-op to fulfill the interface. return errors.New("this method is not implemented for a server-stream") } func (c *conversationalSearchRESTStreamClient) RecvMsg(m interface{}) error { // This is a no-op to fulfill the interface. return errors.New("this method is not implemented, use Recv") } // GetOperation is a utility method from google.longrunning.Operations. func (c *conversationalSearchRESTClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) { baseUrl, err := url.Parse(c.endpoint) if err != nil { return nil, err } baseUrl.Path += fmt.Sprintf("/v2/%v", req.GetName()) params := url.Values{} params.Add("$alt", "json;enum-encoding=int") baseUrl.RawQuery = params.Encode() // Build HTTP headers from client and context metadata. hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} hds = append(c.xGoogHeaders, hds...) hds = append(hds, "Content-Type", "application/json") headers := gax.BuildHeaders(ctx, hds...) opts = append((*c.CallOptions).GetOperation[0:len((*c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...) unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} resp := &longrunningpb.Operation{} e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { if settings.Path != "" { baseUrl.Path = settings.Path } httpReq, err := http.NewRequest("GET", baseUrl.String(), nil) if err != nil { return err } httpReq = httpReq.WithContext(ctx) httpReq.Header = headers buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, nil, "GetOperation") if err != nil { return err } if err := unm.Unmarshal(buf, resp); err != nil { return err } return nil }, opts...) if e != nil { return nil, e } return resp, nil } // ListOperations is a utility method from google.longrunning.Operations. func (c *conversationalSearchRESTClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator { it := &OperationIterator{} req = proto.Clone(req).(*longrunningpb.ListOperationsRequest) unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) { resp := &longrunningpb.ListOperationsResponse{} if pageToken != "" { req.PageToken = pageToken } if pageSize > math.MaxInt32 { req.PageSize = math.MaxInt32 } else if pageSize != 0 { req.PageSize = int32(pageSize) } baseUrl, err := url.Parse(c.endpoint) if err != nil { return nil, "", err } baseUrl.Path += fmt.Sprintf("/v2/%v/operations", req.GetName()) params := url.Values{} params.Add("$alt", "json;enum-encoding=int") if req.GetFilter() != "" { params.Add("filter", fmt.Sprintf("%v", req.GetFilter())) } if req.GetPageSize() != 0 { params.Add("pageSize", fmt.Sprintf("%v", req.GetPageSize())) } if req.GetPageToken() != "" { params.Add("pageToken", fmt.Sprintf("%v", req.GetPageToken())) } baseUrl.RawQuery = params.Encode() // Build HTTP headers from client and context metadata. hds := append(c.xGoogHeaders, "Content-Type", "application/json") headers := gax.BuildHeaders(ctx, hds...) e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { if settings.Path != "" { baseUrl.Path = settings.Path } httpReq, err := http.NewRequest("GET", baseUrl.String(), nil) if err != nil { return err } httpReq.Header = headers buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, nil, "ListOperations") if err != nil { return err } if err := unm.Unmarshal(buf, resp); err != nil { return err } return nil }, opts...) if e != nil { return nil, "", e } it.Response = resp return resp.GetOperations(), resp.GetNextPageToken(), nil } fetch := func(pageSize int, pageToken string) (string, error) { items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) if err != nil { return "", err } it.items = append(it.items, items...) return nextPageToken, nil } it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) it.pageInfo.MaxSize = int(req.GetPageSize()) it.pageInfo.Token = req.GetPageToken() return it }