discoveryenginepb

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 30, 2023 License: Apache-2.0 Imports: 17 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ImportDocumentsRequest_ReconciliationMode_name = map[int32]string{
		0: "RECONCILIATION_MODE_UNSPECIFIED",
		1: "INCREMENTAL",
		2: "FULL",
	}
	ImportDocumentsRequest_ReconciliationMode_value = map[string]int32{
		"RECONCILIATION_MODE_UNSPECIFIED": 0,
		"INCREMENTAL":                     1,
		"FULL":                            2,
	}
)

Enum value maps for ImportDocumentsRequest_ReconciliationMode.

View Source 
var (
	SearchRequest_QueryExpansionSpec_Condition_name = map[int32]string{
		0: "CONDITION_UNSPECIFIED",
		1: "DISABLED",
		2: "AUTO",
	}
	SearchRequest_QueryExpansionSpec_Condition_value = map[string]int32{
		"CONDITION_UNSPECIFIED": 0,
		"DISABLED":              1,
		"AUTO":                  2,
	}
)

Enum value maps for SearchRequest_QueryExpansionSpec_Condition.

View Source 
var (
	SearchRequest_SpellCorrectionSpec_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "SUGGESTION_ONLY",
		2: "AUTO",
	}
	SearchRequest_SpellCorrectionSpec_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"SUGGESTION_ONLY":  1,
		"AUTO":             2,
	}
)

Enum value maps for SearchRequest_SpellCorrectionSpec_Mode.

View Source 
var File_google_cloud_discoveryengine_v1beta_common_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_completion_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_document_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_document_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_import_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_purge_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_recommendation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_schema_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_schema_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_user_event_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterCompletionServiceServer added in v0.3.0 

func RegisterCompletionServiceServer(s *grpc.Server, srv CompletionServiceServer)

func RegisterDocumentServiceServer 

func RegisterDocumentServiceServer(s *grpc.Server, srv DocumentServiceServer)

func RegisterRecommendationServiceServer 

func RegisterRecommendationServiceServer(s *grpc.Server, srv RecommendationServiceServer)

func RegisterSchemaServiceServer added in v0.3.0 

func RegisterSchemaServiceServer(s *grpc.Server, srv SchemaServiceServer)

func RegisterSearchServiceServer added in v0.3.0 

func RegisterSearchServiceServer(s *grpc.Server, srv SearchServiceServer)

func RegisterUserEventServiceServer 

func RegisterUserEventServiceServer(s *grpc.Server, srv UserEventServiceServer)

Types

type BigQuerySource 

type BigQuerySource struct {

	// BigQuery table partition info. Leave this empty if the BigQuery table
	// is not partitioned.
	//
	// Types that are assignable to Partition:
	//	*BigQuerySource_PartitionDate
	Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
	// The project ID (can be project # or ID) that the BigQuery source is in with
	// a length limit of 128 characters. If not specified, inherits the project
	// ID from the parent request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The BigQuery data set to copy the data from with a length limit
	// of 1,024 characters.
	DatasetId string `protobuf:"bytes,2,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The BigQuery table to copy the data from with a length limit of
	// 1,024 characters.
	TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// BigQuery export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for user event imports:
	//
	// * `user_event` (default): One
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per row.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One
	// [Document][google.cloud.discoveryengine.v1beta.Document] format per
	//   row. Each document must have a valid
	//   [Document.id][google.cloud.discoveryengine.v1beta.Document.id] and one of
	//   [Document.json_data][google.cloud.discoveryengine.v1beta.Document.json_data]
	//   or
	//   [Document.struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data].
	// * `custom`: One custom data per row in arbitrary format that conforms the
	//   defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the data
	//   store. This can only be used by the GENERIC Data Store vertical.
	DataSchema string `protobuf:"bytes,6,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

BigQuery source import data from.

func (*BigQuerySource) Descriptor deprecated 

func (*BigQuerySource) Descriptor() ([]byte, []int)

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetDataSchema 

func (x *BigQuerySource) GetDataSchema() string

func (*BigQuerySource) GetDatasetId 

func (x *BigQuerySource) GetDatasetId() string

func (*BigQuerySource) GetGcsStagingDir 

func (x *BigQuerySource) GetGcsStagingDir() string

func (*BigQuerySource) GetPartition 

func (m *BigQuerySource) GetPartition() isBigQuerySource_Partition

func (*BigQuerySource) GetPartitionDate 

func (x *BigQuerySource) GetPartitionDate() *date.Date

func (*BigQuerySource) GetProjectId 

func (x *BigQuerySource) GetProjectId() string

func (*BigQuerySource) GetTableId 

func (x *BigQuerySource) GetTableId() string

func (*BigQuerySource) ProtoMessage 

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect 

func (x *BigQuerySource) ProtoReflect() protoreflect.Message

func (*BigQuerySource) Reset 

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String 

func (x *BigQuerySource) String() string

type BigQuerySource_PartitionDate 

type BigQuerySource_PartitionDate struct {
	// BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
	PartitionDate *date.Date `protobuf:"bytes,5,opt,name=partition_date,json=partitionDate,proto3,oneof"`
}

type CollectUserEventRequest 

type CollectUserEventRequest struct {

	// Required. The parent DataStore resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. URL encoded UserEvent proto with a length limit of 2,000,000
	// characters.
	UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// The URL including cgi-parameters but excluding the hash fragment with a
	// length limit of 5,000 characters. This is often more useful than the
	// referer URL, because many browsers only send the domain for 3rd party
	// requests.
	Uri *string `protobuf:"bytes,3,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
	// The event timestamp in milliseconds. This prevents browser caching of
	// otherwise identical get requests. The name is abbreviated to reduce the
	// payload bytes.
	Ets *int64 `protobuf:"varint,4,opt,name=ets,proto3,oneof" json:"ets,omitempty"`
	// contains filtered or unexported fields
}

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor deprecated 

func (*CollectUserEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetEts 

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent 

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri 

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent 

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage 

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect 

func (x *CollectUserEventRequest) ProtoReflect() protoreflect.Message

func (*CollectUserEventRequest) Reset 

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String 

func (x *CollectUserEventRequest) String() string

type CompleteQueryRequest added in v0.3.0 

type CompleteQueryRequest struct {

	// Required. The parent data store resource name for which the completion is
	// performed, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The typeahead input used to fetch suggestions. Maximum length is
	// 128 characters.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Selects data model of query suggestions for serving. Currently supported
	// values:
	//
	// * `document` - Using suggestions generated from user-imported documents.
	// * `search-history` - Using suggestions generated from the past history of
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// API calls. Do not use it when there is no traffic for Search API.
	// * `user-event` - Using suggestions generated from user-imported search
	// events.
	//
	// Default values:
	//
	// * `document` is the default model for regular dataStores.
	// * `search-history` is the default model for
	// [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
	// dataStores.
	QueryModel string `protobuf:"bytes,3,opt,name=query_model,json=queryModel,proto3" json:"query_model,omitempty"`
	// A unique identifier for tracking visitors. For example, this could be
	// implemented with an HTTP cookie, which should be able to uniquely identify
	// a visitor on a single device. This unique identifier should not change if
	// the visitor logs in or out of the website.
	//
	// This field should NOT have a fixed value such as `unknown_visitor`.
	//
	// This should be the same identifier as
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// and
	// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
	UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.

func (*CompleteQueryRequest) Descriptor deprecated added in v0.3.0 

func (*CompleteQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetDataStore added in v0.3.0 

func (x *CompleteQueryRequest) GetDataStore() string

func (*CompleteQueryRequest) GetQuery added in v0.3.0 

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetQueryModel added in v0.3.0 

func (x *CompleteQueryRequest) GetQueryModel() string

func (*CompleteQueryRequest) GetUserPseudoId added in v0.3.0 

func (x *CompleteQueryRequest) GetUserPseudoId() string

func (*CompleteQueryRequest) ProtoMessage added in v0.3.0 

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect added in v0.3.0 

func (x *CompleteQueryRequest) ProtoReflect() protoreflect.Message

func (*CompleteQueryRequest) Reset added in v0.3.0 

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String added in v0.3.0 

func (x *CompleteQueryRequest) String() string

type CompleteQueryResponse added in v0.3.0 

type CompleteQueryResponse struct {

	// Results of the matched query suggestions. The result list is ordered and
	// the first result is a top suggestion.
	QuerySuggestions []*CompleteQueryResponse_QuerySuggestion `protobuf:"bytes,1,rep,name=query_suggestions,json=querySuggestions,proto3" json:"query_suggestions,omitempty"`
	// contains filtered or unexported fields
}

Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.

func (*CompleteQueryResponse) Descriptor deprecated added in v0.3.0 

func (*CompleteQueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions added in v0.3.0 

func (x *CompleteQueryResponse) GetQuerySuggestions() []*CompleteQueryResponse_QuerySuggestion

func (*CompleteQueryResponse) ProtoMessage added in v0.3.0 

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect added in v0.3.0 

func (x *CompleteQueryResponse) ProtoReflect() protoreflect.Message

func (*CompleteQueryResponse) Reset added in v0.3.0 

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String added in v0.3.0 

func (x *CompleteQueryResponse) String() string

type CompleteQueryResponse_QuerySuggestion added in v0.3.0 

type CompleteQueryResponse_QuerySuggestion struct {

	// The suggestion for the query.
	Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// contains filtered or unexported fields
}

Suggestions as search queries.

func (*CompleteQueryResponse_QuerySuggestion) Descriptor deprecated added in v0.3.0 

func (*CompleteQueryResponse_QuerySuggestion) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage added in v0.3.0 

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()

func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) ProtoReflect() protoreflect.Message

func (*CompleteQueryResponse_QuerySuggestion) Reset added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) Reset()

func (*CompleteQueryResponse_QuerySuggestion) String added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) String() string

type CompletionInfo 

type CompletionInfo struct {

	// End user selected [CompleteQueryResponse.CompletionResult.suggestion][].
	SelectedSuggestion string `protobuf:"bytes,1,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
	// End user selected [CompleteQueryResponse.CompletionResult.suggestion][]
	// position, starting from 0.
	SelectedPosition int32 `protobuf:"varint,2,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`
	// contains filtered or unexported fields
}

Detailed completion information including completion attribution token and clicked completion info.

func (*CompletionInfo) Descriptor deprecated 

func (*CompletionInfo) Descriptor() ([]byte, []int)

Deprecated: Use CompletionInfo.ProtoReflect.Descriptor instead.

func (*CompletionInfo) GetSelectedPosition 

func (x *CompletionInfo) GetSelectedPosition() int32

func (*CompletionInfo) GetSelectedSuggestion 

func (x *CompletionInfo) GetSelectedSuggestion() string

func (*CompletionInfo) ProtoMessage 

func (*CompletionInfo) ProtoMessage()

func (*CompletionInfo) ProtoReflect 

func (x *CompletionInfo) ProtoReflect() protoreflect.Message

func (*CompletionInfo) Reset 

func (x *CompletionInfo) Reset()

func (*CompletionInfo) String 

func (x *CompletionInfo) String() string

type CompletionServiceClient added in v0.3.0 

type CompletionServiceClient interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
}

CompletionServiceClient is the client API for CompletionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCompletionServiceClient added in v0.3.0 

func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient

type CompletionServiceServer added in v0.3.0 

type CompletionServiceServer interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
}

CompletionServiceServer is the server API for CompletionService service.

type CreateDocumentRequest 

type CreateDocumentRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
	// create.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Required. The ID to use for the
	// [Document][google.cloud.discoveryengine.v1beta.Document], which will become
	// the final component of the
	// [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
	//
	// If the caller does not have permission to create the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// This field must be unique among all
	// [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
	// [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
	// Otherwise, an `ALREADY_EXISTS` error is returned.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.

func (*CreateDocumentRequest) Descriptor deprecated 

func (*CreateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocument 

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId 

func (x *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetParent 

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect 

func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Message

func (*CreateDocumentRequest) Reset 

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (x *CreateDocumentRequest) String() string

type CreateSchemaMetadata added in v0.3.0 

type CreateSchemaMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for Create Schema LRO.

func (*CreateSchemaMetadata) Descriptor deprecated added in v0.3.0 

func (*CreateSchemaMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*CreateSchemaMetadata) GetCreateTime added in v0.3.0 

func (x *CreateSchemaMetadata) GetCreateTime() *timestamppb.Timestamp

func (*CreateSchemaMetadata) GetUpdateTime added in v0.3.0 

func (x *CreateSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*CreateSchemaMetadata) ProtoMessage added in v0.3.0 

func (*CreateSchemaMetadata) ProtoMessage()

func (*CreateSchemaMetadata) ProtoReflect added in v0.3.0 

func (x *CreateSchemaMetadata) ProtoReflect() protoreflect.Message

func (*CreateSchemaMetadata) Reset added in v0.3.0 

func (x *CreateSchemaMetadata) Reset()

func (*CreateSchemaMetadata) String added in v0.3.0 

func (x *CreateSchemaMetadata) String() string

type CreateSchemaRequest added in v0.3.0 

type CreateSchemaRequest struct {

	// Required. The parent data store resource name, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
	// create.
	Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	// Required. The ID to use for the
	// [Schema][google.cloud.discoveryengine.v1beta.Schema], which will become the
	// final component of the
	// [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name].
	//
	// This field should conform to
	// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
	// limit of 63 characters.
	SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.

func (*CreateSchemaRequest) Descriptor deprecated added in v0.3.0 

func (*CreateSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent added in v0.3.0 

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema added in v0.3.0 

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId added in v0.3.0 

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage added in v0.3.0 

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect added in v0.3.0 

func (x *CreateSchemaRequest) ProtoReflect() protoreflect.Message

func (*CreateSchemaRequest) Reset added in v0.3.0 

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String added in v0.3.0 

func (x *CreateSchemaRequest) String() string

type CustomAttribute 

type CustomAttribute struct {

	// The textual values of this custom attribute. For example, `["yellow",
	// "green"]` when the key is "color".
	//
	// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
	// returned.
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
	// when the key is "lengths_cm".
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
	// contains filtered or unexported fields
}

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent[google.cloud.discoveryengine.v1beta.UserEvent].

func (*CustomAttribute) Descriptor deprecated 

func (*CustomAttribute) Descriptor() ([]byte, []int)

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetNumbers 

func (x *CustomAttribute) GetNumbers() []float64

func (*CustomAttribute) GetText 

func (x *CustomAttribute) GetText() []string

func (*CustomAttribute) ProtoMessage 

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect 

func (x *CustomAttribute) ProtoReflect() protoreflect.Message

func (*CustomAttribute) Reset 

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String 

func (x *CustomAttribute) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1beta.Document], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to delete the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1beta.Document] to delete
	// does not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.

func (*DeleteDocumentRequest) Descriptor deprecated 

func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetName 

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteSchemaMetadata added in v0.3.0 

type DeleteSchemaMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for DeleteSchema LRO.

func (*DeleteSchemaMetadata) Descriptor deprecated added in v0.3.0 

func (*DeleteSchemaMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSchemaMetadata) GetCreateTime added in v0.3.0 

func (x *DeleteSchemaMetadata) GetCreateTime() *timestamppb.Timestamp

func (*DeleteSchemaMetadata) GetUpdateTime added in v0.3.0 

func (x *DeleteSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*DeleteSchemaMetadata) ProtoMessage added in v0.3.0 

func (*DeleteSchemaMetadata) ProtoMessage()

func (*DeleteSchemaMetadata) ProtoReflect added in v0.3.0 

func (x *DeleteSchemaMetadata) ProtoReflect() protoreflect.Message

func (*DeleteSchemaMetadata) Reset added in v0.3.0 

func (x *DeleteSchemaMetadata) Reset()

func (*DeleteSchemaMetadata) String added in v0.3.0 

func (x *DeleteSchemaMetadata) String() string

type DeleteSchemaRequest added in v0.3.0 

type DeleteSchemaRequest struct {

	// Required. The full resource name of the schema, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.

func (*DeleteSchemaRequest) Descriptor deprecated added in v0.3.0 

func (*DeleteSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName added in v0.3.0 

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage added in v0.3.0 

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect added in v0.3.0 

func (x *DeleteSchemaRequest) ProtoReflect() protoreflect.Message

func (*DeleteSchemaRequest) Reset added in v0.3.0 

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String added in v0.3.0 

func (x *DeleteSchemaRequest) String() string

type Document 

type Document struct {

	// Data representation. One of
	// [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
	// [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
	// be provided otherwise an `INVALID_ARGUMENT` error is thrown.
	//
	// Types that are assignable to Data:
	//	*Document_StructData
	//	*Document_JsonData
	Data isDocument_Data `protobuf_oneof:"data"`
	// Immutable. The full resource name of the document.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Immutable. The identifier of the document.
	//
	// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The identifier of the schema located in the same data store.
	SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// The unstructured data linked to this document. Content must be set if this
	// document is under a
	// `CONTENT_REQUIRED` data store.
	Content *Document_Content `protobuf:"bytes,10,opt,name=content,proto3" json:"content,omitempty"`
	// The identifier of the parent document. Currently supports at most two level
	// document hierarchy.
	//
	// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters.
	ParentDocumentId string `protobuf:"bytes,7,opt,name=parent_document_id,json=parentDocumentId,proto3" json:"parent_document_id,omitempty"`
	// Output only. This field is OUTPUT_ONLY.
	// It contains derived data that are not in the original input document.
	DerivedStructData *structpb.Struct `protobuf:"bytes,6,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
	// contains filtered or unexported fields
}

Document captures all raw metadata information of items to be recommended or searched.

func (*Document) Descriptor deprecated 

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent added in v0.3.0 

func (x *Document) GetContent() *Document_Content

func (*Document) GetData 

func (m *Document) GetData() isDocument_Data

func (*Document) GetDerivedStructData added in v0.3.0 

func (x *Document) GetDerivedStructData() *structpb.Struct

func (*Document) GetId 

func (x *Document) GetId() string

func (*Document) GetJsonData 

func (x *Document) GetJsonData() string

func (*Document) GetName 

func (x *Document) GetName() string

func (*Document) GetParentDocumentId 

func (x *Document) GetParentDocumentId() string

func (*Document) GetSchemaId 

func (x *Document) GetSchemaId() string

func (*Document) GetStructData 

func (x *Document) GetStructData() *structpb.Struct

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type DocumentInfo 

type DocumentInfo struct {

	// A required descriptor of the associated
	// [Document][google.cloud.discoveryengine.v1beta.Document].
	//
	// * If [id][google.cloud.discoveryengine.v1beta.DocumentInfo.id] is
	// specified, then the default values for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are
	// used when annotating with the stored Document.
	//
	// * If [name][google.cloud.discoveryengine.v1beta.DocumentInfo.name] is
	// specified, then the provided values (default values allowed) for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and
	// `{branch_id}` are used when annotating with the stored Document.
	//
	// Types that are assignable to DocumentDescriptor:
	//	*DocumentInfo_Id
	//	*DocumentInfo_Name
	DocumentDescriptor isDocumentInfo_DocumentDescriptor `protobuf_oneof:"document_descriptor"`
	// Quantity of the Document associated with the user event. Defaults to 1.
	//
	// For example, this field will be 2 if two quantities of the same Document
	// are involved in a `add-to-cart` event.
	//
	// Required for events of the following event types:
	//
	// * `add-to-cart`
	// * `purchase`
	Quantity *int32 `protobuf:"varint,3,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
	// The promotion IDs associated with this Document.
	// Currently, this field is restricted to at most one ID.
	PromotionIds []string `protobuf:"bytes,4,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
	// contains filtered or unexported fields
}

Detailed document information associated with a user event.

func (*DocumentInfo) Descriptor deprecated 

func (*DocumentInfo) Descriptor() ([]byte, []int)

Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.

func (*DocumentInfo) GetDocumentDescriptor 

func (m *DocumentInfo) GetDocumentDescriptor() isDocumentInfo_DocumentDescriptor

func (*DocumentInfo) GetId 

func (x *DocumentInfo) GetId() string

func (*DocumentInfo) GetName 

func (x *DocumentInfo) GetName() string

func (*DocumentInfo) GetPromotionIds 

func (x *DocumentInfo) GetPromotionIds() []string

func (*DocumentInfo) GetQuantity 

func (x *DocumentInfo) GetQuantity() int32

func (*DocumentInfo) ProtoMessage 

func (*DocumentInfo) ProtoMessage()

func (*DocumentInfo) ProtoReflect 

func (x *DocumentInfo) ProtoReflect() protoreflect.Message

func (*DocumentInfo) Reset 

func (x *DocumentInfo) Reset()

func (*DocumentInfo) String 

func (x *DocumentInfo) String() string

type DocumentInfo_Id 

type DocumentInfo_Id struct {
	// Required. The Document resource ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type DocumentInfo_Name 

type DocumentInfo_Name struct {
	// Required. The Document resource full name, of the form:
	// `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
	Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}

type DocumentServiceClient 

type DocumentServiceClient interface {
	// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
	CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
	UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
	DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
	// processing may be synchronous. Non-existing items will be created.
	//
	// Note: It is possible for a subset of the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
	// successfully updated.
	ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Permanently deletes all selected
	// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
	//
	// This process is asynchronous. Depending on the number of
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
	// this operation can take hours to complete. Before the delete operation
	// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
	// might still be returned by
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
	//
	// To get a list of the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
	// set
	// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
	// to false.
	PurgeDocuments(ctx context.Context, in *PurgeDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

DocumentServiceClient is the client API for DocumentService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDocumentServiceClient 

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

type DocumentServiceServer 

type DocumentServiceServer interface {
	// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
	GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
	// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
	CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
	// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
	UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
	// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
	DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
	// processing may be synchronous. Non-existing items will be created.
	//
	// Note: It is possible for a subset of the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
	// successfully updated.
	ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
	// Permanently deletes all selected
	// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
	//
	// This process is asynchronous. Depending on the number of
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
	// this operation can take hours to complete. Before the delete operation
	// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
	// might still be returned by
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
	//
	// To get a list of the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
	// set
	// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
	// to false.
	PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
}

DocumentServiceServer is the server API for DocumentService service.

type Document_Content added in v0.3.0 

type Document_Content struct {

	// Types that are assignable to Content:
	//	*Document_Content_RawBytes
	//	*Document_Content_Uri
	Content isDocument_Content_Content `protobuf_oneof:"content"`
	// The MIME type of the content. Supported types:
	//
	// * `application/pdf` (PDF)
	// * `text/html` (HTML)
	//
	// See https://www.iana.org/assignments/media-types/media-types.xhtml.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

Unstructured data linked to this document.

func (*Document_Content) Descriptor deprecated added in v0.3.0 

func (*Document_Content) Descriptor() ([]byte, []int)

Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.

func (*Document_Content) GetContent added in v0.3.0 

func (m *Document_Content) GetContent() isDocument_Content_Content

func (*Document_Content) GetMimeType added in v0.3.0 

func (x *Document_Content) GetMimeType() string

func (*Document_Content) GetRawBytes added in v0.3.0 

func (x *Document_Content) GetRawBytes() []byte

func (*Document_Content) GetUri added in v0.3.0 

func (x *Document_Content) GetUri() string

func (*Document_Content) ProtoMessage added in v0.3.0 

func (*Document_Content) ProtoMessage()

func (*Document_Content) ProtoReflect added in v0.3.0 

func (x *Document_Content) ProtoReflect() protoreflect.Message

func (*Document_Content) Reset added in v0.3.0 

func (x *Document_Content) Reset()

func (*Document_Content) String added in v0.3.0 

func (x *Document_Content) String() string

type Document_Content_RawBytes added in v0.3.0 

type Document_Content_RawBytes struct {
	// The content represented as a stream of bytes. The maximum length is
	// 1,000,000 bytes (1 MB / ~0.95 MiB).
	//
	// Note: As with all `bytes` fields, this field is represented as pure
	// binary in Protocol Buffers and base64-encoded string in JSON. For
	// example, `abc123!?$*&()'-=@~` should be represented as
	// `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
	// https://developers.google.com/protocol-buffers/docs/proto3#json.
	RawBytes []byte `protobuf:"bytes,2,opt,name=raw_bytes,json=rawBytes,proto3,oneof"`
}

type Document_Content_Uri added in v0.3.0 

type Document_Content_Uri struct {
	// The URI of the content. Only Cloud Storage URIs (e.g.
	// `gs://bucket-name/path/to/file`) are supported. The maximum file size
	// is 100 MB.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3,oneof"`
}

type Document_JsonData 

type Document_JsonData struct {
	// The JSON string representation of the document. It should conform to the
	// registered
	// [Schema.schema][google.cloud.discoveryengine.v1beta.Schema.schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	JsonData string `protobuf:"bytes,5,opt,name=json_data,json=jsonData,proto3,oneof"`
}

type Document_StructData 

type Document_StructData struct {
	// The structured JSON data for the document. It should conform to the
	// registered
	// [Schema.schema][google.cloud.discoveryengine.v1beta.Schema.schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,4,opt,name=struct_data,json=structData,proto3,oneof"`
}

type GcsSource 

type GcsSource struct {

	// Required. Cloud Storage URIs to input files. URI can be up to
	// 2000 characters long. URIs can match the full object path (for example,
	// `gs://bucket/directory/object.json`) or a pattern matching one or more
	// files, such as `gs://bucket/directory/*.json`.
	//
	// A request can contain at most 100 files (or 100,000 files if `data_schema`
	// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
	// `content`).
	InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One JSON
	// [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
	// document must
	//   have a valid
	//   [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
	// * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
	//   `input_uris` will become a document, with the ID set to the first 128
	//   bits of SHA256(URI) encoded as a hex string.
	// * `custom`: One custom data JSON per row in arbitrary format that conforms
	//   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
	//   data store. This can only be used by the GENERIC Data Store vertical.
	//
	// Supported values for user even imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
	DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

Cloud Storage location for input content.

func (*GcsSource) Descriptor deprecated 

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema 

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris 

func (x *GcsSource) GetInputUris() []string

func (*GcsSource) ProtoMessage 

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect 

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset 

func (x *GcsSource) Reset()

func (*GcsSource) String 

func (x *GcsSource) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1beta.Document], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to access the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Document][google.cloud.discoveryengine.v1beta.Document]
	// does not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] method.

func (*GetDocumentRequest) Descriptor deprecated 

func (*GetDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetName 

func (x *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect 

func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentRequest) Reset 

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (x *GetDocumentRequest) String() string

type GetSchemaRequest added in v0.3.0 

type GetSchemaRequest struct {

	// Required. The full resource name of the schema, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] method.

func (*GetSchemaRequest) Descriptor deprecated added in v0.3.0 

func (*GetSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName added in v0.3.0 

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) ProtoMessage added in v0.3.0 

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect added in v0.3.0 

func (x *GetSchemaRequest) ProtoReflect() protoreflect.Message

func (*GetSchemaRequest) Reset added in v0.3.0 

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String added in v0.3.0 

func (x *GetSchemaRequest) String() string

type ImportDocumentsMetadata 

type ImportDocumentsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportDocumentsMetadata) Descriptor deprecated 

func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata) GetCreateTime 

func (x *ImportDocumentsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) GetFailureCount 

func (x *ImportDocumentsMetadata) GetFailureCount() int64

func (*ImportDocumentsMetadata) GetSuccessCount 

func (x *ImportDocumentsMetadata) GetSuccessCount() int64

func (*ImportDocumentsMetadata) GetUpdateTime 

func (x *ImportDocumentsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) ProtoMessage 

func (*ImportDocumentsMetadata) ProtoMessage()

func (*ImportDocumentsMetadata) ProtoReflect 

func (x *ImportDocumentsMetadata) ProtoReflect() protoreflect.Message

func (*ImportDocumentsMetadata) Reset 

func (x *ImportDocumentsMetadata) Reset()

func (*ImportDocumentsMetadata) String 

func (x *ImportDocumentsMetadata) String() string

type ImportDocumentsRequest 

type ImportDocumentsRequest struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//	*ImportDocumentsRequest_InlineSource_
	//	*ImportDocumentsRequest_GcsSource
	//	*ImportDocumentsRequest_BigquerySource
	Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Requires create/update permission.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// The mode of reconciliation between existing documents and the documents to
	// be imported. Defaults to
	// [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
	ReconciliationMode ImportDocumentsRequest_ReconciliationMode `` /* 199-byte string literal not displayed */
	// Whether to automatically generate IDs for the documents if absent.
	//
	// If set to `true`,
	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s are
	// automatically generated based on the hash of the payload, where IDs may not
	// be consistent during multiple imports. In which case
	// [ReconciliationMode.FULL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL]
	// is highly recommended to avoid duplicate contents. If unset or set to
	// `false`, [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s
	// have to be specified using
	// [id_field][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field],
	// otherwises, documents without IDs will fail to be imported.
	//
	// Only set this field when using
	// [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
	// [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
	// when
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
	// or
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
	// is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
	AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
	// The field in the Cloud Storage and BigQuery sources that indicates the
	// unique IDs of the documents.
	//
	// For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the
	// key of the JSON field. For instance, `my_id` for JSON `{"my_id":
	// "some_uuid"}`. For
	// [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource] it is
	// the column name of the BigQuery table where the unique ids are stored.
	//
	// The values of the JSON field or the BigQuery column will be used as the
	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON
	// field or the BigQuery column must be of string type, and the values must be
	// set as valid strings conform to
	// [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
	// Otherwise, documents without valid IDs will fail to be imported.
	//
	// Only set this field when using
	// [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
	// [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
	// when
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
	// or
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
	// is `custom`. And only set this field when
	// [auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids]
	// is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
	//
	// If it is unset, a default value `_id` is used when importing from the
	// allowed data sources.
	IdField string `protobuf:"bytes,9,opt,name=id_field,json=idField,proto3" json:"id_field,omitempty"`
	// contains filtered or unexported fields
}

Request message for Import methods.

func (*ImportDocumentsRequest) Descriptor deprecated 

func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetAutoGenerateIds added in v0.4.0 

func (x *ImportDocumentsRequest) GetAutoGenerateIds() bool

func (*ImportDocumentsRequest) GetBigquerySource 

func (x *ImportDocumentsRequest) GetBigquerySource() *BigQuerySource

func (*ImportDocumentsRequest) GetErrorConfig 

func (x *ImportDocumentsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsRequest) GetGcsSource 

func (x *ImportDocumentsRequest) GetGcsSource() *GcsSource

func (*ImportDocumentsRequest) GetIdField added in v0.4.0 

func (x *ImportDocumentsRequest) GetIdField() string

func (*ImportDocumentsRequest) GetInlineSource 

func (x *ImportDocumentsRequest) GetInlineSource() *ImportDocumentsRequest_InlineSource

func (*ImportDocumentsRequest) GetParent 

func (x *ImportDocumentsRequest) GetParent() string

func (*ImportDocumentsRequest) GetReconciliationMode 

func (x *ImportDocumentsRequest) GetReconciliationMode() ImportDocumentsRequest_ReconciliationMode

func (*ImportDocumentsRequest) GetSource 

func (m *ImportDocumentsRequest) GetSource() isImportDocumentsRequest_Source

func (*ImportDocumentsRequest) ProtoMessage 

func (*ImportDocumentsRequest) ProtoMessage()

func (*ImportDocumentsRequest) ProtoReflect 

func (x *ImportDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ImportDocumentsRequest) Reset 

func (x *ImportDocumentsRequest) Reset()

func (*ImportDocumentsRequest) String 

func (x *ImportDocumentsRequest) String() string

type ImportDocumentsRequest_BigquerySource 

type ImportDocumentsRequest_BigquerySource struct {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportDocumentsRequest_GcsSource 

type ImportDocumentsRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportDocumentsRequest_InlineSource 

type ImportDocumentsRequest_InlineSource struct {

	// Required. A list of documents to update/create. Each document must have a
	// valid [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
	// Recommended max of 100 items.
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportDocuments method.

func (*ImportDocumentsRequest_InlineSource) Descriptor deprecated 

func (*ImportDocumentsRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest_InlineSource) GetDocuments 

func (x *ImportDocumentsRequest_InlineSource) GetDocuments() []*Document

func (*ImportDocumentsRequest_InlineSource) ProtoMessage 

func (*ImportDocumentsRequest_InlineSource) ProtoMessage()

func (*ImportDocumentsRequest_InlineSource) ProtoReflect 

func (x *ImportDocumentsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportDocumentsRequest_InlineSource) Reset 

func (x *ImportDocumentsRequest_InlineSource) Reset()

func (*ImportDocumentsRequest_InlineSource) String 

func (x *ImportDocumentsRequest_InlineSource) String() string

type ImportDocumentsRequest_InlineSource_ 

type ImportDocumentsRequest_InlineSource_ struct {
	// The Inline source for the input content for documents.
	InlineSource *ImportDocumentsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportDocumentsRequest_ReconciliationMode 

type ImportDocumentsRequest_ReconciliationMode int32

Indicates how imported documents are reconciled with the existing documents created or imported before. 

const (
	// Defaults to INCREMENTAL.
	ImportDocumentsRequest_RECONCILIATION_MODE_UNSPECIFIED ImportDocumentsRequest_ReconciliationMode = 0
	// Inserts new documents or updates existing documents.
	ImportDocumentsRequest_INCREMENTAL ImportDocumentsRequest_ReconciliationMode = 1
	// Calculates diff and replaces the entire document dataset. Existing
	// documents may be deleted if they are not present in the source location.
	ImportDocumentsRequest_FULL ImportDocumentsRequest_ReconciliationMode = 2
)

func (ImportDocumentsRequest_ReconciliationMode) Descriptor 

func (ImportDocumentsRequest_ReconciliationMode) Descriptor() protoreflect.EnumDescriptor

func (ImportDocumentsRequest_ReconciliationMode) Enum 

func (x ImportDocumentsRequest_ReconciliationMode) Enum() *ImportDocumentsRequest_ReconciliationMode

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor deprecated 

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.

func (ImportDocumentsRequest_ReconciliationMode) Number 

func (x ImportDocumentsRequest_ReconciliationMode) Number() protoreflect.EnumNumber

func (ImportDocumentsRequest_ReconciliationMode) String 

func (x ImportDocumentsRequest_ReconciliationMode) String() string

func (ImportDocumentsRequest_ReconciliationMode) Type 

func (ImportDocumentsRequest_ReconciliationMode) Type() protoreflect.EnumType

type ImportDocumentsResponse 

type ImportDocumentsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors in the request if set.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportDocumentsRequest[google.cloud.discoveryengine.v1beta.ImportDocumentsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportDocumentsResponse) Descriptor deprecated 

func (*ImportDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ImportDocumentsResponse) GetErrorConfig 

func (x *ImportDocumentsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsResponse) GetErrorSamples 

func (x *ImportDocumentsResponse) GetErrorSamples() []*status.Status

func (*ImportDocumentsResponse) ProtoMessage 

func (*ImportDocumentsResponse) ProtoMessage()

func (*ImportDocumentsResponse) ProtoReflect 

func (x *ImportDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ImportDocumentsResponse) Reset 

func (x *ImportDocumentsResponse) Reset()

func (*ImportDocumentsResponse) String 

func (x *ImportDocumentsResponse) String() string

type ImportErrorConfig 

type ImportErrorConfig struct {

	// Required. Errors destination.
	//
	// Types that are assignable to Destination:
	//	*ImportErrorConfig_GcsPrefix
	Destination isImportErrorConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Import related errors.

func (*ImportErrorConfig) Descriptor deprecated 

func (*ImportErrorConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportErrorConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorConfig) GetDestination 

func (m *ImportErrorConfig) GetDestination() isImportErrorConfig_Destination

func (*ImportErrorConfig) GetGcsPrefix 

func (x *ImportErrorConfig) GetGcsPrefix() string

func (*ImportErrorConfig) ProtoMessage 

func (*ImportErrorConfig) ProtoMessage()

func (*ImportErrorConfig) ProtoReflect 

func (x *ImportErrorConfig) ProtoReflect() protoreflect.Message

func (*ImportErrorConfig) Reset 

func (x *ImportErrorConfig) Reset()

func (*ImportErrorConfig) String 

func (x *ImportErrorConfig) String() string

type ImportErrorConfig_GcsPrefix 

type ImportErrorConfig_GcsPrefix struct {
	// Cloud Storage prefix for import errors. This must be an empty,
	// existing Cloud Storage directory. Import errors will be written to
	// sharded files in this directory, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

type ImportUserEventsMetadata 

type ImportUserEventsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportUserEventsMetadata) Descriptor deprecated 

func (*ImportUserEventsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*ImportUserEventsMetadata) GetCreateTime 

func (x *ImportUserEventsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportUserEventsMetadata) GetFailureCount 

func (x *ImportUserEventsMetadata) GetFailureCount() int64

func (*ImportUserEventsMetadata) GetSuccessCount 

func (x *ImportUserEventsMetadata) GetSuccessCount() int64

func (*ImportUserEventsMetadata) GetUpdateTime 

func (x *ImportUserEventsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportUserEventsMetadata) ProtoMessage 

func (*ImportUserEventsMetadata) ProtoMessage()

func (*ImportUserEventsMetadata) ProtoReflect 

func (x *ImportUserEventsMetadata) ProtoReflect() protoreflect.Message

func (*ImportUserEventsMetadata) Reset 

func (x *ImportUserEventsMetadata) Reset()

func (*ImportUserEventsMetadata) String 

func (x *ImportUserEventsMetadata) String() string

type ImportUserEventsRequest 

type ImportUserEventsRequest struct {

	// The desired input source of the user event data.
	//
	// Types that are assignable to Source:
	//	*ImportUserEventsRequest_InlineSource_
	//	*ImportUserEventsRequest_GcsSource
	//	*ImportUserEventsRequest_BigquerySource
	Source isImportUserEventsRequest_Source `protobuf_oneof:"source"`
	// Required. Parent DataStore resource name, of the form
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import. Cannot be set
	// for inline user event imports.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor deprecated 

func (*ImportUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetBigquerySource 

func (x *ImportUserEventsRequest) GetBigquerySource() *BigQuerySource

func (*ImportUserEventsRequest) GetErrorConfig 

func (x *ImportUserEventsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportUserEventsRequest) GetGcsSource 

func (x *ImportUserEventsRequest) GetGcsSource() *GcsSource

func (*ImportUserEventsRequest) GetInlineSource 

func (x *ImportUserEventsRequest) GetInlineSource() *ImportUserEventsRequest_InlineSource

func (*ImportUserEventsRequest) GetParent 

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) GetSource 

func (m *ImportUserEventsRequest) GetSource() isImportUserEventsRequest_Source

func (*ImportUserEventsRequest) ProtoMessage 

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect 

func (x *ImportUserEventsRequest) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest) Reset 

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String 

func (x *ImportUserEventsRequest) String() string

type ImportUserEventsRequest_BigquerySource 

type ImportUserEventsRequest_BigquerySource struct {
	// Required. BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportUserEventsRequest_GcsSource 

type ImportUserEventsRequest_GcsSource struct {
	// Required. Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportUserEventsRequest_InlineSource 

type ImportUserEventsRequest_InlineSource struct {

	// Required. A list of user events to import. Recommended max of 10k items.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportUserEvents method.

func (*ImportUserEventsRequest_InlineSource) Descriptor deprecated 

func (*ImportUserEventsRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest_InlineSource) GetUserEvents 

func (x *ImportUserEventsRequest_InlineSource) GetUserEvents() []*UserEvent

func (*ImportUserEventsRequest_InlineSource) ProtoMessage 

func (*ImportUserEventsRequest_InlineSource) ProtoMessage()

func (*ImportUserEventsRequest_InlineSource) ProtoReflect 

func (x *ImportUserEventsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest_InlineSource) Reset 

func (x *ImportUserEventsRequest_InlineSource) Reset()

func (*ImportUserEventsRequest_InlineSource) String 

func (x *ImportUserEventsRequest_InlineSource) String() string

type ImportUserEventsRequest_InlineSource_ 

type ImportUserEventsRequest_InlineSource_ struct {
	// Required. The Inline source for the input content for UserEvents.
	InlineSource *ImportUserEventsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportUserEventsResponse 

type ImportUserEventsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors if this field was set in
	// the request.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// Count of user events imported with complete existing Documents.
	JoinedEventsCount int64 `protobuf:"varint,3,opt,name=joined_events_count,json=joinedEventsCount,proto3" json:"joined_events_count,omitempty"`
	// Count of user events imported, but with Document information not found
	// in the existing Branch.
	UnjoinedEventsCount int64 `protobuf:"varint,4,opt,name=unjoined_events_count,json=unjoinedEventsCount,proto3" json:"unjoined_events_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportUserEventsResponse) Descriptor deprecated 

func (*ImportUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorConfig 

func (x *ImportUserEventsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportUserEventsResponse) GetErrorSamples 

func (x *ImportUserEventsResponse) GetErrorSamples() []*status.Status

func (*ImportUserEventsResponse) GetJoinedEventsCount 

func (x *ImportUserEventsResponse) GetJoinedEventsCount() int64

func (*ImportUserEventsResponse) GetUnjoinedEventsCount 

func (x *ImportUserEventsResponse) GetUnjoinedEventsCount() int64

func (*ImportUserEventsResponse) ProtoMessage 

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) ProtoReflect 

func (x *ImportUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ImportUserEventsResponse) Reset 

func (x *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String 

func (x *ImportUserEventsResponse) String() string

type Interval added in v0.3.0 

type Interval struct {

	// The lower bound of the interval. If neither of the min fields are
	// set, then the lower bound is negative infinity.
	//
	// This field must be not larger than max.
	// Otherwise, an `INVALID_ARGUMENT` error is returned.
	//
	// Types that are assignable to Min:
	//	*Interval_Minimum
	//	*Interval_ExclusiveMinimum
	Min isInterval_Min `protobuf_oneof:"min"`
	// The upper bound of the interval. If neither of the max fields are
	// set, then the upper bound is positive infinity.
	//
	// This field must be not smaller than min.
	// Otherwise, an `INVALID_ARGUMENT` error is returned.
	//
	// Types that are assignable to Max:
	//	*Interval_Maximum
	//	*Interval_ExclusiveMaximum
	Max isInterval_Max `protobuf_oneof:"max"`
	// contains filtered or unexported fields
}

A floating point interval.

func (*Interval) Descriptor deprecated added in v0.3.0 

func (*Interval) Descriptor() ([]byte, []int)

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum added in v0.3.0 

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum added in v0.3.0 

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax added in v0.3.0 

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum added in v0.3.0 

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin added in v0.3.0 

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum added in v0.3.0 

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage added in v0.3.0 

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect added in v0.3.0 

func (x *Interval) ProtoReflect() protoreflect.Message

func (*Interval) Reset added in v0.3.0 

func (x *Interval) Reset()

func (*Interval) String added in v0.3.0 

func (x *Interval) String() string

type Interval_ExclusiveMaximum added in v0.3.0 

type Interval_ExclusiveMaximum struct {
	// Exclusive upper bound.
	ExclusiveMaximum float64 `protobuf:"fixed64,4,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3,oneof"`
}

type Interval_ExclusiveMinimum added in v0.3.0 

type Interval_ExclusiveMinimum struct {
	// Exclusive lower bound.
	ExclusiveMinimum float64 `protobuf:"fixed64,2,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3,oneof"`
}

type Interval_Maximum added in v0.3.0 

type Interval_Maximum struct {
	// Inclusive upper bound.
	Maximum float64 `protobuf:"fixed64,3,opt,name=maximum,proto3,oneof"`
}

type Interval_Minimum added in v0.3.0 

type Interval_Minimum struct {
	// Inclusive lower bound.
	Minimum float64 `protobuf:"fixed64,1,opt,name=minimum,proto3,oneof"`
}

type ListDocumentsRequest 

type ListDocumentsRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Use `default_branch` as the branch ID, to list documents under the default
	// branch.
	//
	// If the caller does not have permission to list [Documents][]s under this
	// branch, regardless of whether or not this branch exists, a
	// `PERMISSION_DENIED` error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
	// to return. If unspecified, defaults to 100. The maximum allowed value is
	// 1000. Values above 1000 will be coerced to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
	// received from a previous
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.

func (*ListDocumentsRequest) Descriptor deprecated 

func (*ListDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetPageSize 

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken 

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent 

func (x *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect 

func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ListDocumentsRequest) Reset 

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (x *ListDocumentsRequest) String() string

type ListDocumentsResponse 

type ListDocumentsResponse struct {

	// The [Document][google.cloud.discoveryengine.v1beta.Document]s.
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// A token that can be sent as
	// [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1beta.ListDocumentsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.

func (*ListDocumentsResponse) Descriptor deprecated 

func (*ListDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocuments 

func (x *ListDocumentsResponse) GetDocuments() []*Document

func (*ListDocumentsResponse) GetNextPageToken 

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect 

func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ListDocumentsResponse) Reset 

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (x *ListDocumentsResponse) String() string

type ListSchemasRequest added in v0.3.0 

type ListSchemasRequest struct {

	// Required. The parent data store resource name, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of [Schema][google.cloud.discoveryengine.v1beta.Schema]s
	// to return. The service may return fewer than this value.
	//
	// If unspecified, at most 100
	// [Schema][google.cloud.discoveryengine.v1beta.Schema]s will be returned.
	//
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.

func (*ListSchemasRequest) Descriptor deprecated added in v0.3.0 

func (*ListSchemasRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListSchemasRequest) GetPageSize added in v0.3.0 

func (x *ListSchemasRequest) GetPageSize() int32

func (*ListSchemasRequest) GetPageToken added in v0.3.0 

func (x *ListSchemasRequest) GetPageToken() string

func (*ListSchemasRequest) GetParent added in v0.3.0 

func (x *ListSchemasRequest) GetParent() string

func (*ListSchemasRequest) ProtoMessage added in v0.3.0 

func (*ListSchemasRequest) ProtoMessage()

func (*ListSchemasRequest) ProtoReflect added in v0.3.0 

func (x *ListSchemasRequest) ProtoReflect() protoreflect.Message

func (*ListSchemasRequest) Reset added in v0.3.0 

func (x *ListSchemasRequest) Reset()

func (*ListSchemasRequest) String added in v0.3.0 

func (x *ListSchemasRequest) String() string

type ListSchemasResponse added in v0.3.0 

type ListSchemasResponse struct {

	// The [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// A token that can be sent as
	// [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1beta.ListSchemasRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.

func (*ListSchemasResponse) Descriptor deprecated added in v0.3.0 

func (*ListSchemasResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListSchemasResponse) GetNextPageToken added in v0.3.0 

func (x *ListSchemasResponse) GetNextPageToken() string

func (*ListSchemasResponse) GetSchemas added in v0.3.0 

func (x *ListSchemasResponse) GetSchemas() []*Schema

func (*ListSchemasResponse) ProtoMessage added in v0.3.0 

func (*ListSchemasResponse) ProtoMessage()

func (*ListSchemasResponse) ProtoReflect added in v0.3.0 

func (x *ListSchemasResponse) ProtoReflect() protoreflect.Message

func (*ListSchemasResponse) Reset added in v0.3.0 

func (x *ListSchemasResponse) Reset()

func (*ListSchemasResponse) String added in v0.3.0 

func (x *ListSchemasResponse) String() string

type MediaInfo 

type MediaInfo struct {

	// The media progress time in seconds, if applicable.
	// For example, if the end user has finished 90 seconds of a playback video,
	// then [MediaInfo.media_progress_duration.seconds][Duration.seconds] should
	// be set to 90.
	MediaProgressDuration *durationpb.Duration `` /* 126-byte string literal not displayed */
	// Media progress should be computed using only the media_progress_duration
	// relative to the media total length.
	//
	// This value must be between `[0, 1.0]` inclusive.
	//
	// If this is not a playback or the progress cannot be computed (e.g. ongoing
	// livestream), this field should be unset.
	MediaProgressPercentage *float32 `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Media-specific user event information.

func (*MediaInfo) Descriptor deprecated 

func (*MediaInfo) Descriptor() ([]byte, []int)

Deprecated: Use MediaInfo.ProtoReflect.Descriptor instead.

func (*MediaInfo) GetMediaProgressDuration 

func (x *MediaInfo) GetMediaProgressDuration() *durationpb.Duration

func (*MediaInfo) GetMediaProgressPercentage 

func (x *MediaInfo) GetMediaProgressPercentage() float32

func (*MediaInfo) ProtoMessage 

func (*MediaInfo) ProtoMessage()

func (*MediaInfo) ProtoReflect 

func (x *MediaInfo) ProtoReflect() protoreflect.Message

func (*MediaInfo) Reset 

func (x *MediaInfo) Reset()

func (*MediaInfo) String 

func (x *MediaInfo) String() string

type PageInfo 

type PageInfo struct {

	// A unique ID of a web page view.
	//
	// This should be kept the same for all user events triggered from the same
	// pageview. For example, an item detail page view could trigger multiple
	// events as the user is browsing the page. The `pageViewId` property should
	// be kept the same for all these events so that they can be grouped together
	// properly.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically.
	PageviewId string `protobuf:"bytes,1,opt,name=pageview_id,json=pageviewId,proto3" json:"pageview_id,omitempty"`
	// The most specific category associated with a category page.
	//
	// To represent full path of category, use '>' sign to separate different
	// hierarchies. If '>' is part of the category name, please replace it with
	// other character(s).
	//
	// Category pages include special pages such as sales or promotions. For
	// instance, a special sale page may have the category hierarchy:
	// "pageCategory" : "Sales > 2017 Black Friday Deals".
	//
	// Required for `view-category-page` events. Other event types should not set
	// this field. Otherwise, an INVALID_ARGUMENT error is returned.
	PageCategory string `protobuf:"bytes,2,opt,name=page_category,json=pageCategory,proto3" json:"page_category,omitempty"`
	// Complete URL (window.location.href) of the user's current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically. Maximum length 5,000
	// characters.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// The referrer URL of the current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically. However, some browser
	// privacy restrictions may cause this field to be empty.
	ReferrerUri string `protobuf:"bytes,4,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`
	// contains filtered or unexported fields
}

Detailed page information.

func (*PageInfo) Descriptor deprecated 

func (*PageInfo) Descriptor() ([]byte, []int)

Deprecated: Use PageInfo.ProtoReflect.Descriptor instead.

func (*PageInfo) GetPageCategory 

func (x *PageInfo) GetPageCategory() string

func (*PageInfo) GetPageviewId 

func (x *PageInfo) GetPageviewId() string

func (*PageInfo) GetReferrerUri 

func (x *PageInfo) GetReferrerUri() string

func (*PageInfo) GetUri 

func (x *PageInfo) GetUri() string

func (*PageInfo) ProtoMessage 

func (*PageInfo) ProtoMessage()

func (*PageInfo) ProtoReflect 

func (x *PageInfo) ProtoReflect() protoreflect.Message

func (*PageInfo) Reset 

func (x *PageInfo) Reset()

func (*PageInfo) String 

func (x *PageInfo) String() string

type PanelInfo 

type PanelInfo struct {

	// Required. The panel ID.
	PanelId string `protobuf:"bytes,2,opt,name=panel_id,json=panelId,proto3" json:"panel_id,omitempty"`
	// The display name of the panel.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The ordered position of the panel, if shown to the user with other panels.
	// If set, then
	// [total_panels][google.cloud.discoveryengine.v1beta.PanelInfo.total_panels]
	// must also be set.
	PanelPosition *int32 `protobuf:"varint,4,opt,name=panel_position,json=panelPosition,proto3,oneof" json:"panel_position,omitempty"`
	// The total number of panels, including this one, shown to the user.
	// Must be set if
	// [panel_position][google.cloud.discoveryengine.v1beta.PanelInfo.panel_position]
	// is set.
	TotalPanels *int32 `protobuf:"varint,5,opt,name=total_panels,json=totalPanels,proto3,oneof" json:"total_panels,omitempty"`
	// contains filtered or unexported fields
}

Detailed panel information associated with a user event.

func (*PanelInfo) Descriptor deprecated 

func (*PanelInfo) Descriptor() ([]byte, []int)

Deprecated: Use PanelInfo.ProtoReflect.Descriptor instead.

func (*PanelInfo) GetDisplayName 

func (x *PanelInfo) GetDisplayName() string

func (*PanelInfo) GetPanelId 

func (x *PanelInfo) GetPanelId() string

func (*PanelInfo) GetPanelPosition 

func (x *PanelInfo) GetPanelPosition() int32

func (*PanelInfo) GetTotalPanels 

func (x *PanelInfo) GetTotalPanels() int32

func (*PanelInfo) ProtoMessage 

func (*PanelInfo) ProtoMessage()

func (*PanelInfo) ProtoReflect 

func (x *PanelInfo) ProtoReflect() protoreflect.Message

func (*PanelInfo) Reset 

func (x *PanelInfo) Reset()

func (*PanelInfo) String 

func (x *PanelInfo) String() string

type PurgeDocumentsMetadata added in v0.3.1 

type PurgeDocumentsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were deleted successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*PurgeDocumentsMetadata) Descriptor deprecated added in v0.3.1 

func (*PurgeDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PurgeDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsMetadata) GetCreateTime added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*PurgeDocumentsMetadata) GetFailureCount added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetFailureCount() int64

func (*PurgeDocumentsMetadata) GetSuccessCount added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetSuccessCount() int64

func (*PurgeDocumentsMetadata) GetUpdateTime added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*PurgeDocumentsMetadata) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsMetadata) ProtoMessage()

func (*PurgeDocumentsMetadata) ProtoReflect added in v0.3.1 

func (x *PurgeDocumentsMetadata) ProtoReflect() protoreflect.Message

func (*PurgeDocumentsMetadata) Reset added in v0.3.1 

func (x *PurgeDocumentsMetadata) Reset()

func (*PurgeDocumentsMetadata) String added in v0.3.1 

func (x *PurgeDocumentsMetadata) String() string

type PurgeDocumentsRequest added in v0.3.1 

type PurgeDocumentsRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Filter matching documents to purge. Only currently supported
	// value is
	// `*` (all items).
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Actually performs the purge. If `force` is set to false, return the
	// expected purge count without deleting any documents.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.

func (*PurgeDocumentsRequest) Descriptor deprecated added in v0.3.1 

func (*PurgeDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest) GetFilter added in v0.3.1 

func (x *PurgeDocumentsRequest) GetFilter() string

func (*PurgeDocumentsRequest) GetForce added in v0.3.1 

func (x *PurgeDocumentsRequest) GetForce() bool

func (*PurgeDocumentsRequest) GetParent added in v0.3.1 

func (x *PurgeDocumentsRequest) GetParent() string

func (*PurgeDocumentsRequest) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsRequest) ProtoMessage()

func (*PurgeDocumentsRequest) ProtoReflect added in v0.3.1 

func (x *PurgeDocumentsRequest) ProtoReflect() protoreflect.Message

func (*PurgeDocumentsRequest) Reset added in v0.3.1 

func (x *PurgeDocumentsRequest) Reset()

func (*PurgeDocumentsRequest) String added in v0.3.1 

func (x *PurgeDocumentsRequest) String() string

type PurgeDocumentsResponse added in v0.3.1 

type PurgeDocumentsResponse struct {

	// The total count of documents purged as a result of the operation.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// A sample of document names that will be deleted. Only populated if `force`
	// is set to false. A max of 100 names will be returned and the names are
	// chosen at random.
	PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

func (*PurgeDocumentsResponse) Descriptor deprecated added in v0.3.1 

func (*PurgeDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeDocumentsResponse.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsResponse) GetPurgeCount added in v0.3.1 

func (x *PurgeDocumentsResponse) GetPurgeCount() int64

func (*PurgeDocumentsResponse) GetPurgeSample added in v0.3.1 

func (x *PurgeDocumentsResponse) GetPurgeSample() []string

func (*PurgeDocumentsResponse) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsResponse) ProtoMessage()

func (*PurgeDocumentsResponse) ProtoReflect added in v0.3.1 

func (x *PurgeDocumentsResponse) ProtoReflect() protoreflect.Message

func (*PurgeDocumentsResponse) Reset added in v0.3.1 

func (x *PurgeDocumentsResponse) Reset()

func (*PurgeDocumentsResponse) String added in v0.3.1 

func (x *PurgeDocumentsResponse) String() string

type RecommendRequest 

type RecommendRequest struct {

	// Required. Full resource name of the format:
	// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
	//
	// Before you can request recommendations from your model, you must create at
	// least one serving config  for it.
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. Context about the user, what they are looking at and what action
	// they took to trigger the Recommend request. Note that this user event
	// detail won't be ingested to userEvent logs. Thus, a separate userEvent
	// write request is required for event logging.
	//
	// Don't set
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// or
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
	// to the same fixed ID for different users. If you are trying to receive
	// non-personalized recommendations (not recommended; this can negatively
	// impact model performance), instead set
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// to a random unique ID and leave
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
	// unset.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// Maximum number of results to return. Set this property
	// to the number of recommendation results needed. If zero, the service will
	// choose a reasonable default. The maximum allowed value is 100. Values
	// above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Filter for restricting recommendation results with a length limit of 5,000
	// characters. Currently, only filter expressions on the `filter_tags`
	// attribute is supported.
	//
	//
	// Examples:
	//
	//  * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
	//  * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
	//
	// If your filter blocks all results, the API will return generic
	// (unfiltered) popular Documents. If you only want results strictly matching
	// the filters, set `strictFiltering` to True in
	// [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
	// to receive empty results instead.
	//
	// Note that the API will never return
	// [Document][google.cloud.discoveryengine.v1beta.Document]s with
	// `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Use validate only mode for this recommendation query. If set to true, a
	// fake model will be used that returns arbitrary Document IDs.
	// Note that the validate only mode should only be used for testing the API,
	// or if the model is not ready.
	ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Additional domain specific parameters for the recommendations.
	//
	// Allowed values:
	//
	// * `returnDocument`: Boolean. If set to true, the associated Document
	//    object will be returned in
	//    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
	// * `returnScore`: Boolean. If set to true, the recommendation 'score'
	//    corresponding to each returned Document will be set in
	//    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
	//    The given 'score' indicates the probability of a Document conversion
	//    given the user's context and history.
	// * `strictFiltering`: Boolean. True by default. If set to false, the service
	//    will return generic (unfiltered) popular Documents instead of empty if
	//    your filter blocks all recommendation results.
	// * `diversityLevel`: String. Default empty. If set to be non-empty, then
	//    it needs to be one of:
	//     *  `no-diversity`
	//     *  `low-diversity`
	//     *  `medium-diversity`
	//     *  `high-diversity`
	//     *  `auto-diversity`
	//    This gives request-level control and adjusts recommendation results
	//    based on Document category.
	Params map[string]*structpb.Value `` /* 153-byte string literal not displayed */
	// The user labels applied to a resource must meet the following requirements:
	//
	// * Each resource can have multiple labels, up to a maximum of 64.
	// * Each label must be a key-value pair.
	// * Keys have a minimum length of 1 character and a maximum length of 63
	//   characters and cannot be empty. Values can be empty and have a maximum
	//   length of 63 characters.
	// * Keys and values can contain only lowercase letters, numeric characters,
	//   underscores, and dashes. All characters must use UTF-8 encoding, and
	//   international characters are allowed.
	// * The key portion of a label must be unique. However, you can use the same
	//   key with multiple resources.
	// * Keys must start with a lowercase letter or international character.
	//
	// See [Requirements for
	// labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for Recommend method.

func (*RecommendRequest) Descriptor deprecated 

func (*RecommendRequest) Descriptor() ([]byte, []int)

Deprecated: Use RecommendRequest.ProtoReflect.Descriptor instead.

func (*RecommendRequest) GetFilter 

func (x *RecommendRequest) GetFilter() string

func (*RecommendRequest) GetPageSize 

func (x *RecommendRequest) GetPageSize() int32

func (*RecommendRequest) GetParams 

func (x *RecommendRequest) GetParams() map[string]*structpb.Value

func (*RecommendRequest) GetServingConfig 

func (x *RecommendRequest) GetServingConfig() string

func (*RecommendRequest) GetUserEvent 

func (x *RecommendRequest) GetUserEvent() *UserEvent

func (*RecommendRequest) GetUserLabels 

func (x *RecommendRequest) GetUserLabels() map[string]string

func (*RecommendRequest) GetValidateOnly 

func (x *RecommendRequest) GetValidateOnly() bool

func (*RecommendRequest) ProtoMessage 

func (*RecommendRequest) ProtoMessage()

func (*RecommendRequest) ProtoReflect 

func (x *RecommendRequest) ProtoReflect() protoreflect.Message

func (*RecommendRequest) Reset 

func (x *RecommendRequest) Reset()

func (*RecommendRequest) String 

func (x *RecommendRequest) String() string

type RecommendResponse 

type RecommendResponse struct {

	// A list of recommended Documents. The order represents the ranking (from the
	// most relevant Document to the least).
	Results []*RecommendResponse_RecommendationResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// A unique attribution token. This should be included in the
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
	// from this recommendation, which enables accurate attribution of
	// recommendation model performance.
	AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// IDs of documents in the request that were missing from the default Branch
	// associated with the requested ServingConfig.
	MissingIds []string `protobuf:"bytes,3,rep,name=missing_ids,json=missingIds,proto3" json:"missing_ids,omitempty"`
	// True if
	// [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
	// was set.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Response message for Recommend method.

func (*RecommendResponse) Descriptor deprecated 

func (*RecommendResponse) Descriptor() ([]byte, []int)

Deprecated: Use RecommendResponse.ProtoReflect.Descriptor instead.

func (*RecommendResponse) GetAttributionToken 

func (x *RecommendResponse) GetAttributionToken() string

func (*RecommendResponse) GetMissingIds 

func (x *RecommendResponse) GetMissingIds() []string

func (*RecommendResponse) GetResults 

func (x *RecommendResponse) GetResults() []*RecommendResponse_RecommendationResult

func (*RecommendResponse) GetValidateOnly 

func (x *RecommendResponse) GetValidateOnly() bool

func (*RecommendResponse) ProtoMessage 

func (*RecommendResponse) ProtoMessage()

func (*RecommendResponse) ProtoReflect 

func (x *RecommendResponse) ProtoReflect() protoreflect.Message

func (*RecommendResponse) Reset 

func (x *RecommendResponse) Reset()

func (*RecommendResponse) String 

func (x *RecommendResponse) String() string

type RecommendResponse_RecommendationResult 

type RecommendResponse_RecommendationResult struct {

	// Resource ID of the recommended Document.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Set if `returnDocument` is set to true in
	// [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Additional Document metadata / annotations.
	//
	// Possible values:
	//
	// * `score`: Recommendation score in double value. Is set if
	//   `returnScore` is set to true in
	//   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
	Metadata map[string]*structpb.Value `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

RecommendationResult represents a generic recommendation result with associated metadata.

func (*RecommendResponse_RecommendationResult) Descriptor deprecated 

func (*RecommendResponse_RecommendationResult) Descriptor() ([]byte, []int)

Deprecated: Use RecommendResponse_RecommendationResult.ProtoReflect.Descriptor instead.

func (*RecommendResponse_RecommendationResult) GetDocument 

func (x *RecommendResponse_RecommendationResult) GetDocument() *Document

func (*RecommendResponse_RecommendationResult) GetId 

func (x *RecommendResponse_RecommendationResult) GetId() string

func (*RecommendResponse_RecommendationResult) GetMetadata 

func (x *RecommendResponse_RecommendationResult) GetMetadata() map[string]*structpb.Value

func (*RecommendResponse_RecommendationResult) ProtoMessage 

func (*RecommendResponse_RecommendationResult) ProtoMessage()

func (*RecommendResponse_RecommendationResult) ProtoReflect 

func (x *RecommendResponse_RecommendationResult) ProtoReflect() protoreflect.Message

func (*RecommendResponse_RecommendationResult) Reset 

func (x *RecommendResponse_RecommendationResult) Reset()

func (*RecommendResponse_RecommendationResult) String 

func (x *RecommendResponse_RecommendationResult) String() string

type RecommendationServiceClient 

type RecommendationServiceClient interface {
	// Makes a recommendation, which requires a contextual user event.
	Recommend(ctx context.Context, in *RecommendRequest, opts ...grpc.CallOption) (*RecommendResponse, error)
}

RecommendationServiceClient is the client API for RecommendationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRecommendationServiceClient 

func NewRecommendationServiceClient(cc grpc.ClientConnInterface) RecommendationServiceClient

type RecommendationServiceServer 

type RecommendationServiceServer interface {
	// Makes a recommendation, which requires a contextual user event.
	Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)
}

RecommendationServiceServer is the server API for RecommendationService service.

type Schema added in v0.3.0 

type Schema struct {

	// Schema representation. One of
	// [struct_schema][google.cloud.discoveryengine.v1beta.Schema.struct_schema]
	// or [json_schema][google.cloud.discoveryengine.v1beta.Schema.json_schema]
	// should be provided otherwise an INVALID_ARGUMENT error is thrown.
	//
	// Types that are assignable to Schema:
	//	*Schema_StructSchema
	//	*Schema_JsonSchema
	Schema isSchema_Schema `protobuf_oneof:"schema"`
	// Immutable. The full resource name of the schema, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Defines the structure and layout of a type of document data.

func (*Schema) Descriptor deprecated added in v0.3.0 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetJsonSchema added in v0.3.0 

func (x *Schema) GetJsonSchema() string

func (*Schema) GetName added in v0.3.0 

func (x *Schema) GetName() string

func (*Schema) GetSchema added in v0.3.0 

func (m *Schema) GetSchema() isSchema_Schema

func (*Schema) GetStructSchema added in v0.3.0 

func (x *Schema) GetStructSchema() *structpb.Struct

func (*Schema) ProtoMessage added in v0.3.0 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect added in v0.3.0 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset added in v0.3.0 

func (x *Schema) Reset()

func (*Schema) String added in v0.3.0 

func (x *Schema) String() string

type SchemaServiceClient added in v0.3.0 

type SchemaServiceClient interface {
	// Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	GetSchema(ctx context.Context, in *GetSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
	// Gets a list of [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
	ListSchemas(ctx context.Context, in *ListSchemasRequest, opts ...grpc.CallOption) (*ListSchemasResponse, error)
	// Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	CreateSchema(ctx context.Context, in *CreateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	UpdateSchema(ctx context.Context, in *UpdateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	DeleteSchema(ctx context.Context, in *DeleteSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

SchemaServiceClient is the client API for SchemaService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSchemaServiceClient added in v0.3.0 

func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient

type SchemaServiceServer added in v0.3.0 

type SchemaServiceServer interface {
	// Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)
	// Gets a list of [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
	ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)
	// Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)
	// Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)
	// Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema].
	DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)
}

SchemaServiceServer is the server API for SchemaService service.

type Schema_JsonSchema added in v0.3.0 

type Schema_JsonSchema struct {
	// The JSON representation of the schema.
	JsonSchema string `protobuf:"bytes,3,opt,name=json_schema,json=jsonSchema,proto3,oneof"`
}

type Schema_StructSchema added in v0.3.0 

type Schema_StructSchema struct {
	// The structured representation of the schema.
	StructSchema *structpb.Struct `protobuf:"bytes,2,opt,name=struct_schema,json=structSchema,proto3,oneof"`
}

type SearchInfo 

type SearchInfo struct {

	// The user's search query.
	//
	// See
	// [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
	// for definition.
	//
	// The value must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// At least one of
	// [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
	// or
	// [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
	// is required for `search` events. Other event types should not set this
	// field. Otherwise, an INVALID_ARGUMENT error is returned.
	SearchQuery string `protobuf:"bytes,1,opt,name=search_query,json=searchQuery,proto3" json:"search_query,omitempty"`
	// The order in which products are returned, if applicable.
	//
	// See
	// [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
	// for definition and syntax.
	//
	// The value must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// This can only be set for `search` events. Other event types should not set
	// this field. Otherwise, an INVALID_ARGUMENT error is returned.
	OrderBy string `protobuf:"bytes,2,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// An integer that specifies the current offset for pagination (the 0-indexed
	// starting location, amongst the products deemed by the API as relevant).
	//
	// See
	// [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
	// for definition.
	//
	// If this field is negative, an INVALID_ARGUMENT is returned.
	//
	// This can only be set for `search` events. Other event types should not set
	// this field. Otherwise, an INVALID_ARGUMENT error is returned.
	Offset *int32 `protobuf:"varint,3,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

Detailed search information.

func (*SearchInfo) Descriptor deprecated 

func (*SearchInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchInfo.ProtoReflect.Descriptor instead.

func (*SearchInfo) GetOffset 

func (x *SearchInfo) GetOffset() int32

func (*SearchInfo) GetOrderBy 

func (x *SearchInfo) GetOrderBy() string

func (*SearchInfo) GetSearchQuery 

func (x *SearchInfo) GetSearchQuery() string

func (*SearchInfo) ProtoMessage 

func (*SearchInfo) ProtoMessage()

func (*SearchInfo) ProtoReflect 

func (x *SearchInfo) ProtoReflect() protoreflect.Message

func (*SearchInfo) Reset 

func (x *SearchInfo) Reset()

func (*SearchInfo) String 

func (x *SearchInfo) String() string

type SearchRequest added in v0.3.0 

type SearchRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
	// This field is used to identify the serving configuration name, set
	// of models used to make the search.
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// The branch resource name, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
	//
	// Use `default_branch` as the branch ID or leave this field empty, to search
	// documents under the default branch.
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// Raw search query.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
	// to return. If unspecified, defaults to a reasonable value. The maximum
	// allowed value is 100. Values above 100 will be coerced to 100.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token received from a previous
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// must match the call that provided the page token. Otherwise, an
	//  `INVALID_ARGUMENT`  error is returned.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A 0-indexed integer that specifies the current offset (that is, starting
	// result location, amongst the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s deemed by the API
	// as relevant) in search results. This field is only considered if
	// [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
	// is unset.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
	// The filter syntax consists of an expression language for constructing a
	// predicate from one or more fields of the documents being filtered. Filter
	// expression is case-sensitive.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	Filter string `protobuf:"bytes,7,opt,name=filter,proto3" json:"filter,omitempty"`
	// The order in which documents are returned. Document can be ordered by
	// a field in an [Document][google.cloud.discoveryengine.v1beta.Document]
	// object. Leave it unset if ordered by relevance. OrderBy expression is
	// case-sensitive.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	OrderBy string `protobuf:"bytes,8,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Information about the end user.
	// Highly recommended for analytics. The user_agent string in UserInfo will
	// be used to deduce device_type for analytics.
	UserInfo *UserInfo `protobuf:"bytes,21,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// Facet specifications for faceted search. If empty, no facets are returned.
	//
	// A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
	// error is returned.
	FacetSpecs []*SearchRequest_FacetSpec `protobuf:"bytes,9,rep,name=facet_specs,json=facetSpecs,proto3" json:"facet_specs,omitempty"`
	// Boost specification to boost certain documents.
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// Additional search parameters.
	//
	// For public website search only, supported values are:
	//
	// * `user_country_code`: string. Default empty. If set to non-empty, results
	//    are restricted or boosted based on the location provided.
	// * `search_type`: double. Default empty. Enables non-webpage searching
	//   depending on the value. The only valid non-default value is 1,
	//   which enables image searching.
	Params map[string]*structpb.Value `` /* 154-byte string literal not displayed */
	// The query expansion specification that specifies the conditions under which
	// query expansion will occur.
	QueryExpansionSpec *SearchRequest_QueryExpansionSpec `protobuf:"bytes,13,opt,name=query_expansion_spec,json=queryExpansionSpec,proto3" json:"query_expansion_spec,omitempty"`
	// The spell correction specification that specifies the mode under
	// which spell correction will take effect.
	SpellCorrectionSpec *SearchRequest_SpellCorrectionSpec `protobuf:"bytes,14,opt,name=spell_correction_spec,json=spellCorrectionSpec,proto3" json:"spell_correction_spec,omitempty"`
	// A unique identifier for tracking visitors. For example, this could be
	// implemented with an HTTP cookie, which should be able to uniquely identify
	// a visitor on a single device. This unique identifier should not change if
	// the visitor logs in or out of the website.
	//
	// This field should NOT have a fixed value such as `unknown_visitor`.
	//
	// This should be the same identifier as
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// and
	// [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id]
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
	UserPseudoId string `protobuf:"bytes,15,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// The content search spec that configs the desired behavior of content
	// search.
	ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,24,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
	// Whether to turn on safe search. This is only supported for
	// [ContentConfig.PUBLIC_WEBSITE][].
	SafeSearch bool `protobuf:"varint,20,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	// * Each resource can have multiple labels, up to a maximum of 64.
	// * Each label must be a key-value pair.
	// * Keys have a minimum length of 1 character and a maximum length of 63
	//   characters and cannot be empty. Values can be empty and have a maximum
	//   length of 63 characters.
	// * Keys and values can contain only lowercase letters, numeric characters,
	//   underscores, and dashes. All characters must use UTF-8 encoding, and
	//   international characters are allowed.
	// * The key portion of a label must be unique. However, you can use the same
	//   key with multiple resources.
	// * Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.

func (*SearchRequest) Descriptor deprecated added in v0.3.0 

func (*SearchRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBoostSpec added in v0.3.0 

func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*SearchRequest) GetBranch added in v0.3.0 

func (x *SearchRequest) GetBranch() string

func (*SearchRequest) GetContentSearchSpec added in v0.3.0 

func (x *SearchRequest) GetContentSearchSpec() *SearchRequest_ContentSearchSpec

func (*SearchRequest) GetFacetSpecs added in v0.3.0 

func (x *SearchRequest) GetFacetSpecs() []*SearchRequest_FacetSpec

func (*SearchRequest) GetFilter added in v0.3.0 

func (x *SearchRequest) GetFilter() string

func (*SearchRequest) GetOffset added in v0.3.0 

func (x *SearchRequest) GetOffset() int32

func (*SearchRequest) GetOrderBy added in v0.3.0 

func (x *SearchRequest) GetOrderBy() string

func (*SearchRequest) GetPageSize added in v0.3.0 

func (x *SearchRequest) GetPageSize() int32

func (*SearchRequest) GetPageToken added in v0.3.0 

func (x *SearchRequest) GetPageToken() string

func (*SearchRequest) GetParams added in v0.3.0 

func (x *SearchRequest) GetParams() map[string]*structpb.Value

func (*SearchRequest) GetQuery added in v0.3.0 

func (x *SearchRequest) GetQuery() string

func (*SearchRequest) GetQueryExpansionSpec added in v0.3.0 

func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpec

func (*SearchRequest) GetSafeSearch added in v0.4.0 

func (x *SearchRequest) GetSafeSearch() bool

func (*SearchRequest) GetServingConfig added in v0.3.0 

func (x *SearchRequest) GetServingConfig() string

func (*SearchRequest) GetSpellCorrectionSpec added in v0.3.0 

func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpec

func (*SearchRequest) GetUserInfo added in v0.4.0 

func (x *SearchRequest) GetUserInfo() *UserInfo

func (*SearchRequest) GetUserLabels added in v0.4.0 

func (x *SearchRequest) GetUserLabels() map[string]string

func (*SearchRequest) GetUserPseudoId added in v0.3.0 

func (x *SearchRequest) GetUserPseudoId() string

func (*SearchRequest) ProtoMessage added in v0.3.0 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect added in v0.3.0 

func (x *SearchRequest) ProtoReflect() protoreflect.Message

func (*SearchRequest) Reset added in v0.3.0 

func (x *SearchRequest) Reset()

func (*SearchRequest) String added in v0.3.0 

func (x *SearchRequest) String() string

type SearchRequest_BoostSpec added in v0.3.0 

type SearchRequest_BoostSpec struct {

	// Condition boost specifications. If a document matches multiple conditions
	// in the specifictions, boost scores from these specifications are all
	// applied and combined in a non-linear way. Maximum number of
	// specifications is 20.
	ConditionBoostSpecs []*SearchRequest_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`
	// contains filtered or unexported fields
}

Boost specification to boost certain documents.

func (*SearchRequest_BoostSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_BoostSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec) GetConditionBoostSpecs added in v0.3.0 

func (x *SearchRequest_BoostSpec) GetConditionBoostSpecs() []*SearchRequest_BoostSpec_ConditionBoostSpec

func (*SearchRequest_BoostSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_BoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_BoostSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec) Reset added in v0.3.0 

func (x *SearchRequest_BoostSpec) Reset()

func (*SearchRequest_BoostSpec) String added in v0.3.0 

func (x *SearchRequest_BoostSpec) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec added in v0.3.0 

type SearchRequest_BoostSpec_ConditionBoostSpec struct {

	// An expression which specifies a boost condition. The syntax and
	// supported fields are the same as a filter expression. See
	// [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost documents with document ID "doc_1" or "doc_2", and
	// color
	//   "Red" or "Blue":
	//     * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
	Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
	// Strength of the condition boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0.
	//
	// Setting to 1.0 gives the document a big promotion. However, it does not
	// necessarily mean that the boosted document will be the top result at
	// all times, nor that other documents will be excluded. Results could
	// still be shown even when none of them matches the condition. And
	// results that are significantly more relevant to the search query can
	// still trump your heavily favored but irrelevant documents.
	//
	// Setting to -1.0 gives the document a big demotion. However, results
	// that are deeply relevant might still be shown. The document will have
	// an upstream battle to get a fairly high ranking, but it is not blocked
	// out completely.
	//
	// Setting to 0.0 means no boost applied. The boosting condition is
	// ignored.
	Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
	// contains filtered or unexported fields
}

Boost applies to documents which match a condition.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition() string

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) Reset()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) String added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) String() string

type SearchRequest_ContentSearchSpec added in v0.3.0 

type SearchRequest_ContentSearchSpec struct {

	// If there is no snippet spec provided, there will be no snippet in the
	// search result.
	SnippetSpec *SearchRequest_ContentSearchSpec_SnippetSpec `protobuf:"bytes,1,opt,name=snippet_spec,json=snippetSpec,proto3" json:"snippet_spec,omitempty"`
	// If there is no summary spec provided, there will be no summary in the
	// search response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,2,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
	// contains filtered or unexported fields
}

The specification that configs the desired behavior of the UCS content search.

func (*SearchRequest_ContentSearchSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_ContentSearchSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec) GetSnippetSpec added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) GetSnippetSpec() *SearchRequest_ContentSearchSpec_SnippetSpec

func (*SearchRequest_ContentSearchSpec) GetSummarySpec added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec

func (*SearchRequest_ContentSearchSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) Reset()

func (*SearchRequest_ContentSearchSpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) String() string

type SearchRequest_ContentSearchSpec_SnippetSpec added in v0.3.0 

type SearchRequest_ContentSearchSpec_SnippetSpec struct {

	// Max number of snippets returned in each search result.
	// If the matching snippets is less than the max_snippet_count, return all
	// of the snippets; otherwise, return the max_snippet_count.
	//
	// At most 5 snippets will be returned for each SearchResult.
	MaxSnippetCount int32 `protobuf:"varint,1,opt,name=max_snippet_count,json=maxSnippetCount,proto3" json:"max_snippet_count,omitempty"`
	// if true, only snippet reference is returned.
	ReferenceOnly bool `protobuf:"varint,2,opt,name=reference_only,json=referenceOnly,proto3" json:"reference_only,omitempty"`
	// contains filtered or unexported fields
}

The specification that configs the snippet in the search results.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SnippetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount() int32

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() bool

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) Reset()

func (*SearchRequest_ContentSearchSpec_SnippetSpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) String() string

type SearchRequest_ContentSearchSpec_SummarySpec added in v0.3.0 

type SearchRequest_ContentSearchSpec_SummarySpec struct {

	// The number of top results the summary should be generated from.
	// If the number of returned results is less than summary_result_count,
	// then the summary would be derived from all the results; otherwise, the
	// summary would be derived from the top results.
	//
	// At most 5 results can be used for generating summary.
	SummaryResultCount int32 `protobuf:"varint,1,opt,name=summary_result_count,json=summaryResultCount,proto3" json:"summary_result_count,omitempty"`
	// contains filtered or unexported fields
}

The specification that configs the summary in the search response.

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount() int32

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SummarySpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) Reset()

func (*SearchRequest_ContentSearchSpec_SummarySpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) String() string

type SearchRequest_FacetSpec added in v0.3.0 

type SearchRequest_FacetSpec struct {

	// Required. The facet key specification.
	FacetKey *SearchRequest_FacetSpec_FacetKey `protobuf:"bytes,1,opt,name=facet_key,json=facetKey,proto3" json:"facet_key,omitempty"`
	// Maximum of facet values that should be returned for this facet. If
	// unspecified, defaults to 20. The maximum allowed value is 300. Values
	// above 300 will be coerced to 300.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// List of keys to exclude when faceting.
	//
	//
	// By default,
	// [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key]
	// is not excluded from the filter unless it is listed in this field.
	//
	// Listing a facet key in this field allows its values to appear as facet
	// results, even when they are filtered out of search results. Using this
	// field does not affect what search results are returned.
	//
	// For example, suppose there are 100 documents with the color facet "Red"
	// and 200 documents with the color facet "Blue". A query containing the
	// filter "color:ANY("Red")" and having "color" as
	// [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key]
	// would by default return only "Red" documents in the search results, and
	// also return "Red" with count 100 as the only color facet. Although there
	// are also blue documents available, "Blue" would not be shown as an
	// available facet value.
	//
	// If "color" is listed in "excludedFilterKeys", then the query returns the
	// facet values "Red" with count 100 and "Blue" with count 200, because the
	// "color" key is now excluded from the filter. Because this field doesn't
	// affect search results, the search results are still correctly filtered to
	// return only "Red" documents.
	//
	// A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
	// error is returned.
	ExcludedFilterKeys []string `protobuf:"bytes,3,rep,name=excluded_filter_keys,json=excludedFilterKeys,proto3" json:"excluded_filter_keys,omitempty"`
	// Enables dynamic position for this facet. If set to true, the position of
	// this facet among all facets in the response is determined automatically.
	// It will be ordered together with dynamic facets if dynamic
	// facets is enabled. If set to false, the position of this facet in the
	// response will be the same as in the request, and it will be ranked before
	// the facets with dynamic position enable and all dynamic facets.
	//
	// For example, you may always want to have rating facet returned in
	// the response, but it's not necessarily to always display the rating facet
	// at the top. In that case, you can set enable_dynamic_position to true so
	// that the position of rating facet in response will be determined
	// automatically.
	//
	// Another example, assuming you have the following facets in the request:
	//
	// * "rating", enable_dynamic_position = true
	//
	// * "price", enable_dynamic_position = false
	//
	// * "brands", enable_dynamic_position = false
	//
	// And also you have a dynamic facets enable, which will generate a facet
	// 'gender'. Then the final order of the facets in the response can be
	// ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
	// "rating") depends on how API orders "gender" and "rating" facets.
	// However, notice that "price" and "brands" will always be
	// ranked at 1st and 2nd position since their enable_dynamic_position are
	// false.
	EnableDynamicPosition bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A facet specification to perform faceted search.

func (*SearchRequest_FacetSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_FacetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec) GetEnableDynamicPosition added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() bool

func (*SearchRequest_FacetSpec) GetExcludedFilterKeys added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetExcludedFilterKeys() []string

func (*SearchRequest_FacetSpec) GetFacetKey added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetFacetKey() *SearchRequest_FacetSpec_FacetKey

func (*SearchRequest_FacetSpec) GetLimit added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetLimit() int32

func (*SearchRequest_FacetSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_FacetSpec) ProtoMessage()

func (*SearchRequest_FacetSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_FacetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec) Reset added in v0.3.0 

func (x *SearchRequest_FacetSpec) Reset()

func (*SearchRequest_FacetSpec) String added in v0.3.0 

func (x *SearchRequest_FacetSpec) String() string

type SearchRequest_FacetSpec_FacetKey added in v0.3.0 

type SearchRequest_FacetSpec_FacetKey struct {

	// Required. Supported textual and numerical facet keys in
	// [Document][google.cloud.discoveryengine.v1beta.Document] object, over
	// which the facet values are computed. Facet key is case-sensitive.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Set only if values should be bucketized into intervals. Must be set
	// for facets with numerical values. Must not be set for facet with text
	// values. Maximum number of intervals is 30.
	Intervals []*Interval `protobuf:"bytes,2,rep,name=intervals,proto3" json:"intervals,omitempty"`
	// Only get facet for the given restricted values. Only supported on
	// textual fields. For example, suppose "category" has three values
	// "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
	// "restricted_values" to "Action > 2022", the "category" facet will only
	// contain "Action > 2022". Only supported on textual fields. Maximum
	// is 10.
	RestrictedValues []string `protobuf:"bytes,3,rep,name=restricted_values,json=restrictedValues,proto3" json:"restricted_values,omitempty"`
	// Only get facet values that start with the given string prefix. For
	// example, suppose "category" has three values "Action > 2022",
	// "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
	// "category" facet will only contain "Action > 2022" and "Action > 2021".
	// Only supported on textual fields. Maximum is 10.
	Prefixes []string `protobuf:"bytes,4,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
	// Only get facet values that contains the given strings. For example,
	// suppose "category" has three values "Action > 2022",
	// "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
	// "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
	// Only supported on textual fields. Maximum is 10.
	Contains []string `protobuf:"bytes,5,rep,name=contains,proto3" json:"contains,omitempty"`
	// True to make facet keys case insensitive when getting faceting
	// values with prefixes or contains; false otherwise.
	CaseInsensitive bool `protobuf:"varint,6,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"`
	// The order in which documents are returned.
	//
	// Allowed values are:
	//
	// * "count desc", which means order by
	// [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.count]
	// descending.
	//
	// * "value desc", which means order by
	// [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.value]
	// descending.
	//   Only applies to textual facets.
	//
	// If not set, textual values are sorted in [natural
	// order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
	// intervals are sorted in the order given by
	// [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
	OrderBy string `protobuf:"bytes,7,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Specifies how a facet is computed.

func (*SearchRequest_FacetSpec_FacetKey) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_FacetSpec_FacetKey) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() bool

func (*SearchRequest_FacetSpec_FacetKey) GetContains added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetContains() []string

func (*SearchRequest_FacetSpec_FacetKey) GetIntervals added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetIntervals() []*Interval

func (*SearchRequest_FacetSpec_FacetKey) GetKey added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetKey() string

func (*SearchRequest_FacetSpec_FacetKey) GetOrderBy added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string

func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetPrefixes() []string

func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetRestrictedValues() []string

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage added in v0.3.0 

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()

func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec_FacetKey) Reset added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) Reset()

func (*SearchRequest_FacetSpec_FacetKey) String added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) String() string

type SearchRequest_QueryExpansionSpec added in v0.3.0 

type SearchRequest_QueryExpansionSpec struct {

	// The condition under which query expansion should occur. Default to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	Condition SearchRequest_QueryExpansionSpec_Condition `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specification to determine under which conditions query expansion should occur.

func (*SearchRequest_QueryExpansionSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_QueryExpansionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_QueryExpansionSpec) GetCondition added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) GetCondition() SearchRequest_QueryExpansionSpec_Condition

func (*SearchRequest_QueryExpansionSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_QueryExpansionSpec) ProtoMessage()

func (*SearchRequest_QueryExpansionSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_QueryExpansionSpec) Reset added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) Reset()

func (*SearchRequest_QueryExpansionSpec) String added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) String() string

type SearchRequest_QueryExpansionSpec_Condition added in v0.3.0 

type SearchRequest_QueryExpansionSpec_Condition int32

Enum describing under which condition query expansion should occur. 

const (
	// Unspecified query expansion condition. In this case, server behavior
	// defaults to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED SearchRequest_QueryExpansionSpec_Condition = 0
	// Disabled query expansion. Only the exact search query is used, even if
	// [SearchResponse.total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size]
	// is zero.
	SearchRequest_QueryExpansionSpec_DISABLED SearchRequest_QueryExpansionSpec_Condition = 1
	// Automatic query expansion built by the Search API.
	SearchRequest_QueryExpansionSpec_AUTO SearchRequest_QueryExpansionSpec_Condition = 2
)

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_QueryExpansionSpec_Condition) Enum added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) Enum() *SearchRequest_QueryExpansionSpec_Condition

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor deprecated added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.

func (SearchRequest_QueryExpansionSpec_Condition) Number added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) Number() protoreflect.EnumNumber

func (SearchRequest_QueryExpansionSpec_Condition) String added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) String() string

func (SearchRequest_QueryExpansionSpec_Condition) Type added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) Type() protoreflect.EnumType

type SearchRequest_SpellCorrectionSpec added in v0.3.0 

type SearchRequest_SpellCorrectionSpec struct {

	// The mode under which spell correction should take effect to
	// replace the original search query. Default to
	// [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	Mode SearchRequest_SpellCorrectionSpec_Mode `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

The specification for query spell correction.

func (*SearchRequest_SpellCorrectionSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_SpellCorrectionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SpellCorrectionSpec) GetMode added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) GetMode() SearchRequest_SpellCorrectionSpec_Mode

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()

func (*SearchRequest_SpellCorrectionSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_SpellCorrectionSpec) Reset added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) Reset()

func (*SearchRequest_SpellCorrectionSpec) String added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) String() string

type SearchRequest_SpellCorrectionSpec_Mode added in v0.3.0 

type SearchRequest_SpellCorrectionSpec_Mode int32

Enum describing under which mode spell correction should occur. 

const (
	// Unspecified spell correction mode. In this case, server behavior
	// defaults to
	// [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
	// Search API will try to find a spell suggestion if there
	// is any and put in the
	// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query].
	// The spell suggestion will not be used as the search query.
	SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
	// Automatic spell correction built by the Search API. Search will
	// be based on the corrected query if found.
	SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_SpellCorrectionSpec_Mode) Enum added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) Enum() *SearchRequest_SpellCorrectionSpec_Mode

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor deprecated added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.

func (SearchRequest_SpellCorrectionSpec_Mode) Number added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) Number() protoreflect.EnumNumber

func (SearchRequest_SpellCorrectionSpec_Mode) String added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) String() string

func (SearchRequest_SpellCorrectionSpec_Mode) Type added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) Type() protoreflect.EnumType

type SearchResponse added in v0.3.0 

type SearchResponse struct {

	// A list of matched documents. The order represents the ranking.
	Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// Results of facets requested by user.
	Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`
	// Guided search result.
	GuidedSearchResult *SearchResponse_GuidedSearchResult `protobuf:"bytes,8,opt,name=guided_search_result,json=guidedSearchResult,proto3" json:"guided_search_result,omitempty"`
	// The estimated total count of matched items irrespective of pagination. The
	// count of
	// [results][google.cloud.discoveryengine.v1beta.SearchResponse.results]
	// returned by pagination may be less than the
	// [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size]
	// that matches.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// A unique search token. This should be included in the
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
	// from this search, which enables accurate attribution of search model
	// performance.
	AttributionToken string `protobuf:"bytes,4,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// A token that can be sent as
	// [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,5,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Contains the spell corrected query, if found. If the spell correction type
	// is AUTOMATIC, then the search results are based on corrected_query.
	// Otherwise the original query is used for search.
	CorrectedQuery string `protobuf:"bytes,7,opt,name=corrected_query,json=correctedQuery,proto3" json:"corrected_query,omitempty"`
	// A summary as part of the search results.
	// This field is only returned if
	// [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec]
	// is set.
	Summary *SearchResponse_Summary `protobuf:"bytes,9,opt,name=summary,proto3" json:"summary,omitempty"`
	// Controls applied as part of the Control service.
	AppliedControls []string `protobuf:"bytes,10,rep,name=applied_controls,json=appliedControls,proto3" json:"applied_controls,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.

func (*SearchResponse) Descriptor deprecated added in v0.3.0 

func (*SearchResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetAppliedControls added in v0.3.0 

func (x *SearchResponse) GetAppliedControls() []string

func (*SearchResponse) GetAttributionToken added in v0.3.0 

func (x *SearchResponse) GetAttributionToken() string

func (*SearchResponse) GetCorrectedQuery added in v0.3.0 

func (x *SearchResponse) GetCorrectedQuery() string

func (*SearchResponse) GetFacets added in v0.3.0 

func (x *SearchResponse) GetFacets() []*SearchResponse_Facet

func (*SearchResponse) GetGuidedSearchResult added in v0.3.0 

func (x *SearchResponse) GetGuidedSearchResult() *SearchResponse_GuidedSearchResult

func (*SearchResponse) GetNextPageToken added in v0.3.0 

func (x *SearchResponse) GetNextPageToken() string

func (*SearchResponse) GetResults added in v0.3.0 

func (x *SearchResponse) GetResults() []*SearchResponse_SearchResult

func (*SearchResponse) GetSummary added in v0.3.0 

func (x *SearchResponse) GetSummary() *SearchResponse_Summary

func (*SearchResponse) GetTotalSize added in v0.3.0 

func (x *SearchResponse) GetTotalSize() int32

func (*SearchResponse) ProtoMessage added in v0.3.0 

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect added in v0.3.0 

func (x *SearchResponse) ProtoReflect() protoreflect.Message

func (*SearchResponse) Reset added in v0.3.0 

func (x *SearchResponse) Reset()

func (*SearchResponse) String added in v0.3.0 

func (x *SearchResponse) String() string

type SearchResponse_Facet added in v0.3.0 

type SearchResponse_Facet struct {

	// The key for this facet. E.g., "colors" or "price". It matches
	// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key].
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The facet values for this field.
	Values []*SearchResponse_Facet_FacetValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// Whether the facet is dynamically generated.
	DynamicFacet bool `protobuf:"varint,3,opt,name=dynamic_facet,json=dynamicFacet,proto3" json:"dynamic_facet,omitempty"`
	// contains filtered or unexported fields
}

A facet result.

func (*SearchResponse_Facet) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Facet) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet) GetDynamicFacet added in v0.3.0 

func (x *SearchResponse_Facet) GetDynamicFacet() bool

func (*SearchResponse_Facet) GetKey added in v0.3.0 

func (x *SearchResponse_Facet) GetKey() string

func (*SearchResponse_Facet) GetValues added in v0.3.0 

func (x *SearchResponse_Facet) GetValues() []*SearchResponse_Facet_FacetValue

func (*SearchResponse_Facet) ProtoMessage added in v0.3.0 

func (*SearchResponse_Facet) ProtoMessage()

func (*SearchResponse_Facet) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Facet) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet) Reset added in v0.3.0 

func (x *SearchResponse_Facet) Reset()

func (*SearchResponse_Facet) String added in v0.3.0 

func (x *SearchResponse_Facet) String() string

type SearchResponse_Facet_FacetValue added in v0.3.0 

type SearchResponse_Facet_FacetValue struct {

	// A facet value which contains values.
	//
	// Types that are assignable to FacetValue:
	//	*SearchResponse_Facet_FacetValue_Value
	//	*SearchResponse_Facet_FacetValue_Interval
	FacetValue isSearchResponse_Facet_FacetValue_FacetValue `protobuf_oneof:"facet_value"`
	// Number of items that have this facet value.
	Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

A facet value which contains value names and their count.

func (*SearchResponse_Facet_FacetValue) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Facet_FacetValue) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet_FacetValue) GetCount added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetCount() int64

func (*SearchResponse_Facet_FacetValue) GetFacetValue added in v0.3.0 

func (m *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValue

func (*SearchResponse_Facet_FacetValue) GetInterval added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetInterval() *Interval

func (*SearchResponse_Facet_FacetValue) GetValue added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetValue() string

func (*SearchResponse_Facet_FacetValue) ProtoMessage added in v0.3.0 

func (*SearchResponse_Facet_FacetValue) ProtoMessage()

func (*SearchResponse_Facet_FacetValue) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet_FacetValue) Reset added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) Reset()

func (*SearchResponse_Facet_FacetValue) String added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) String() string

type SearchResponse_Facet_FacetValue_Interval added in v0.3.0 

type SearchResponse_Facet_FacetValue_Interval struct {
	// Interval value for a facet, such as [10, 20) for facet "price". It
	// matches
	// [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
	Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}

type SearchResponse_Facet_FacetValue_Value added in v0.3.0 

type SearchResponse_Facet_FacetValue_Value struct {
	// Text value of a facet, such as "Black" for facet "colors".
	Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

type SearchResponse_GuidedSearchResult added in v0.3.0 

type SearchResponse_GuidedSearchResult struct {

	// A list of ranked refinement attributes.
	RefinementAttributes []*SearchResponse_GuidedSearchResult_RefinementAttribute `protobuf:"bytes,1,rep,name=refinement_attributes,json=refinementAttributes,proto3" json:"refinement_attributes,omitempty"`
	// contains filtered or unexported fields
}

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.

func (*SearchResponse_GuidedSearchResult) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_GuidedSearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_GuidedSearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult) GetRefinementAttributes added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) GetRefinementAttributes() []*SearchResponse_GuidedSearchResult_RefinementAttribute

func (*SearchResponse_GuidedSearchResult) ProtoMessage added in v0.3.0 

func (*SearchResponse_GuidedSearchResult) ProtoMessage()

func (*SearchResponse_GuidedSearchResult) ProtoReflect added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_GuidedSearchResult) Reset added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) Reset()

func (*SearchResponse_GuidedSearchResult) String added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) String() string

type SearchResponse_GuidedSearchResult_RefinementAttribute added in v0.3.0 

type SearchResponse_GuidedSearchResult_RefinementAttribute struct {

	// Attribute key used to refine the results e.g. 'movie_type'.
	AttributeKey string `protobuf:"bytes,1,opt,name=attribute_key,json=attributeKey,proto3" json:"attribute_key,omitempty"`
	// Attribute value used to refine the results e.g. 'drama'.
	AttributeValue string `protobuf:"bytes,2,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
	// contains filtered or unexported fields
}

Useful attribute for search result refinements.

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_GuidedSearchResult_RefinementAttribute.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey() string

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue() string

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage added in v0.3.0 

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage()

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect() protoreflect.Message

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Reset added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) Reset()

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) String added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) String() string

type SearchResponse_SearchResult added in v0.3.0 

type SearchResponse_SearchResult struct {

	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
	// searched [Document][google.cloud.discoveryengine.v1beta.Document].
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The document data snippet in the search response. Only fields that are
	// marked as retrievable are populated.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

Represents the search results.

func (*SearchResponse_SearchResult) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_SearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchResult) GetDocument added in v0.3.0 

func (x *SearchResponse_SearchResult) GetDocument() *Document

func (*SearchResponse_SearchResult) GetId added in v0.3.0 

func (x *SearchResponse_SearchResult) GetId() string

func (*SearchResponse_SearchResult) ProtoMessage added in v0.3.0 

func (*SearchResponse_SearchResult) ProtoMessage()

func (*SearchResponse_SearchResult) ProtoReflect added in v0.3.0 

func (x *SearchResponse_SearchResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_SearchResult) Reset added in v0.3.0 

func (x *SearchResponse_SearchResult) Reset()

func (*SearchResponse_SearchResult) String added in v0.3.0 

func (x *SearchResponse_SearchResult) String() string

type SearchResponse_Summary added in v0.3.0 

type SearchResponse_Summary struct {

	// The summary content.
	SummaryText string `protobuf:"bytes,1,opt,name=summary_text,json=summaryText,proto3" json:"summary_text,omitempty"`
	// contains filtered or unexported fields
}

Summary of the top N search result specified by the summary spec.

func (*SearchResponse_Summary) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Summary) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary) GetSummaryText added in v0.3.0 

func (x *SearchResponse_Summary) GetSummaryText() string

func (*SearchResponse_Summary) ProtoMessage added in v0.3.0 

func (*SearchResponse_Summary) ProtoMessage()

func (*SearchResponse_Summary) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Summary) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary) Reset added in v0.3.0 

func (x *SearchResponse_Summary) Reset()

func (*SearchResponse_Summary) String added in v0.3.0 

func (x *SearchResponse_Summary) String() string

type SearchServiceClient added in v0.3.0 

type SearchServiceClient interface {
	// Performs a search.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}

SearchServiceClient is the client API for SearchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSearchServiceClient added in v0.3.0 

func NewSearchServiceClient(cc grpc.ClientConnInterface) SearchServiceClient

type SearchServiceServer added in v0.3.0 

type SearchServiceServer interface {
	// Performs a search.
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
}

SearchServiceServer is the server API for SearchService service.

type TransactionInfo 

type TransactionInfo struct {

	// Required. Total non-zero value associated with the transaction. This value
	// may include shipping, tax, or other adjustments to the total value that you
	// want to include.
	Value *float32 `protobuf:"fixed32,1,opt,name=value,proto3,oneof" json:"value,omitempty"`
	// Required. Currency code. Use three-character ISO-4217 code.
	Currency string `protobuf:"bytes,2,opt,name=currency,proto3" json:"currency,omitempty"`
	// The transaction ID with a length limit of 128 characters.
	TransactionId string `protobuf:"bytes,3,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"`
	// All the taxes associated with the transaction.
	Tax *float32 `protobuf:"fixed32,4,opt,name=tax,proto3,oneof" json:"tax,omitempty"`
	// All the costs associated with the products. These can be manufacturing
	// costs, shipping expenses not borne by the end user, or any other costs,
	// such that:
	//
	// * Profit =
	// [value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost]
	Cost *float32 `protobuf:"fixed32,5,opt,name=cost,proto3,oneof" json:"cost,omitempty"`
	// The total discount(s) value applied to this transaction.
	// This figure should be excluded from
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	//
	// For example, if a user paid
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	// amount, then nominal (pre-discount) value of the transaction is the sum of
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	// and
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value]
	//
	// This means that profit is calculated the same way, regardless of the
	// discount value, and that
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value]
	// can be larger than
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]:
	//
	// * Profit =
	// [value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost]
	DiscountValue *float32 `protobuf:"fixed32,6,opt,name=discount_value,json=discountValue,proto3,oneof" json:"discount_value,omitempty"`
	// contains filtered or unexported fields
}

A transaction represents the entire purchase transaction.

func (*TransactionInfo) Descriptor deprecated 

func (*TransactionInfo) Descriptor() ([]byte, []int)

Deprecated: Use TransactionInfo.ProtoReflect.Descriptor instead.

func (*TransactionInfo) GetCost 

func (x *TransactionInfo) GetCost() float32

func (*TransactionInfo) GetCurrency 

func (x *TransactionInfo) GetCurrency() string

func (*TransactionInfo) GetDiscountValue 

func (x *TransactionInfo) GetDiscountValue() float32

func (*TransactionInfo) GetTax 

func (x *TransactionInfo) GetTax() float32

func (*TransactionInfo) GetTransactionId 

func (x *TransactionInfo) GetTransactionId() string

func (*TransactionInfo) GetValue 

func (x *TransactionInfo) GetValue() float32

func (*TransactionInfo) ProtoMessage 

func (*TransactionInfo) ProtoMessage()

func (*TransactionInfo) ProtoReflect 

func (x *TransactionInfo) ProtoReflect() protoreflect.Message

func (*TransactionInfo) Reset 

func (x *TransactionInfo) Reset()

func (*TransactionInfo) String 

func (x *TransactionInfo) String() string

type UnimplementedCompletionServiceServer added in v0.3.0 

type UnimplementedCompletionServiceServer struct {
}

UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCompletionServiceServer) CompleteQuery added in v0.3.0 

func (*UnimplementedCompletionServiceServer) CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)

type UnimplementedDocumentServiceServer 

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentServiceServer) CreateDocument 

func (*UnimplementedDocumentServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)

func (*UnimplementedDocumentServiceServer) DeleteDocument 

func (*UnimplementedDocumentServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)

func (*UnimplementedDocumentServiceServer) GetDocument 

func (*UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)

func (*UnimplementedDocumentServiceServer) ImportDocuments 

func (*UnimplementedDocumentServiceServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDocumentServiceServer) ListDocuments 

func (*UnimplementedDocumentServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

func (*UnimplementedDocumentServiceServer) PurgeDocuments added in v0.3.1 

func (*UnimplementedDocumentServiceServer) PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDocumentServiceServer) UpdateDocument 

func (*UnimplementedDocumentServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)

type UnimplementedRecommendationServiceServer 

type UnimplementedRecommendationServiceServer struct {
}

UnimplementedRecommendationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecommendationServiceServer) Recommend 

func (*UnimplementedRecommendationServiceServer) Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)

type UnimplementedSchemaServiceServer added in v0.3.0 

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSchemaServiceServer) CreateSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSchemaServiceServer) DeleteSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSchemaServiceServer) GetSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)

func (*UnimplementedSchemaServiceServer) ListSchemas added in v0.3.0 

func (*UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)

func (*UnimplementedSchemaServiceServer) UpdateSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)

type UnimplementedSearchServiceServer added in v0.3.0 

type UnimplementedSearchServiceServer struct {
}

UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchServiceServer) Search added in v0.3.0 

func (*UnimplementedSearchServiceServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)

type UnimplementedUserEventServiceServer 

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent 

func (*UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)

func (*UnimplementedUserEventServiceServer) ImportUserEvents 

func (*UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) WriteUserEvent 

func (*UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {

	// Required. The document to update/create.
	//
	// If the caller does not have permission to update the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
	// does not exist and
	// [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
	// is not set, a `NOT_FOUND` error is returned.
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// If set to true, and the
	// [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
	// new [Document][google.cloud.discoveryengine.v1beta.Document] will be
	// created.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.

func (*UpdateDocumentRequest) Descriptor deprecated 

func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentRequest) GetAllowMissing 

func (x *UpdateDocumentRequest) GetAllowMissing() bool

func (*UpdateDocumentRequest) GetDocument 

func (x *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) ProtoMessage 

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) ProtoReflect 

func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Message

func (*UpdateDocumentRequest) Reset 

func (x *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String 

func (x *UpdateDocumentRequest) String() string

type UpdateSchemaMetadata added in v0.3.0 

type UpdateSchemaMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for UpdateSchema LRO.

func (*UpdateSchemaMetadata) Descriptor deprecated added in v0.3.0 

func (*UpdateSchemaMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*UpdateSchemaMetadata) GetCreateTime added in v0.3.0 

func (x *UpdateSchemaMetadata) GetCreateTime() *timestamppb.Timestamp

func (*UpdateSchemaMetadata) GetUpdateTime added in v0.3.0 

func (x *UpdateSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*UpdateSchemaMetadata) ProtoMessage added in v0.3.0 

func (*UpdateSchemaMetadata) ProtoMessage()

func (*UpdateSchemaMetadata) ProtoReflect added in v0.3.0 

func (x *UpdateSchemaMetadata) ProtoReflect() protoreflect.Message

func (*UpdateSchemaMetadata) Reset added in v0.3.0 

func (x *UpdateSchemaMetadata) Reset()

func (*UpdateSchemaMetadata) String added in v0.3.0 

func (x *UpdateSchemaMetadata) String() string

type UpdateSchemaRequest added in v0.3.0 

type UpdateSchemaRequest struct {

	// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
	// update.
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	// If set to true, and the
	// [Schema][google.cloud.discoveryengine.v1beta.Schema] is not found, a new
	// [Schema][google.cloud.discoveryengine.v1beta.Schema] will be created. In
	// this situation, `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.

func (*UpdateSchemaRequest) Descriptor deprecated added in v0.3.0 

func (*UpdateSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSchemaRequest.ProtoReflect.Descriptor instead.

func (*UpdateSchemaRequest) GetAllowMissing added in v0.3.0 

func (x *UpdateSchemaRequest) GetAllowMissing() bool

func (*UpdateSchemaRequest) GetSchema added in v0.3.0 

func (x *UpdateSchemaRequest) GetSchema() *Schema

func (*UpdateSchemaRequest) ProtoMessage added in v0.3.0 

func (*UpdateSchemaRequest) ProtoMessage()

func (*UpdateSchemaRequest) ProtoReflect added in v0.3.0 

func (x *UpdateSchemaRequest) ProtoReflect() protoreflect.Message

func (*UpdateSchemaRequest) Reset added in v0.3.0 

func (x *UpdateSchemaRequest) Reset()

func (*UpdateSchemaRequest) String added in v0.3.0 

func (x *UpdateSchemaRequest) String() string

type UserEvent 

type UserEvent struct {

	// Required. User event type. Allowed values are:
	//
	// Generic values:
	//
	// * `search`: Search for Documents.
	// * `view-item`: Detailed page view of a Document.
	// * `view-item-list`: View of a panel or ordered list of Documents.
	// * `view-home-page`: View of the home page.
	// * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
	//
	// Retail-related values:
	//
	// * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
	// * `purchase`: Purchase an item(s)
	//
	// Media-related values:
	//
	// * `media-play`: Start/resume watching a video, playing a song, etc.
	// * `media-complete`: Finished or stopped midway through a video, song, etc.
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Required. A unique identifier for tracking visitors.
	//
	// For example, this could be implemented with an HTTP cookie, which should be
	// able to uniquely identify a visitor on a single device. This unique
	// identifier should not change if the visitor log in/out of the website.
	//
	// Do not set the field to the same fixed ID for different users. This mixes
	// the event history of those users together, which results in degraded model
	// quality.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// The field should not contain PII or user-data. We recommend to use Google
	// Analytics [Client
	// ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
	// for this field.
	UserPseudoId string `protobuf:"bytes,2,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// Only required for
	// [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
	// method. Timestamp of when the user event happened.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// Information about the end user.
	UserInfo *UserInfo `protobuf:"bytes,4,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// Should set to true if the request is made directly from the end user, in
	// which case the
	// [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
	// can be populated from the HTTP request.
	//
	// This flag should be set only if the API request is made directly from the
	// end user such as a mobile app (and not if a gateway or a server is
	// processing and pushing the user events).
	//
	// This should not be set when using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent].
	DirectUserRequest bool `protobuf:"varint,5,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
	// A unique identifier for tracking a visitor session with a length limit of
	// 128 bytes. A session is an aggregation of an end user behavior in a time
	// span.
	//
	// A general guideline to populate the session_id:
	//
	// 1. If user has no activity for 30 min, a new session_id should be assigned.
	// 2. The session_id should be unique across users, suggest use uuid or add
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// as prefix.
	SessionId string `protobuf:"bytes,6,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// Page metadata such as categories and other critical information for certain
	// event types such as `view-category-page`.
	PageInfo *PageInfo `protobuf:"bytes,7,opt,name=page_info,json=pageInfo,proto3" json:"page_info,omitempty"`
	// Token to attribute an API response to user action(s) to trigger the event.
	//
	// Highly recommended for user events that are the result of
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
	// This field enables accurate attribution of recommendation model
	// performance.
	//
	// The value must be one of:
	//
	// * [PredictResponse.attribution_token][] for events that are the result of
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
	// * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search].
	// * [CompleteQueryResponse.attribution_token][] for events that are the
	// result of
	// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery].
	//
	// This token enables us to accurately attribute page view or conversion
	// completion back to the event and the particular predict response containing
	// this clicked/purchased product. If user clicks on product K in the
	// recommendation results, pass [PredictResponse.attribution_token][] as a URL
	// parameter to product K's page. When recording events on product K's page,
	// log the [PredictResponse.attribution_token][] to this field.
	AttributionToken string `protobuf:"bytes,8,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// The filter syntax consists of an expression language for constructing a
	// predicate from one or more fields of the documents being filtered.
	//
	// One example is for `search` events, the associated
	// [SearchRequest][google.cloud.discoveryengine.v1beta.SearchRequest] may
	// contain a filter expression in
	// [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
	// conforming to https://google.aip.dev/160#filtering.
	//
	// Similarly, for `view-item-list` events that are generated from a
	// [RecommendationService.RecommendRequest][], this field may be populated
	// directly from [RecommendationService.RecommendRequest.filter][] conforming
	// to https://google.aip.dev/160#filtering.
	//
	// The value must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
	// List of Documents associated with this user event.
	//
	// This field is optional except for the following event types:
	//
	// * `view-item`
	// * `add-to-cart`
	// * `purchase`
	// * `media-play`
	// * `media-complete`
	//
	// In a `search` event, this field represents the documents returned to the
	// end user on the current page (the end user may have not finished browsing
	// the whole page yet). When a new page is returned to the end user, after
	// pagination/filtering/ordering even for the same query, a new `search` event
	// with different
	// [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
	// is desired.
	Documents []*DocumentInfo `protobuf:"bytes,10,rep,name=documents,proto3" json:"documents,omitempty"`
	// Panel metadata associated with this user event.
	Panel *PanelInfo `protobuf:"bytes,11,opt,name=panel,proto3" json:"panel,omitempty"`
	// Search API details related to the event.
	//
	// This field should be set for `search` event.
	SearchInfo *SearchInfo `protobuf:"bytes,12,opt,name=search_info,json=searchInfo,proto3" json:"search_info,omitempty"`
	// CompleteQuery API details related to the event.
	//
	// This field should be set for `search` event when autocomplete function is
	// enabled and the user clicks a suggestion for search.
	CompletionInfo *CompletionInfo `protobuf:"bytes,13,opt,name=completion_info,json=completionInfo,proto3" json:"completion_info,omitempty"`
	// The transaction metadata (if any) associated with this user event.
	TransactionInfo *TransactionInfo `protobuf:"bytes,14,opt,name=transaction_info,json=transactionInfo,proto3" json:"transaction_info,omitempty"`
	// A list of identifiers for the independent experiment groups this user event
	// belongs to. This is used to distinguish between user events associated with
	// different experiment setups on the customer end.
	TagIds []string `protobuf:"bytes,15,rep,name=tag_ids,json=tagIds,proto3" json:"tag_ids,omitempty"`
	// The promotion IDs if this is an event associated with promotions.
	// Currently, this field is restricted to at most one ID.
	PromotionIds []string `protobuf:"bytes,16,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
	// Extra user event features to include in the recommendation model.
	// These attributes must NOT contain data that needs to be parsed or processed
	// further, e.g. JSON or other encodings.
	//
	// If you provide custom attributes for ingested user events, also include
	// them in the user events that you associate with prediction requests. Custom
	// attribute formatting must be consistent between imported events and events
	// provided with prediction requests. This lets the Discovery Engine API use
	// those custom attributes when training models and serving predictions, which
	// helps improve recommendation quality.
	//
	// This field needs to pass all below criteria, otherwise an
	// `INVALID_ARGUMENT` error is returned:
	//
	// * The key must be a UTF-8 encoded string with a length limit of 5,000
	//   characters.
	// * For text attributes, at most 400 values are allowed. Empty values are not
	//   allowed. Each value must be a UTF-8 encoded string with a length limit of
	//   256 characters.
	// * For number attributes, at most 400 values are allowed.
	//
	// For product recommendations, an example of extra user information is
	// ` traffic_channel`, which is how a user arrives at the site. Users can
	// arrive
	// at the site by coming to the site directly, coming through Google
	// search, or in other ways.
	Attributes map[string]*CustomAttribute `` /* 162-byte string literal not displayed */
	// Media-specific info.
	MediaInfo *MediaInfo `protobuf:"bytes,18,opt,name=media_info,json=mediaInfo,proto3" json:"media_info,omitempty"`
	// contains filtered or unexported fields
}

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.

func (*UserEvent) Descriptor deprecated 

func (*UserEvent) Descriptor() ([]byte, []int)

Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.

func (*UserEvent) GetAttributes 

func (x *UserEvent) GetAttributes() map[string]*CustomAttribute

func (*UserEvent) GetAttributionToken 

func (x *UserEvent) GetAttributionToken() string

func (*UserEvent) GetCompletionInfo 

func (x *UserEvent) GetCompletionInfo() *CompletionInfo

func (*UserEvent) GetDirectUserRequest 

func (x *UserEvent) GetDirectUserRequest() bool

func (*UserEvent) GetDocuments 

func (x *UserEvent) GetDocuments() []*DocumentInfo

func (*UserEvent) GetEventTime 

func (x *UserEvent) GetEventTime() *timestamppb.Timestamp

func (*UserEvent) GetEventType 

func (x *UserEvent) GetEventType() string

func (*UserEvent) GetFilter 

func (x *UserEvent) GetFilter() string

func (*UserEvent) GetMediaInfo 

func (x *UserEvent) GetMediaInfo() *MediaInfo

func (*UserEvent) GetPageInfo 

func (x *UserEvent) GetPageInfo() *PageInfo

func (*UserEvent) GetPanel 

func (x *UserEvent) GetPanel() *PanelInfo

func (*UserEvent) GetPromotionIds 

func (x *UserEvent) GetPromotionIds() []string

func (*UserEvent) GetSearchInfo 

func (x *UserEvent) GetSearchInfo() *SearchInfo

func (*UserEvent) GetSessionId 

func (x *UserEvent) GetSessionId() string

func (*UserEvent) GetTagIds 

func (x *UserEvent) GetTagIds() []string

func (*UserEvent) GetTransactionInfo 

func (x *UserEvent) GetTransactionInfo() *TransactionInfo

func (*UserEvent) GetUserInfo 

func (x *UserEvent) GetUserInfo() *UserInfo

func (*UserEvent) GetUserPseudoId 

func (x *UserEvent) GetUserPseudoId() string

func (*UserEvent) ProtoMessage 

func (*UserEvent) ProtoMessage()

func (*UserEvent) ProtoReflect 

func (x *UserEvent) ProtoReflect() protoreflect.Message

func (*UserEvent) Reset 

func (x *UserEvent) Reset()

func (*UserEvent) String 

func (x *UserEvent) String() string

type UserEventServiceClient 

type UserEventServiceClient interface {
	// Writes a single user event.
	WriteUserEvent(ctx context.Context, in *WriteUserEventRequest, opts ...grpc.CallOption) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a 3rd party domain.
	//
	// This method is used only by the Discovery Engine API JavaScript pixel and
	// Google Tag Manager. Users should not call this method directly.
	CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Bulk import of User events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// Operation.metadata is of type ImportMetadata.
	ImportUserEvents(ctx context.Context, in *ImportUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

UserEventServiceClient is the client API for UserEventService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewUserEventServiceClient 

func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClient

type UserEventServiceServer 

type UserEventServiceServer interface {
	// Writes a single user event.
	WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a 3rd party domain.
	//
	// This method is used only by the Discovery Engine API JavaScript pixel and
	// Google Tag Manager. Users should not call this method directly.
	CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
	// Bulk import of User events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// Operation.metadata is of type ImportMetadata.
	ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)
}

UserEventServiceServer is the server API for UserEventService service.

type UserInfo 

type UserInfo struct {

	// Highly recommended for logged-in users. Unique identifier for logged-in
	// user, such as a user name. Don't set for anonymous users.
	//
	// Always use a hashed value for this ID.
	//
	// Don't set the field to the same fixed ID for different users. This mixes
	// the event history of those users together, which results in degraded
	// model quality.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// User agent as included in the HTTP header. Required for getting
	// [SearchResponse.sponsored_results][].
	//
	// The field must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
	//
	// This should not be set when using the client side event reporting with
	// GTM or JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent]
	// or if
	// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
	// is set.
	UserAgent string `protobuf:"bytes,2,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// contains filtered or unexported fields
}

Information of an end user.

func (*UserInfo) Descriptor deprecated 

func (*UserInfo) Descriptor() ([]byte, []int)

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetUserAgent 

func (x *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId 

func (x *UserInfo) GetUserId() string

func (*UserInfo) ProtoMessage 

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect 

func (x *UserInfo) ProtoReflect() protoreflect.Message

func (*UserInfo) Reset 

func (x *UserInfo) Reset()

func (*UserInfo) String 

func (x *UserInfo) String() string

type WriteUserEventRequest 

type WriteUserEventRequest struct {

	// Required. The parent DataStore resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User event to write.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3,oneof" json:"user_event,omitempty"`
	// contains filtered or unexported fields
}

Request message for WriteUserEvent method.

func (*WriteUserEventRequest) Descriptor deprecated 

func (*WriteUserEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.

func (*WriteUserEventRequest) GetParent 

func (x *WriteUserEventRequest) GetParent() string

func (*WriteUserEventRequest) GetUserEvent 

func (x *WriteUserEventRequest) GetUserEvent() *UserEvent

func (*WriteUserEventRequest) ProtoMessage 

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) ProtoReflect 

func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Message

func (*WriteUserEventRequest) Reset 

func (x *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String 

func (x *WriteUserEventRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.