discoveryenginepb

package
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Mar 12, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	IndustryVertical_name = map[int32]string{
		0: "INDUSTRY_VERTICAL_UNSPECIFIED",
		1: "GENERIC",
		2: "MEDIA",
	}
	IndustryVertical_value = map[string]int32{
		"INDUSTRY_VERTICAL_UNSPECIFIED": 0,
		"GENERIC":                       1,
		"MEDIA":                         2,
	}
)

Enum value maps for IndustryVertical.

View Source
var (
	SolutionType_name = map[int32]string{
		0: "SOLUTION_TYPE_UNSPECIFIED",
		1: "SOLUTION_TYPE_RECOMMENDATION",
		2: "SOLUTION_TYPE_SEARCH",
		3: "SOLUTION_TYPE_CHAT",
	}
	SolutionType_value = map[string]int32{
		"SOLUTION_TYPE_UNSPECIFIED":    0,
		"SOLUTION_TYPE_RECOMMENDATION": 1,
		"SOLUTION_TYPE_SEARCH":         2,
		"SOLUTION_TYPE_CHAT":           3,
	}
)

Enum value maps for SolutionType.

View Source
var (
	SearchTier_name = map[int32]string{
		0: "SEARCH_TIER_UNSPECIFIED",
		1: "SEARCH_TIER_STANDARD",
		2: "SEARCH_TIER_ENTERPRISE",
	}
	SearchTier_value = map[string]int32{
		"SEARCH_TIER_UNSPECIFIED": 0,
		"SEARCH_TIER_STANDARD":    1,
		"SEARCH_TIER_ENTERPRISE":  2,
	}
)

Enum value maps for SearchTier.

View Source
var (
	SearchAddOn_name = map[int32]string{
		0: "SEARCH_ADD_ON_UNSPECIFIED",
		1: "SEARCH_ADD_ON_LLM",
	}
	SearchAddOn_value = map[string]int32{
		"SEARCH_ADD_ON_UNSPECIFIED": 0,
		"SEARCH_ADD_ON_LLM":         1,
	}
)

Enum value maps for SearchAddOn.

View Source
var (
	IdpConfig_IdpType_name = map[int32]string{
		0: "IDP_TYPE_UNSPECIFIED",
		1: "GSUITE",
		2: "THIRD_PARTY",
	}
	IdpConfig_IdpType_value = map[string]int32{
		"IDP_TYPE_UNSPECIFIED": 0,
		"GSUITE":               1,
		"THIRD_PARTY":          2,
	}
)

Enum value maps for IdpConfig_IdpType.

View Source
var (
	SuggestionDenyListEntry_MatchOperator_name = map[int32]string{
		0: "MATCH_OPERATOR_UNSPECIFIED",
		1: "EXACT_MATCH",
		2: "CONTAINS",
	}
	SuggestionDenyListEntry_MatchOperator_value = map[string]int32{
		"MATCH_OPERATOR_UNSPECIFIED": 0,
		"EXACT_MATCH":                1,
		"CONTAINS":                   2,
	}
)

Enum value maps for SuggestionDenyListEntry_MatchOperator.

View Source
var (
	Conversation_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "IN_PROGRESS",
		2: "COMPLETED",
	}
	Conversation_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"IN_PROGRESS":       1,
		"COMPLETED":         2,
	}
)

Enum value maps for Conversation_State.

View Source
var (
	DataStore_ContentConfig_name = map[int32]string{
		0: "CONTENT_CONFIG_UNSPECIFIED",
		1: "NO_CONTENT",
		2: "CONTENT_REQUIRED",
		3: "PUBLIC_WEBSITE",
	}
	DataStore_ContentConfig_value = map[string]int32{
		"CONTENT_CONFIG_UNSPECIFIED": 0,
		"NO_CONTENT":                 1,
		"CONTENT_REQUIRED":           2,
		"PUBLIC_WEBSITE":             3,
	}
)

Enum value maps for DataStore_ContentConfig.

View Source
var (
	Engine_MediaRecommendationEngineConfig_TrainingState_name = map[int32]string{
		0: "TRAINING_STATE_UNSPECIFIED",
		1: "PAUSED",
		2: "TRAINING",
	}
	Engine_MediaRecommendationEngineConfig_TrainingState_value = map[string]int32{
		"TRAINING_STATE_UNSPECIFIED": 0,
		"PAUSED":                     1,
		"TRAINING":                   2,
	}
)

Enum value maps for Engine_MediaRecommendationEngineConfig_TrainingState.

View Source
var (
	Engine_RecommendationMetadata_ServingState_name = map[int32]string{
		0: "SERVING_STATE_UNSPECIFIED",
		1: "INACTIVE",
		2: "ACTIVE",
		3: "TUNED",
	}
	Engine_RecommendationMetadata_ServingState_value = map[string]int32{
		"SERVING_STATE_UNSPECIFIED": 0,
		"INACTIVE":                  1,
		"ACTIVE":                    2,
		"TUNED":                     3,
	}
)

Enum value maps for Engine_RecommendationMetadata_ServingState.

View Source
var (
	Engine_RecommendationMetadata_DataState_name = map[int32]string{
		0: "DATA_STATE_UNSPECIFIED",
		1: "DATA_OK",
		2: "DATA_ERROR",
	}
	Engine_RecommendationMetadata_DataState_value = map[string]int32{
		"DATA_STATE_UNSPECIFIED": 0,
		"DATA_OK":                1,
		"DATA_ERROR":             2,
	}
)

Enum value maps for Engine_RecommendationMetadata_DataState.

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 (
	FieldConfig_FieldType_name = map[int32]string{
		0: "FIELD_TYPE_UNSPECIFIED",
		1: "OBJECT",
		2: "STRING",
		3: "NUMBER",
		4: "INTEGER",
		5: "BOOLEAN",
		6: "GEOLOCATION",
		7: "DATETIME",
	}
	FieldConfig_FieldType_value = map[string]int32{
		"FIELD_TYPE_UNSPECIFIED": 0,
		"OBJECT":                 1,
		"STRING":                 2,
		"NUMBER":                 3,
		"INTEGER":                4,
		"BOOLEAN":                5,
		"GEOLOCATION":            6,
		"DATETIME":               7,
	}
)

Enum value maps for FieldConfig_FieldType.

View Source
var (
	FieldConfig_IndexableOption_name = map[int32]string{
		0: "INDEXABLE_OPTION_UNSPECIFIED",
		1: "INDEXABLE_ENABLED",
		2: "INDEXABLE_DISABLED",
	}
	FieldConfig_IndexableOption_value = map[string]int32{
		"INDEXABLE_OPTION_UNSPECIFIED": 0,
		"INDEXABLE_ENABLED":            1,
		"INDEXABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_IndexableOption.

View Source
var (
	FieldConfig_DynamicFacetableOption_name = map[int32]string{
		0: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
		1: "DYNAMIC_FACETABLE_ENABLED",
		2: "DYNAMIC_FACETABLE_DISABLED",
	}
	FieldConfig_DynamicFacetableOption_value = map[string]int32{
		"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED": 0,
		"DYNAMIC_FACETABLE_ENABLED":            1,
		"DYNAMIC_FACETABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_DynamicFacetableOption.

View Source
var (
	FieldConfig_SearchableOption_name = map[int32]string{
		0: "SEARCHABLE_OPTION_UNSPECIFIED",
		1: "SEARCHABLE_ENABLED",
		2: "SEARCHABLE_DISABLED",
	}
	FieldConfig_SearchableOption_value = map[string]int32{
		"SEARCHABLE_OPTION_UNSPECIFIED": 0,
		"SEARCHABLE_ENABLED":            1,
		"SEARCHABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_SearchableOption.

View Source
var (
	FieldConfig_RetrievableOption_name = map[int32]string{
		0: "RETRIEVABLE_OPTION_UNSPECIFIED",
		1: "RETRIEVABLE_ENABLED",
		2: "RETRIEVABLE_DISABLED",
	}
	FieldConfig_RetrievableOption_value = map[string]int32{
		"RETRIEVABLE_OPTION_UNSPECIFIED": 0,
		"RETRIEVABLE_ENABLED":            1,
		"RETRIEVABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_RetrievableOption.

View Source
var (
	FieldConfig_CompletableOption_name = map[int32]string{
		0: "COMPLETABLE_OPTION_UNSPECIFIED",
		1: "COMPLETABLE_ENABLED",
		2: "COMPLETABLE_DISABLED",
	}
	FieldConfig_CompletableOption_value = map[string]int32{
		"COMPLETABLE_OPTION_UNSPECIFIED": 0,
		"COMPLETABLE_ENABLED":            1,
		"COMPLETABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_CompletableOption.

View Source
var (
	FieldConfig_FilterableOption_name = map[int32]string{
		0: "FILTERABLE_OPTION_UNSPECIFIED",
		1: "FILTERABLE_ENABLED",
		2: "FILTERABLE_DISABLED",
	}
	FieldConfig_FilterableOption_value = map[string]int32{
		"FILTERABLE_OPTION_UNSPECIFIED": 0,
		"FILTERABLE_ENABLED":            1,
		"FILTERABLE_DISABLED":           2,
	}
)

Enum value maps for FieldConfig_FilterableOption.

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 (
	SearchRequest_ContentSearchSpec_SearchResultMode_name = map[int32]string{
		0: "SEARCH_RESULT_MODE_UNSPECIFIED",
		1: "DOCUMENTS",
		2: "CHUNKS",
	}
	SearchRequest_ContentSearchSpec_SearchResultMode_value = map[string]int32{
		"SEARCH_RESULT_MODE_UNSPECIFIED": 0,
		"DOCUMENTS":                      1,
		"CHUNKS":                         2,
	}
)

Enum value maps for SearchRequest_ContentSearchSpec_SearchResultMode.

View Source
var (
	SearchResponse_Summary_SummarySkippedReason_name = map[int32]string{
		0: "SUMMARY_SKIPPED_REASON_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY_IGNORED",
		2: "NON_SUMMARY_SEEKING_QUERY_IGNORED",
		3: "OUT_OF_DOMAIN_QUERY_IGNORED",
		4: "POTENTIAL_POLICY_VIOLATION",
		5: "LLM_ADDON_NOT_ENABLED",
	}
	SearchResponse_Summary_SummarySkippedReason_value = map[string]int32{
		"SUMMARY_SKIPPED_REASON_UNSPECIFIED": 0,
		"ADVERSARIAL_QUERY_IGNORED":          1,
		"NON_SUMMARY_SEEKING_QUERY_IGNORED":  2,
		"OUT_OF_DOMAIN_QUERY_IGNORED":        3,
		"POTENTIAL_POLICY_VIOLATION":         4,
		"LLM_ADDON_NOT_ENABLED":              5,
	}
)

Enum value maps for SearchResponse_Summary_SummarySkippedReason.

View Source
var (
	TargetSite_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "INCLUDE",
		2: "EXCLUDE",
	}
	TargetSite_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"INCLUDE":          1,
		"EXCLUDE":          2,
	}
)

Enum value maps for TargetSite_Type.

View Source
var (
	TargetSite_IndexingStatus_name = map[int32]string{
		0: "INDEXING_STATUS_UNSPECIFIED",
		1: "PENDING",
		2: "FAILED",
		3: "SUCCEEDED",
		4: "DELETING",
	}
	TargetSite_IndexingStatus_value = map[string]int32{
		"INDEXING_STATUS_UNSPECIFIED": 0,
		"PENDING":                     1,
		"FAILED":                      2,
		"SUCCEEDED":                   3,
		"DELETING":                    4,
	}
)

Enum value maps for TargetSite_IndexingStatus.

View Source
var (
	SiteVerificationInfo_SiteVerificationState_name = map[int32]string{
		0: "SITE_VERIFICATION_STATE_UNSPECIFIED",
		1: "VERIFIED",
		2: "UNVERIFIED",
		3: "EXEMPTED",
	}
	SiteVerificationInfo_SiteVerificationState_value = map[string]int32{
		"SITE_VERIFICATION_STATE_UNSPECIFIED": 0,
		"VERIFIED":                            1,
		"UNVERIFIED":                          2,
		"EXEMPTED":                            3,
	}
)

Enum value maps for SiteVerificationInfo_SiteVerificationState.

View Source
var (
	RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name = map[int32]string{
		0: "CORPUS_TYPE_UNSPECIFIED",
		1: "DESKTOP",
		2: "MOBILE",
	}
	RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value = map[string]int32{
		"CORPUS_TYPE_UNSPECIFIED": 0,
		"DESKTOP":                 1,
		"MOBILE":                  2,
	}
)

Enum value maps for RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.

View Source
var File_google_cloud_discoveryengine_v1alpha_acl_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_acl_config_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_chunk_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_chunk_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_common_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_completion_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_completion_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_conversation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_conversational_search_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_data_store_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_data_store_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_document_processing_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_document_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_document_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_engine_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_engine_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_estimate_billing_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_import_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_purge_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_recommendation_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_schema_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_schema_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_search_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_search_tuning_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_serving_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_serving_config_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_user_event_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_discoveryengine_v1alpha_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterAclConfigServiceServer added in v1.6.0

func RegisterAclConfigServiceServer(s *grpc.Server, srv AclConfigServiceServer)

func RegisterChunkServiceServer added in v1.6.0

func RegisterChunkServiceServer(s *grpc.Server, srv ChunkServiceServer)

func RegisterCompletionServiceServer

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

func RegisterConversationalSearchServiceServer

func RegisterConversationalSearchServiceServer(s *grpc.Server, srv ConversationalSearchServiceServer)

func RegisterDataStoreServiceServer

func RegisterDataStoreServiceServer(s *grpc.Server, srv DataStoreServiceServer)

func RegisterDocumentServiceServer

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

func RegisterEngineServiceServer

func RegisterEngineServiceServer(s *grpc.Server, srv EngineServiceServer)

func RegisterEstimateBillingServiceServer added in v1.6.0

func RegisterEstimateBillingServiceServer(s *grpc.Server, srv EstimateBillingServiceServer)

func RegisterRecommendationServiceServer

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

func RegisterSchemaServiceServer

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

func RegisterSearchServiceServer

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

func RegisterSearchTuningServiceServer added in v1.4.0

func RegisterSearchTuningServiceServer(s *grpc.Server, srv SearchTuningServiceServer)

func RegisterServingConfigServiceServer added in v1.6.0

func RegisterServingConfigServiceServer(s *grpc.Server, srv ServingConfigServiceServer)

func RegisterSiteSearchEngineServiceServer

func RegisterSiteSearchEngineServiceServer(s *grpc.Server, srv SiteSearchEngineServiceServer)

func RegisterUserEventServiceServer

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

Types

type AclConfig added in v1.6.0

type AclConfig struct {

	// Immutable. The full resource name of the acl configuration.
	// Format:
	// `projects/{project}/locations/{location}/aclConfig`.
	//
	// 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"`
	// Identity provider config.
	IdpConfig *IdpConfig `protobuf:"bytes,2,opt,name=idp_config,json=idpConfig,proto3" json:"idp_config,omitempty"`
	// contains filtered or unexported fields
}

Access Control Configuration.

func (*AclConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use AclConfig.ProtoReflect.Descriptor instead.

func (*AclConfig) GetIdpConfig added in v1.6.0

func (x *AclConfig) GetIdpConfig() *IdpConfig

func (*AclConfig) GetName added in v1.6.0

func (x *AclConfig) GetName() string

func (*AclConfig) ProtoMessage added in v1.6.0

func (*AclConfig) ProtoMessage()

func (*AclConfig) ProtoReflect added in v1.6.0

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

func (*AclConfig) Reset added in v1.6.0

func (x *AclConfig) Reset()

func (*AclConfig) String added in v1.6.0

func (x *AclConfig) String() string

type AclConfigServiceClient added in v1.6.0

type AclConfigServiceClient interface {
	// Default Acl Configuration for use in a location of a customer's project.
	// Updates will only reflect to new data stores. Existing data stores will
	// still use the old value.
	UpdateAclConfig(ctx context.Context, in *UpdateAclConfigRequest, opts ...grpc.CallOption) (*AclConfig, error)
	// Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
	GetAclConfig(ctx context.Context, in *GetAclConfigRequest, opts ...grpc.CallOption) (*AclConfig, error)
}

AclConfigServiceClient is the client API for AclConfigService service.

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

func NewAclConfigServiceClient added in v1.6.0

func NewAclConfigServiceClient(cc grpc.ClientConnInterface) AclConfigServiceClient

type AclConfigServiceServer added in v1.6.0

type AclConfigServiceServer interface {
	// Default Acl Configuration for use in a location of a customer's project.
	// Updates will only reflect to new data stores. Existing data stores will
	// still use the old value.
	UpdateAclConfig(context.Context, *UpdateAclConfigRequest) (*AclConfig, error)
	// Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
	GetAclConfig(context.Context, *GetAclConfigRequest) (*AclConfig, error)
}

AclConfigServiceServer is the server API for AclConfigService service.

type BatchCreateTargetSiteMetadata added in v1.4.0

type BatchCreateTargetSiteMetadata 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 related to the progress of the [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*BatchCreateTargetSiteMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSiteMetadata) GetCreateTime added in v1.4.0

func (*BatchCreateTargetSiteMetadata) GetUpdateTime added in v1.4.0

func (*BatchCreateTargetSiteMetadata) ProtoMessage added in v1.4.0

func (*BatchCreateTargetSiteMetadata) ProtoMessage()

func (*BatchCreateTargetSiteMetadata) ProtoReflect added in v1.4.0

func (*BatchCreateTargetSiteMetadata) Reset added in v1.4.0

func (x *BatchCreateTargetSiteMetadata) Reset()

func (*BatchCreateTargetSiteMetadata) String added in v1.4.0

type BatchCreateTargetSitesRequest added in v1.4.0

type BatchCreateTargetSitesRequest struct {

	// Required. The parent resource shared by all TargetSites being created.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	// The parent field in the CreateBookRequest messages must either be empty or
	// match this field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the resources to create.
	// A maximum of 20 TargetSites can be created in a batch.
	Requests []*CreateTargetSiteRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] method.

func (*BatchCreateTargetSitesRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesRequest) GetParent added in v1.4.0

func (x *BatchCreateTargetSitesRequest) GetParent() string

func (*BatchCreateTargetSitesRequest) GetRequests added in v1.4.0

func (*BatchCreateTargetSitesRequest) ProtoMessage added in v1.4.0

func (*BatchCreateTargetSitesRequest) ProtoMessage()

func (*BatchCreateTargetSitesRequest) ProtoReflect added in v1.4.0

func (*BatchCreateTargetSitesRequest) Reset added in v1.4.0

func (x *BatchCreateTargetSitesRequest) Reset()

func (*BatchCreateTargetSitesRequest) String added in v1.4.0

type BatchCreateTargetSitesResponse added in v1.4.0

type BatchCreateTargetSitesResponse struct {

	// TargetSites created.
	TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] method.

func (*BatchCreateTargetSitesResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesResponse) GetTargetSites added in v1.4.0

func (x *BatchCreateTargetSitesResponse) GetTargetSites() []*TargetSite

func (*BatchCreateTargetSitesResponse) ProtoMessage added in v1.4.0

func (*BatchCreateTargetSitesResponse) ProtoMessage()

func (*BatchCreateTargetSitesResponse) ProtoReflect added in v1.4.0

func (*BatchCreateTargetSitesResponse) Reset added in v1.4.0

func (x *BatchCreateTargetSitesResponse) Reset()

func (*BatchCreateTargetSitesResponse) String added in v1.4.0

type BatchVerifyTargetSitesMetadata added in v1.4.0

type BatchVerifyTargetSitesMetadata 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 related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*BatchVerifyTargetSitesMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesMetadata) GetCreateTime added in v1.4.0

func (*BatchVerifyTargetSitesMetadata) GetUpdateTime added in v1.4.0

func (*BatchVerifyTargetSitesMetadata) ProtoMessage added in v1.4.0

func (*BatchVerifyTargetSitesMetadata) ProtoMessage()

func (*BatchVerifyTargetSitesMetadata) ProtoReflect added in v1.4.0

func (*BatchVerifyTargetSitesMetadata) Reset added in v1.4.0

func (x *BatchVerifyTargetSitesMetadata) Reset()

func (*BatchVerifyTargetSitesMetadata) String added in v1.4.0

type BatchVerifyTargetSitesRequest added in v1.4.0

type BatchVerifyTargetSitesRequest struct {

	// Required. The parent resource shared by all TargetSites being verified.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] method.

func (*BatchVerifyTargetSitesRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesRequest) GetParent added in v1.4.0

func (x *BatchVerifyTargetSitesRequest) GetParent() string

func (*BatchVerifyTargetSitesRequest) ProtoMessage added in v1.4.0

func (*BatchVerifyTargetSitesRequest) ProtoMessage()

func (*BatchVerifyTargetSitesRequest) ProtoReflect added in v1.4.0

func (*BatchVerifyTargetSitesRequest) Reset added in v1.4.0

func (x *BatchVerifyTargetSitesRequest) Reset()

func (*BatchVerifyTargetSitesRequest) String added in v1.4.0

type BatchVerifyTargetSitesResponse added in v1.4.0

type BatchVerifyTargetSitesResponse struct {
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] method.

func (*BatchVerifyTargetSitesResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesResponse) ProtoMessage added in v1.4.0

func (*BatchVerifyTargetSitesResponse) ProtoMessage()

func (*BatchVerifyTargetSitesResponse) ProtoReflect added in v1.4.0

func (*BatchVerifyTargetSitesResponse) Reset added in v1.4.0

func (x *BatchVerifyTargetSitesResponse) Reset()

func (*BatchVerifyTargetSitesResponse) String added in v1.4.0

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.v1alpha.UserEvent] per row.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One
	// [Document][google.cloud.discoveryengine.v1alpha.Document] format per
	//
	//	row. Each document must have a valid
	//	[Document.id][google.cloud.discoveryengine.v1alpha.Document.id] and one
	//	of
	//	[Document.json_data][google.cloud.discoveryengine.v1alpha.Document.json_data]
	//	or
	//	[Document.struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data].
	//   - `custom`: One custom data per row in arbitrary format that conforms to
	//     the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
	//     data store. This can only be used by Gen App Builder.
	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 Chunk added in v1.6.0

type Chunk struct {

	// The full resource name of the chunk.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_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"`
	// Unique chunk id of the current chunk.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Content is a string from a document (parsed content).
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// Metadata of the document from the current chunk.
	DocumentMetadata *Chunk_DocumentMetadata `protobuf:"bytes,5,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,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,4,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
	// contains filtered or unexported fields
}

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

func (*Chunk) Descriptor deprecated added in v1.6.0

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetContent added in v1.6.0

func (x *Chunk) GetContent() string

func (*Chunk) GetDerivedStructData added in v1.6.0

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

func (*Chunk) GetDocumentMetadata added in v1.6.0

func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadata

func (*Chunk) GetId added in v1.6.0

func (x *Chunk) GetId() string

func (*Chunk) GetName added in v1.6.0

func (x *Chunk) GetName() string

func (*Chunk) ProtoMessage added in v1.6.0

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect added in v1.6.0

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

func (*Chunk) Reset added in v1.6.0

func (x *Chunk) Reset()

func (*Chunk) String added in v1.6.0

func (x *Chunk) String() string

type ChunkServiceClient added in v1.6.0

type ChunkServiceClient interface {
	// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
	GetChunk(ctx context.Context, in *GetChunkRequest, opts ...grpc.CallOption) (*Chunk, error)
	// Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
	ListChunks(ctx context.Context, in *ListChunksRequest, opts ...grpc.CallOption) (*ListChunksResponse, error)
}

ChunkServiceClient is the client API for ChunkService service.

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

func NewChunkServiceClient added in v1.6.0

func NewChunkServiceClient(cc grpc.ClientConnInterface) ChunkServiceClient

type ChunkServiceServer added in v1.6.0

type ChunkServiceServer interface {
	// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
	GetChunk(context.Context, *GetChunkRequest) (*Chunk, error)
	// Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
	ListChunks(context.Context, *ListChunksRequest) (*ListChunksResponse, error)
}

ChunkServiceServer is the server API for ChunkService service.

type Chunk_DocumentMetadata added in v1.6.0

type Chunk_DocumentMetadata struct {

	// Uri of the document.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title of the document.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

Document metadata contains the information of the document of the current chunk.

func (*Chunk_DocumentMetadata) Descriptor deprecated added in v1.6.0

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

Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_DocumentMetadata) GetTitle added in v1.6.0

func (x *Chunk_DocumentMetadata) GetTitle() string

func (*Chunk_DocumentMetadata) GetUri added in v1.6.0

func (x *Chunk_DocumentMetadata) GetUri() string

func (*Chunk_DocumentMetadata) ProtoMessage added in v1.6.0

func (*Chunk_DocumentMetadata) ProtoMessage()

func (*Chunk_DocumentMetadata) ProtoReflect added in v1.6.0

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

func (*Chunk_DocumentMetadata) Reset added in v1.6.0

func (x *Chunk_DocumentMetadata) Reset()

func (*Chunk_DocumentMetadata) String added in v1.6.0

func (x *Chunk_DocumentMetadata) String() string

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 third-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

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"`
	// Specifies the autocomplete data model. This overrides any model specified
	// in the Configuration > Autocomplete section of the Cloud console. 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.v1alpha.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.
	// * `document-completable` - Using suggestions taken directly from
	// user-imported document fields marked as completable.
	//
	// Default values:
	//
	// * `document` is the default model for regular dataStores.
	// * `search-history` is the default model for 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.v1alpha.UserEvent.user_pseudo_id]
	// and
	// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.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"`
	// Indicates if tail suggestions should be returned if there are no
	// suggestions that match the full query. Even if set to true, if there are
	// suggestions that match the full query, those are returned and no
	// tail suggestions are returned.
	IncludeTailSuggestions bool `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*CompleteQueryRequest) Descriptor deprecated

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

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetDataStore

func (x *CompleteQueryRequest) GetDataStore() string

func (*CompleteQueryRequest) GetIncludeTailSuggestions

func (x *CompleteQueryRequest) GetIncludeTailSuggestions() bool

func (*CompleteQueryRequest) GetQuery

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetQueryModel

func (x *CompleteQueryRequest) GetQueryModel() string

func (*CompleteQueryRequest) GetUserPseudoId

func (x *CompleteQueryRequest) GetUserPseudoId() string

func (*CompleteQueryRequest) ProtoMessage

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect

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

func (*CompleteQueryRequest) Reset

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String

func (x *CompleteQueryRequest) String() string

type CompleteQueryResponse

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"`
	// True if the returned suggestions are all tail suggestions.
	//
	// For tail matching to be triggered, include_tail_suggestions in the request
	// must be true and there must be no suggestions that match the full query.
	TailMatchTriggered bool `protobuf:"varint,2,opt,name=tail_match_triggered,json=tailMatchTriggered,proto3" json:"tail_match_triggered,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CompleteQueryResponse) Descriptor deprecated

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

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions

func (*CompleteQueryResponse) GetTailMatchTriggered

func (x *CompleteQueryResponse) GetTailMatchTriggered() bool

func (*CompleteQueryResponse) ProtoMessage

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect

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

func (*CompleteQueryResponse) Reset

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String

func (x *CompleteQueryResponse) String() string

type CompleteQueryResponse_QuerySuggestion

type CompleteQueryResponse_QuerySuggestion struct {

	// The suggestion for the query.
	Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// The unique document field paths that serve as the source of this
	// suggestion if it was generated from completable fields.
	//
	// This field is only populated for the document-completable model.
	CompletableFieldPaths []string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Suggestions as search queries.

func (*CompleteQueryResponse_QuerySuggestion) Descriptor deprecated

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

Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths

func (x *CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths() []string

func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion

func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()

func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect

func (*CompleteQueryResponse_QuerySuggestion) Reset

func (*CompleteQueryResponse_QuerySuggestion) String

type CompletionInfo

type CompletionInfo struct {

	// End user selected
	// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion].
	SelectedSuggestion string `protobuf:"bytes,1,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
	// End user selected
	// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.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

type CompletionServiceClient interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
	// Imports all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
	// for a DataStore.
	ImportSuggestionDenyListEntries(ctx context.Context, in *ImportSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
	// for a DataStore.
	PurgeSuggestionDenyListEntries(ctx context.Context, in *PurgeSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, 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.

type CompletionServiceServer

type CompletionServiceServer interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
	// Imports all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
	// for a DataStore.
	ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
	// for a DataStore.
	PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
}

CompletionServiceServer is the server API for CompletionService service.

type Conversation

type Conversation struct {

	// Immutable. Fully qualified name
	// `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
	// or
	// `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the Conversation.
	State Conversation_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.Conversation_State" json:"state,omitempty"`
	// A unique identifier for tracking users.
	UserPseudoId string `protobuf:"bytes,3,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// Conversation messages.
	Messages []*ConversationMessage `protobuf:"bytes,4,rep,name=messages,proto3" json:"messages,omitempty"`
	// Output only. The time the conversation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The time the conversation finished.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

External conversation proto definition.

func (*Conversation) Descriptor deprecated

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

Deprecated: Use Conversation.ProtoReflect.Descriptor instead.

func (*Conversation) GetEndTime

func (x *Conversation) GetEndTime() *timestamppb.Timestamp

func (*Conversation) GetMessages

func (x *Conversation) GetMessages() []*ConversationMessage

func (*Conversation) GetName

func (x *Conversation) GetName() string

func (*Conversation) GetStartTime

func (x *Conversation) GetStartTime() *timestamppb.Timestamp

func (*Conversation) GetState

func (x *Conversation) GetState() Conversation_State

func (*Conversation) GetUserPseudoId

func (x *Conversation) GetUserPseudoId() string

func (*Conversation) ProtoMessage

func (*Conversation) ProtoMessage()

func (*Conversation) ProtoReflect

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

func (*Conversation) Reset

func (x *Conversation) Reset()

func (*Conversation) String

func (x *Conversation) String() string

type ConversationContext

type ConversationContext struct {

	// The current list of documents the user is seeing.
	// It contains the document resource references.
	ContextDocuments []string `protobuf:"bytes,1,rep,name=context_documents,json=contextDocuments,proto3" json:"context_documents,omitempty"`
	// The current active document the user opened.
	// It contains the document resource reference.
	ActiveDocument string `protobuf:"bytes,2,opt,name=active_document,json=activeDocument,proto3" json:"active_document,omitempty"`
	// contains filtered or unexported fields
}

Defines context of the conversation

func (*ConversationContext) Descriptor deprecated

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

Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.

func (*ConversationContext) GetActiveDocument

func (x *ConversationContext) GetActiveDocument() string

func (*ConversationContext) GetContextDocuments

func (x *ConversationContext) GetContextDocuments() []string

func (*ConversationContext) ProtoMessage

func (*ConversationContext) ProtoMessage()

func (*ConversationContext) ProtoReflect

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

func (*ConversationContext) Reset

func (x *ConversationContext) Reset()

func (*ConversationContext) String

func (x *ConversationContext) String() string

type ConversationMessage

type ConversationMessage struct {

	// Types that are assignable to Message:
	//
	//	*ConversationMessage_UserInput
	//	*ConversationMessage_Reply
	Message isConversationMessage_Message `protobuf_oneof:"message"`
	// Output only. Message creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Defines a conversation message.

func (*ConversationMessage) Descriptor deprecated

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

Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.

func (*ConversationMessage) GetCreateTime

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

func (*ConversationMessage) GetMessage

func (m *ConversationMessage) GetMessage() isConversationMessage_Message

func (*ConversationMessage) GetReply

func (x *ConversationMessage) GetReply() *Reply

func (*ConversationMessage) GetUserInput

func (x *ConversationMessage) GetUserInput() *TextInput

func (*ConversationMessage) ProtoMessage

func (*ConversationMessage) ProtoMessage()

func (*ConversationMessage) ProtoReflect

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

func (*ConversationMessage) Reset

func (x *ConversationMessage) Reset()

func (*ConversationMessage) String

func (x *ConversationMessage) String() string

type ConversationMessage_Reply

type ConversationMessage_Reply struct {
	// Search reply.
	Reply *Reply `protobuf:"bytes,2,opt,name=reply,proto3,oneof"`
}

type ConversationMessage_UserInput

type ConversationMessage_UserInput struct {
	// User text input.
	UserInput *TextInput `protobuf:"bytes,1,opt,name=user_input,json=userInput,proto3,oneof"`
}

type Conversation_State

type Conversation_State int32

Enumeration of the state of the conversation.

const (
	// Unknown.
	Conversation_STATE_UNSPECIFIED Conversation_State = 0
	// Conversation is currently open.
	Conversation_IN_PROGRESS Conversation_State = 1
	// Conversation has been completed.
	Conversation_COMPLETED Conversation_State = 2
)

func (Conversation_State) Descriptor

func (Conversation_State) Enum

func (Conversation_State) EnumDescriptor deprecated

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

Deprecated: Use Conversation_State.Descriptor instead.

func (Conversation_State) Number

func (Conversation_State) String

func (x Conversation_State) String() string

func (Conversation_State) Type

type ConversationalSearchServiceClient

type ConversationalSearchServiceClient interface {
	// Converses a conversation.
	ConverseConversation(ctx context.Context, in *ConverseConversationRequest, opts ...grpc.CallOption) (*ConverseConversationResponse, error)
	// Creates a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
	// create already exists, an ALREADY_EXISTS error is returned.
	CreateConversation(ctx context.Context, in *CreateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
	// Deletes a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
	// delete does not exist, a NOT_FOUND error is returned.
	DeleteConversation(ctx context.Context, in *DeleteConversationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates a Conversation.
	//
	// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
	// type cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
	// does not exist, a NOT_FOUND error is returned.
	UpdateConversation(ctx context.Context, in *UpdateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
	// Gets a Conversation.
	GetConversation(ctx context.Context, in *GetConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
	// Lists all Conversations by their parent
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	ListConversations(ctx context.Context, in *ListConversationsRequest, opts ...grpc.CallOption) (*ListConversationsResponse, error)
}

ConversationalSearchServiceClient is the client API for ConversationalSearchService service.

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

type ConversationalSearchServiceServer

type ConversationalSearchServiceServer interface {
	// Converses a conversation.
	ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)
	// Creates a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
	// create already exists, an ALREADY_EXISTS error is returned.
	CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)
	// Deletes a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
	// delete does not exist, a NOT_FOUND error is returned.
	DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)
	// Updates a Conversation.
	//
	// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
	// type cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
	// does not exist, a NOT_FOUND error is returned.
	UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)
	// Gets a Conversation.
	GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)
	// Lists all Conversations by their parent
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
}

ConversationalSearchServiceServer is the server API for ConversationalSearchService service.

type ConverseConversationRequest

type ConverseConversationRequest struct {

	// Required. The resource name of the Conversation to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
	// Use
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
	// to activate auto session mode, which automatically creates a new
	// conversation inside a ConverseConversation session.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Current user input.
	Query *TextInput `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The resource name of the Serving Config to use. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
	// If this is not set, the default serving config will be used.
	ServingConfig string `protobuf:"bytes,3,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// The conversation to be used by auto session only. The name field will be
	// ignored as we automatically assign new name for the conversation in auto
	// session.
	Conversation *Conversation `protobuf:"bytes,5,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// Whether to turn on safe search.
	SafeSearch bool `protobuf:"varint,6,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 `` /* 179-byte string literal not displayed */
	// A specification for configuring the summary returned in the response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,8,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,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. This will be used to filter search results
	// which may affect the summary response.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
	// key property defined in the Vertex AI Search backend -- this mapping is
	// defined by the customer in their schema. For example a media customer might
	// have a field 'name' in their schema. In this case the filter would look
	// like this: filter --> name:'ANY("king kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
	// Boost specification to boost certain documents in search results which may
	// affect the converse response. For more information on boosting, see
	// [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] method.

func (*ConverseConversationRequest) Descriptor deprecated

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

Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.

func (*ConverseConversationRequest) GetBoostSpec added in v1.6.0

func (*ConverseConversationRequest) GetConversation

func (x *ConverseConversationRequest) GetConversation() *Conversation

func (*ConverseConversationRequest) GetFilter added in v1.4.0

func (x *ConverseConversationRequest) GetFilter() string

func (*ConverseConversationRequest) GetName

func (x *ConverseConversationRequest) GetName() string

func (*ConverseConversationRequest) GetQuery

func (x *ConverseConversationRequest) GetQuery() *TextInput

func (*ConverseConversationRequest) GetSafeSearch

func (x *ConverseConversationRequest) GetSafeSearch() bool

func (*ConverseConversationRequest) GetServingConfig

func (x *ConverseConversationRequest) GetServingConfig() string

func (*ConverseConversationRequest) GetSummarySpec

func (*ConverseConversationRequest) GetUserLabels

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

func (*ConverseConversationRequest) ProtoMessage

func (*ConverseConversationRequest) ProtoMessage()

func (*ConverseConversationRequest) ProtoReflect

func (*ConverseConversationRequest) Reset

func (x *ConverseConversationRequest) Reset()

func (*ConverseConversationRequest) String

func (x *ConverseConversationRequest) String() string

type ConverseConversationResponse

type ConverseConversationResponse struct {

	// Answer to the current query.
	Reply *Reply `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
	// Updated conversation including the answer.
	Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// Suggested related questions.
	RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
	// Search Results.
	SearchResults []*SearchResponse_SearchResult `protobuf:"bytes,3,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] method.

func (*ConverseConversationResponse) Descriptor deprecated

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

Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.

func (*ConverseConversationResponse) GetConversation

func (x *ConverseConversationResponse) GetConversation() *Conversation

func (*ConverseConversationResponse) GetRelatedQuestions

func (x *ConverseConversationResponse) GetRelatedQuestions() []string

func (*ConverseConversationResponse) GetReply

func (x *ConverseConversationResponse) GetReply() *Reply

func (*ConverseConversationResponse) GetSearchResults

func (*ConverseConversationResponse) ProtoMessage

func (*ConverseConversationResponse) ProtoMessage()

func (*ConverseConversationResponse) ProtoReflect

func (*ConverseConversationResponse) Reset

func (x *ConverseConversationResponse) Reset()

func (*ConverseConversationResponse) String

type CreateConversationRequest

type CreateConversationRequest struct {

	// Required. Full resource name of parent data store. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The conversation to create.
	Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateConversation method.

func (*CreateConversationRequest) Descriptor deprecated

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

Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.

func (*CreateConversationRequest) GetConversation

func (x *CreateConversationRequest) GetConversation() *Conversation

func (*CreateConversationRequest) GetParent

func (x *CreateConversationRequest) GetParent() string

func (*CreateConversationRequest) ProtoMessage

func (*CreateConversationRequest) ProtoMessage()

func (*CreateConversationRequest) ProtoReflect

func (*CreateConversationRequest) Reset

func (x *CreateConversationRequest) Reset()

func (*CreateConversationRequest) String

func (x *CreateConversationRequest) String() string

type CreateDataStoreMetadata

type CreateDataStoreMetadata 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 related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateDataStoreMetadata) Descriptor deprecated

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

Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*CreateDataStoreMetadata) GetCreateTime

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

func (*CreateDataStoreMetadata) GetUpdateTime

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

func (*CreateDataStoreMetadata) ProtoMessage

func (*CreateDataStoreMetadata) ProtoMessage()

func (*CreateDataStoreMetadata) ProtoReflect

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

func (*CreateDataStoreMetadata) Reset

func (x *CreateDataStoreMetadata) Reset()

func (*CreateDataStoreMetadata) String

func (x *CreateDataStoreMetadata) String() string

type CreateDataStoreRequest

type CreateDataStoreRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
	// to create.
	DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The ID to use for the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], which will
	// become the final component of the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s resource
	// name.
	//
	// 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.
	DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
	// A boolean flag indicating whether user want to directly create an advanced
	// data store for site search.
	// If the data store is not configured as site
	// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
	// be ignored.
	CreateAdvancedSiteSearch bool `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] method.

func (*CreateDataStoreRequest) Descriptor deprecated

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

Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch

func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() bool

func (*CreateDataStoreRequest) GetDataStore

func (x *CreateDataStoreRequest) GetDataStore() *DataStore

func (*CreateDataStoreRequest) GetDataStoreId

func (x *CreateDataStoreRequest) GetDataStoreId() string

func (*CreateDataStoreRequest) GetParent

func (x *CreateDataStoreRequest) GetParent() string

func (*CreateDataStoreRequest) ProtoMessage

func (*CreateDataStoreRequest) ProtoMessage()

func (*CreateDataStoreRequest) ProtoReflect

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

func (*CreateDataStoreRequest) Reset

func (x *CreateDataStoreRequest) Reset()

func (*CreateDataStoreRequest) String

func (x *CreateDataStoreRequest) String() string

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.v1alpha.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.v1alpha.Document], which will
	// become the final component of the
	// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name].
	//
	// If the caller does not have permission to create the
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]s with the same
	// [parent][google.cloud.discoveryengine.v1alpha.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.v1alpha.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 CreateEngineMetadata

type CreateEngineMetadata 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 related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateEngineMetadata) Descriptor deprecated

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

Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.

func (*CreateEngineMetadata) GetCreateTime

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

func (*CreateEngineMetadata) GetUpdateTime

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

func (*CreateEngineMetadata) ProtoMessage

func (*CreateEngineMetadata) ProtoMessage()

func (*CreateEngineMetadata) ProtoReflect

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

func (*CreateEngineMetadata) Reset

func (x *CreateEngineMetadata) Reset()

func (*CreateEngineMetadata) String

func (x *CreateEngineMetadata) String() string

type CreateEngineRequest

type CreateEngineRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Engine][google.cloud.discoveryengine.v1alpha.Engine] to
	// create.
	Engine *Engine `protobuf:"bytes,2,opt,name=engine,proto3" json:"engine,omitempty"`
	// Required. The ID to use for the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], which will become
	// the final component of the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s resource name.
	//
	// 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.
	EngineId string `protobuf:"bytes,3,opt,name=engine_id,json=engineId,proto3" json:"engine_id,omitempty"`
	// contains filtered or unexported fields
}

Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] method.

func (*CreateEngineRequest) Descriptor deprecated

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

Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.

func (*CreateEngineRequest) GetEngine

func (x *CreateEngineRequest) GetEngine() *Engine

func (*CreateEngineRequest) GetEngineId

func (x *CreateEngineRequest) GetEngineId() string

func (*CreateEngineRequest) GetParent

func (x *CreateEngineRequest) GetParent() string

func (*CreateEngineRequest) ProtoMessage

func (*CreateEngineRequest) ProtoMessage()

func (*CreateEngineRequest) ProtoReflect

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

func (*CreateEngineRequest) Reset

func (x *CreateEngineRequest) Reset()

func (*CreateEngineRequest) String

func (x *CreateEngineRequest) String() string

type CreateSchemaMetadata

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

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

Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*CreateSchemaMetadata) GetCreateTime

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

func (*CreateSchemaMetadata) GetUpdateTime

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

func (*CreateSchemaMetadata) ProtoMessage

func (*CreateSchemaMetadata) ProtoMessage()

func (*CreateSchemaMetadata) ProtoReflect

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

func (*CreateSchemaMetadata) Reset

func (x *CreateSchemaMetadata) Reset()

func (*CreateSchemaMetadata) String

func (x *CreateSchemaMetadata) String() string

type CreateSchemaRequest

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.v1alpha.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.v1alpha.Schema], which will become
	// the final component of the
	// [Schema.name][google.cloud.discoveryengine.v1alpha.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.v1alpha.SchemaService.CreateSchema] method.

func (*CreateSchemaRequest) Descriptor deprecated

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

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect

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

func (*CreateSchemaRequest) Reset

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String

func (x *CreateSchemaRequest) String() string

type CreateTargetSiteMetadata added in v1.4.0

type CreateTargetSiteMetadata 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 related to the progress of the [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateTargetSiteMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteMetadata) GetCreateTime added in v1.4.0

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

func (*CreateTargetSiteMetadata) GetUpdateTime added in v1.4.0

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

func (*CreateTargetSiteMetadata) ProtoMessage added in v1.4.0

func (*CreateTargetSiteMetadata) ProtoMessage()

func (*CreateTargetSiteMetadata) ProtoReflect added in v1.4.0

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

func (*CreateTargetSiteMetadata) Reset added in v1.4.0

func (x *CreateTargetSiteMetadata) Reset()

func (*CreateTargetSiteMetadata) String added in v1.4.0

func (x *CreateTargetSiteMetadata) String() string

type CreateTargetSiteRequest added in v1.4.0

type CreateTargetSiteRequest struct {

	// Required. Parent resource name of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]
	// to create.
	TargetSite *TargetSite `protobuf:"bytes,2,opt,name=target_site,json=targetSite,proto3" json:"target_site,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] method.

func (*CreateTargetSiteRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteRequest) GetParent added in v1.4.0

func (x *CreateTargetSiteRequest) GetParent() string

func (*CreateTargetSiteRequest) GetTargetSite added in v1.4.0

func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSite

func (*CreateTargetSiteRequest) ProtoMessage added in v1.4.0

func (*CreateTargetSiteRequest) ProtoMessage()

func (*CreateTargetSiteRequest) ProtoReflect added in v1.4.0

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

func (*CreateTargetSiteRequest) Reset added in v1.4.0

func (x *CreateTargetSiteRequest) Reset()

func (*CreateTargetSiteRequest) String added in v1.4.0

func (x *CreateTargetSiteRequest) 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.v1alpha.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.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.v1alpha.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.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.v1alpha.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 CustomFineTuningSpec added in v1.6.0

type CustomFineTuningSpec struct {

	// Whether or not to enable and include custom fine tuned search adaptor
	// model.
	EnableSearchAdaptor bool `protobuf:"varint,1,opt,name=enable_search_adaptor,json=enableSearchAdaptor,proto3" json:"enable_search_adaptor,omitempty"`
	// contains filtered or unexported fields
}

Defines custom fine tuning spec.

func (*CustomFineTuningSpec) Descriptor deprecated added in v1.6.0

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

Deprecated: Use CustomFineTuningSpec.ProtoReflect.Descriptor instead.

func (*CustomFineTuningSpec) GetEnableSearchAdaptor added in v1.6.0

func (x *CustomFineTuningSpec) GetEnableSearchAdaptor() bool

func (*CustomFineTuningSpec) ProtoMessage added in v1.6.0

func (*CustomFineTuningSpec) ProtoMessage()

func (*CustomFineTuningSpec) ProtoReflect added in v1.6.0

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

func (*CustomFineTuningSpec) Reset added in v1.6.0

func (x *CustomFineTuningSpec) Reset()

func (*CustomFineTuningSpec) String added in v1.6.0

func (x *CustomFineTuningSpec) String() string

type DataStore

type DataStore struct {

	// Immutable. The full resource name of the data store.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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"`
	// Required. The data store display name.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Immutable. The industry vertical that the data store registers.
	IndustryVertical IndustryVertical `` /* 169-byte string literal not displayed */
	// The solutions that the data store enrolls. Available solutions for each
	// [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]:
	//
	//   - `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
	//   - `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
	//     solutions cannot be enrolled.
	SolutionTypes []SolutionType `` /* 163-byte string literal not displayed */
	// Output only. The id of the default
	// [Schema][google.cloud.discoveryengine.v1alpha.Schema] asscociated to this
	// data store.
	DefaultSchemaId string `protobuf:"bytes,7,opt,name=default_schema_id,json=defaultSchemaId,proto3" json:"default_schema_id,omitempty"`
	// Immutable. The content config of the data store. If this field is unset,
	// the server behavior defaults to
	// [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT].
	ContentConfig DataStore_ContentConfig `` /* 167-byte string literal not displayed */
	// Output only. Timestamp the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Data store level identity provider config.
	IdpConfig *IdpConfig `protobuf:"bytes,21,opt,name=idp_config,json=idpConfig,proto3" json:"idp_config,omitempty"`
	// Immutable. Whether data in the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] has ACL
	// information. If set to `true`, the source data must have ACL. ACL will be
	// ingested when data is ingested by
	// [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments]
	// methods.
	//
	// When ACL is enabled for the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore],
	// [Document][google.cloud.discoveryengine.v1alpha.Document] can't be accessed
	// by calling
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
	//
	// Currently ACL is only supported in `GENERIC` industry vertical with
	// non-`PUBLIC_WEBSITE` content config.
	AclEnabled bool `protobuf:"varint,24,opt,name=acl_enabled,json=aclEnabled,proto3" json:"acl_enabled,omitempty"`
	// Configuration for Document understanding and enrichment.
	DocumentProcessingConfig *DocumentProcessingConfig `` /* 136-byte string literal not displayed */
	// The start schema to use for this
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] when
	// provisioning it. If unset, a default vertical specialized schema will be
	// used.
	//
	// This field is only used by [CreateDataStore][] API, and will be ignored if
	// used in other APIs. This field will be omitted from all API responses
	// including [CreateDataStore][] API. To retrieve a schema of a
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], use
	// [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema]
	// API instead.
	//
	// The provided schema will be validated against certain rules on schema.
	// Learn more from [this
	// doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
	StartingSchema *Schema `protobuf:"bytes,28,opt,name=starting_schema,json=startingSchema,proto3" json:"starting_schema,omitempty"`
	// contains filtered or unexported fields
}

DataStore captures global settings and configs at the DataStore level.

func (*DataStore) Descriptor deprecated

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

Deprecated: Use DataStore.ProtoReflect.Descriptor instead.

func (*DataStore) GetAclEnabled added in v1.6.0

func (x *DataStore) GetAclEnabled() bool

func (*DataStore) GetContentConfig

func (x *DataStore) GetContentConfig() DataStore_ContentConfig

func (*DataStore) GetCreateTime

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

func (*DataStore) GetDefaultSchemaId

func (x *DataStore) GetDefaultSchemaId() string

func (*DataStore) GetDisplayName

func (x *DataStore) GetDisplayName() string

func (*DataStore) GetDocumentProcessingConfig added in v1.6.0

func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*DataStore) GetIdpConfig added in v1.6.0

func (x *DataStore) GetIdpConfig() *IdpConfig

func (*DataStore) GetIndustryVertical

func (x *DataStore) GetIndustryVertical() IndustryVertical

func (*DataStore) GetName

func (x *DataStore) GetName() string

func (*DataStore) GetSolutionTypes

func (x *DataStore) GetSolutionTypes() []SolutionType

func (*DataStore) GetStartingSchema added in v1.6.0

func (x *DataStore) GetStartingSchema() *Schema

func (*DataStore) ProtoMessage

func (*DataStore) ProtoMessage()

func (*DataStore) ProtoReflect

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

func (*DataStore) Reset

func (x *DataStore) Reset()

func (*DataStore) String

func (x *DataStore) String() string

type DataStoreServiceClient

type DataStoreServiceClient interface {
	// Creates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	//
	// DataStore is for storing
	// [Documents][google.cloud.discoveryengine.v1alpha.Document]. To serve these
	// documents for Search, or Recommendation use case, an
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to be created
	// separately.
	CreateDataStore(ctx context.Context, in *CreateDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	GetDataStore(ctx context.Context, in *GetDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
	// Lists all the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s
	// associated with the project.
	ListDataStores(ctx context.Context, in *ListDataStoresRequest, opts ...grpc.CallOption) (*ListDataStoresResponse, error)
	// Deletes a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	DeleteDataStore(ctx context.Context, in *DeleteDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
	UpdateDataStore(ctx context.Context, in *UpdateDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
	// Gets a
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	GetDocumentProcessingConfig(ctx context.Context, in *GetDocumentProcessingConfigRequest, opts ...grpc.CallOption) (*DocumentProcessingConfig, error)
	// Updates the
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
	// is a singleon resource of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty
	// when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is
	// created. The first call to this method will set up
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	UpdateDocumentProcessingConfig(ctx context.Context, in *UpdateDocumentProcessingConfigRequest, opts ...grpc.CallOption) (*DocumentProcessingConfig, error)
}

DataStoreServiceClient is the client API for DataStoreService service.

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

type DataStoreServiceServer

type DataStoreServiceServer interface {
	// Creates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	//
	// DataStore is for storing
	// [Documents][google.cloud.discoveryengine.v1alpha.Document]. To serve these
	// documents for Search, or Recommendation use case, an
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to be created
	// separately.
	CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)
	// Gets a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)
	// Lists all the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s
	// associated with the project.
	ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)
	// Deletes a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
	DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)
	// Updates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
	UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)
	// Gets a
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	GetDocumentProcessingConfig(context.Context, *GetDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)
	// Updates the
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
	// is a singleon resource of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty
	// when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is
	// created. The first call to this method will set up
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
	UpdateDocumentProcessingConfig(context.Context, *UpdateDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)
}

DataStoreServiceServer is the server API for DataStoreService service.

type DataStore_ContentConfig

type DataStore_ContentConfig int32

Content config of the data store.

const (
	// Default value.
	DataStore_CONTENT_CONFIG_UNSPECIFIED DataStore_ContentConfig = 0
	// Only contains documents without any
	// [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
	DataStore_NO_CONTENT DataStore_ContentConfig = 1
	// Only contains documents with
	// [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
	DataStore_CONTENT_REQUIRED DataStore_ContentConfig = 2
	// The data store is used for public website search.
	DataStore_PUBLIC_WEBSITE DataStore_ContentConfig = 3
)

func (DataStore_ContentConfig) Descriptor

func (DataStore_ContentConfig) Enum

func (DataStore_ContentConfig) EnumDescriptor deprecated

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

Deprecated: Use DataStore_ContentConfig.Descriptor instead.

func (DataStore_ContentConfig) Number

func (DataStore_ContentConfig) String

func (x DataStore_ContentConfig) String() string

func (DataStore_ContentConfig) Type

type DeleteConversationRequest

type DeleteConversationRequest struct {

	// Required. The resource name of the Conversation to delete. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for DeleteConversation method.

func (*DeleteConversationRequest) Descriptor deprecated

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

Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.

func (*DeleteConversationRequest) GetName

func (x *DeleteConversationRequest) GetName() string

func (*DeleteConversationRequest) ProtoMessage

func (*DeleteConversationRequest) ProtoMessage()

func (*DeleteConversationRequest) ProtoReflect

func (*DeleteConversationRequest) Reset

func (x *DeleteConversationRequest) Reset()

func (*DeleteConversationRequest) String

func (x *DeleteConversationRequest) String() string

type DeleteDataStoreMetadata

type DeleteDataStoreMetadata 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 related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteDataStoreMetadata) Descriptor deprecated

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

Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreMetadata) GetCreateTime

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

func (*DeleteDataStoreMetadata) GetUpdateTime

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

func (*DeleteDataStoreMetadata) ProtoMessage

func (*DeleteDataStoreMetadata) ProtoMessage()

func (*DeleteDataStoreMetadata) ProtoReflect

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

func (*DeleteDataStoreMetadata) Reset

func (x *DeleteDataStoreMetadata) Reset()

func (*DeleteDataStoreMetadata) String

func (x *DeleteDataStoreMetadata) String() string

type DeleteDataStoreRequest

type DeleteDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	//
	// If the caller does not have permission to delete the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] 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 [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] method.

func (*DeleteDataStoreRequest) Descriptor deprecated

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

Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreRequest) GetName

func (x *DeleteDataStoreRequest) GetName() string

func (*DeleteDataStoreRequest) ProtoMessage

func (*DeleteDataStoreRequest) ProtoMessage()

func (*DeleteDataStoreRequest) ProtoReflect

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

func (*DeleteDataStoreRequest) Reset

func (x *DeleteDataStoreRequest) Reset()

func (*DeleteDataStoreRequest) String

func (x *DeleteDataStoreRequest) String() string

type DeleteDocumentRequest

type DeleteDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.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 DeleteEngineMetadata

type DeleteEngineMetadata 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 related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteEngineMetadata) Descriptor deprecated

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

Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.

func (*DeleteEngineMetadata) GetCreateTime

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

func (*DeleteEngineMetadata) GetUpdateTime

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

func (*DeleteEngineMetadata) ProtoMessage

func (*DeleteEngineMetadata) ProtoMessage()

func (*DeleteEngineMetadata) ProtoReflect

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

func (*DeleteEngineMetadata) Reset

func (x *DeleteEngineMetadata) Reset()

func (*DeleteEngineMetadata) String

func (x *DeleteEngineMetadata) String() string

type DeleteEngineRequest

type DeleteEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
	//
	// If the caller does not have permission to delete the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] 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 [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] method.

func (*DeleteEngineRequest) Descriptor deprecated

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

Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.

func (*DeleteEngineRequest) GetName

func (x *DeleteEngineRequest) GetName() string

func (*DeleteEngineRequest) ProtoMessage

func (*DeleteEngineRequest) ProtoMessage()

func (*DeleteEngineRequest) ProtoReflect

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

func (*DeleteEngineRequest) Reset

func (x *DeleteEngineRequest) Reset()

func (*DeleteEngineRequest) String

func (x *DeleteEngineRequest) String() string

type DeleteSchemaMetadata

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

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

Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSchemaMetadata) GetCreateTime

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

func (*DeleteSchemaMetadata) GetUpdateTime

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

func (*DeleteSchemaMetadata) ProtoMessage

func (*DeleteSchemaMetadata) ProtoMessage()

func (*DeleteSchemaMetadata) ProtoReflect

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

func (*DeleteSchemaMetadata) Reset

func (x *DeleteSchemaMetadata) Reset()

func (*DeleteSchemaMetadata) String

func (x *DeleteSchemaMetadata) String() string

type DeleteSchemaRequest

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.v1alpha.SchemaService.DeleteSchema] method.

func (*DeleteSchemaRequest) Descriptor deprecated

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

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect

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

func (*DeleteSchemaRequest) Reset

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String

func (x *DeleteSchemaRequest) String() string

type DeleteTargetSiteMetadata added in v1.4.0

type DeleteTargetSiteMetadata 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 related to the progress of the [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteTargetSiteMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteMetadata) GetCreateTime added in v1.4.0

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

func (*DeleteTargetSiteMetadata) GetUpdateTime added in v1.4.0

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

func (*DeleteTargetSiteMetadata) ProtoMessage added in v1.4.0

func (*DeleteTargetSiteMetadata) ProtoMessage()

func (*DeleteTargetSiteMetadata) ProtoReflect added in v1.4.0

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

func (*DeleteTargetSiteMetadata) Reset added in v1.4.0

func (x *DeleteTargetSiteMetadata) Reset()

func (*DeleteTargetSiteMetadata) String added in v1.4.0

func (x *DeleteTargetSiteMetadata) String() string

type DeleteTargetSiteRequest added in v1.4.0

type DeleteTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
	//
	// If the caller does not have permission to access the
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] 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 [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] method.

func (*DeleteTargetSiteRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteRequest) GetName added in v1.4.0

func (x *DeleteTargetSiteRequest) GetName() string

func (*DeleteTargetSiteRequest) ProtoMessage added in v1.4.0

func (*DeleteTargetSiteRequest) ProtoMessage()

func (*DeleteTargetSiteRequest) ProtoReflect added in v1.4.0

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

func (*DeleteTargetSiteRequest) Reset added in v1.4.0

func (x *DeleteTargetSiteRequest) Reset()

func (*DeleteTargetSiteRequest) String added in v1.4.0

func (x *DeleteTargetSiteRequest) String() string

type DisableAdvancedSiteSearchMetadata added in v1.4.0

type DisableAdvancedSiteSearchMetadata 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 related to the progress of the [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DisableAdvancedSiteSearchMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchMetadata) GetCreateTime added in v1.4.0

func (*DisableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.4.0

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage added in v1.4.0

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()

func (*DisableAdvancedSiteSearchMetadata) ProtoReflect added in v1.4.0

func (*DisableAdvancedSiteSearchMetadata) Reset added in v1.4.0

func (*DisableAdvancedSiteSearchMetadata) String added in v1.4.0

type DisableAdvancedSiteSearchRequest added in v1.4.0

type DisableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] method.

func (*DisableAdvancedSiteSearchRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.4.0

func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*DisableAdvancedSiteSearchRequest) ProtoMessage added in v1.4.0

func (*DisableAdvancedSiteSearchRequest) ProtoMessage()

func (*DisableAdvancedSiteSearchRequest) ProtoReflect added in v1.4.0

func (*DisableAdvancedSiteSearchRequest) Reset added in v1.4.0

func (*DisableAdvancedSiteSearchRequest) String added in v1.4.0

type DisableAdvancedSiteSearchResponse added in v1.4.0

type DisableAdvancedSiteSearchResponse struct {
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] method.

func (*DisableAdvancedSiteSearchResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchResponse) ProtoMessage added in v1.4.0

func (*DisableAdvancedSiteSearchResponse) ProtoMessage()

func (*DisableAdvancedSiteSearchResponse) ProtoReflect added in v1.4.0

func (*DisableAdvancedSiteSearchResponse) Reset added in v1.4.0

func (*DisableAdvancedSiteSearchResponse) String added in v1.4.0

type Document

type Document struct {

	// Data representation. One of
	// [struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data] or
	// [json_data][google.cloud.discoveryengine.v1alpha.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"`
	// Access control information for the document.
	AclInfo *Document_AclInfo `protobuf:"bytes,11,opt,name=acl_info,json=aclInfo,proto3" json:"acl_info,omitempty"`
	// Output only. The last time the document was indexed. If this field is set,
	// the document could be returned in search results.
	//
	// This field is OUTPUT_ONLY. If this field is not populated, it means the
	// document has never been indexed.
	IndexTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=index_time,json=indexTime,proto3" json:"index_time,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) GetAclInfo added in v1.6.0

func (x *Document) GetAclInfo() *Document_AclInfo

func (*Document) GetContent

func (x *Document) GetContent() *Document_Content

func (*Document) GetData

func (m *Document) GetData() isDocument_Data

func (*Document) GetDerivedStructData

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

func (*Document) GetId

func (x *Document) GetId() string

func (*Document) GetIndexTime added in v1.6.0

func (x *Document) GetIndexTime() *timestamppb.Timestamp

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.v1alpha.Document].
	//
	// * If [id][google.cloud.discoveryengine.v1alpha.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.v1alpha.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
	//	*DocumentInfo_Uri
	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) GetUri

func (x *DocumentInfo) GetUri() string

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 {
	// The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
	// ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type DocumentInfo_Name

type DocumentInfo_Name struct {
	// The [Document][google.cloud.discoveryengine.v1alpha.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 DocumentInfo_Uri

type DocumentInfo_Uri struct {
	// The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only
	// allowed for website data stores.
	Uri string `protobuf:"bytes,6,opt,name=uri,proto3,oneof"`
}

type DocumentProcessingConfig added in v1.6.0

type DocumentProcessingConfig struct {

	// The full resource name of the Document Processing Config.
	// Format:
	// `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Whether chunking mode is enabled.
	ChunkingConfig *DocumentProcessingConfig_ChunkingConfig `protobuf:"bytes,3,opt,name=chunking_config,json=chunkingConfig,proto3" json:"chunking_config,omitempty"`
	// Configurations for default Document parser.
	// If not specified, we will configure it as default DigitalParsingConfig, and
	// the default parsing config will be applied to all file types for Document
	// parsing.
	DefaultParsingConfig *DocumentProcessingConfig_ParsingConfig `protobuf:"bytes,4,opt,name=default_parsing_config,json=defaultParsingConfig,proto3" json:"default_parsing_config,omitempty"`
	// Map from file type to override the default parsing configuration based on
	// the file type. Supported keys:
	// * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
	// parsing or layout parsing is supported.
	// * `html`: Override parsing config for HTML files, only digital parsing and
	// or layout parsing are supported.
	// * `docx`: Override parsing config for DOCX files, only digital parsing and
	// or layout parsing are supported.
	ParsingConfigOverrides map[string]*DocumentProcessingConfig_ParsingConfig `` /* 217-byte string literal not displayed */
	// contains filtered or unexported fields
}

A singleton resource of DataStore[google.cloud.discoveryengine.v1alpha.DataStore]. It's empty when DataStore[google.cloud.discoveryengine.v1alpha.DataStore] is created, which defaults to digital parser. The first call to [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] method will initialize the config.

func (*DocumentProcessingConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig) GetChunkingConfig added in v1.6.0

func (*DocumentProcessingConfig) GetDefaultParsingConfig added in v1.6.0

func (*DocumentProcessingConfig) GetName added in v1.6.0

func (x *DocumentProcessingConfig) GetName() string

func (*DocumentProcessingConfig) GetParsingConfigOverrides added in v1.6.0

func (x *DocumentProcessingConfig) GetParsingConfigOverrides() map[string]*DocumentProcessingConfig_ParsingConfig

func (*DocumentProcessingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig) ProtoMessage()

func (*DocumentProcessingConfig) ProtoReflect added in v1.6.0

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

func (*DocumentProcessingConfig) Reset added in v1.6.0

func (x *DocumentProcessingConfig) Reset()

func (*DocumentProcessingConfig) String added in v1.6.0

func (x *DocumentProcessingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig added in v1.6.0

type DocumentProcessingConfig_ChunkingConfig struct {

	// Additional configs that defines the behavior of the chunking.
	//
	// Types that are assignable to ChunkMode:
	//
	//	*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_
	ChunkMode isDocumentProcessingConfig_ChunkingConfig_ChunkMode `protobuf_oneof:"chunk_mode"`
	// contains filtered or unexported fields
}

Configuration for chunking config.

func (*DocumentProcessingConfig_ChunkingConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode added in v1.6.0

func (m *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkMode

func (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig) String added in v1.6.0

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig added in v1.6.0

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {

	// The token size limit for each chunk.
	//
	// Supported values: 100-500 (inclusive).
	// Default value: 500.
	ChunkSize int32 `protobuf:"varint,1,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
	// Whether to include appending different levels of headings to chunks
	// from the middle of the document to prevent context loss.
	//
	// Default value: False.
	IncludeAncestorHeadings bool `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for the layout based chunking.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Descriptor deprecated added in v1.6.0

Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String added in v1.6.0

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ added in v1.6.0

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ struct {
	// Configuration for the layout based chunking.
	LayoutBasedChunkingConfig *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig `protobuf:"bytes,1,opt,name=layout_based_chunking_config,json=layoutBasedChunkingConfig,proto3,oneof"`
}

type DocumentProcessingConfig_ParsingConfig added in v1.6.0

type DocumentProcessingConfig_ParsingConfig struct {

	// Configs for document processing types.
	//
	// Types that are assignable to TypeDedicatedConfig:
	//
	//	*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_
	//	*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_
	//	*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_
	TypeDedicatedConfig isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig `protobuf_oneof:"type_dedicated_config"`
	// contains filtered or unexported fields
}

Related configurations applied to a specific type of document parser.

func (*DocumentProcessingConfig_ParsingConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig added in v1.6.0

func (m *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig) String added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig struct {
	// contains filtered or unexported fields
}

The digital parsing configurations for documents.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Descriptor deprecated added in v1.6.0

Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_ added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_ struct {
	// Configurations applied to digital parser.
	DigitalParsingConfig *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig `protobuf:"bytes,1,opt,name=digital_parsing_config,json=digitalParsingConfig,proto3,oneof"`
}

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig struct {
	// contains filtered or unexported fields
}

The layout parsing configurations for documents.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Descriptor deprecated added in v1.6.0

Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ struct {
	// Configurations applied to layout parser.
	LayoutParsingConfig *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig `protobuf:"bytes,3,opt,name=layout_parsing_config,json=layoutParsingConfig,proto3,oneof"`
}

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {

	// Apply additional enhanced OCR processing to a list of document
	// elements.
	//
	// Supported values:
	// * `table`: advanced table parsing model.
	EnhancedDocumentElements []string `` /* 135-byte string literal not displayed */
	// If true, will use native text instead of OCR text on pages containing
	// native text.
	UseNativeText bool `protobuf:"varint,2,opt,name=use_native_text,json=useNativeText,proto3" json:"use_native_text,omitempty"`
	// contains filtered or unexported fields
}

The OCR parsing configurations for documents.

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor deprecated added in v1.6.0

Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetEnhancedDocumentElements added in v1.6.0

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetEnhancedDocumentElements() []string

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset added in v1.6.0

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_ added in v1.6.0

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_ struct {
	// Configurations applied to OCR parser. Currently it only applies to
	// PDFs.
	OcrParsingConfig *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig `protobuf:"bytes,2,opt,name=ocr_parsing_config,json=ocrParsingConfig,proto3,oneof"`
}

type DocumentServiceClient

type DocumentServiceClient interface {
	// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].
	CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].
	UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
	DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.Document]s in a branch.
	//
	// This process is asynchronous. Depending on the number of
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
	// this operation can take hours to complete. Before the delete operation
	// completes, some [Document][google.cloud.discoveryengine.v1alpha.Document]s
	// might still be returned by
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
	//
	// To get a list of the
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
	// set
	// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.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.

type DocumentServiceServer

type DocumentServiceServer interface {
	// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
	GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
	// Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].
	CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
	// Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].
	UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
	// Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
	DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]s to be
	// successfully updated.
	ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
	// Permanently deletes all selected
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s in a branch.
	//
	// This process is asynchronous. Depending on the number of
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
	// this operation can take hours to complete. Before the delete operation
	// completes, some [Document][google.cloud.discoveryengine.v1alpha.Document]s
	// might still be returned by
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
	//
	// To get a list of the
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
	// set
	// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force]
	// to false.
	PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
}

DocumentServiceServer is the server API for DocumentService service.

type Document_AclInfo added in v1.6.0

type Document_AclInfo struct {

	// Readers of the document.
	Readers []*Document_AclInfo_AccessRestriction `protobuf:"bytes,1,rep,name=readers,proto3" json:"readers,omitempty"`
	// contains filtered or unexported fields
}

ACL Information of the Document.

func (*Document_AclInfo) Descriptor deprecated added in v1.6.0

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

Deprecated: Use Document_AclInfo.ProtoReflect.Descriptor instead.

func (*Document_AclInfo) GetReaders added in v1.6.0

func (*Document_AclInfo) ProtoMessage added in v1.6.0

func (*Document_AclInfo) ProtoMessage()

func (*Document_AclInfo) ProtoReflect added in v1.6.0

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

func (*Document_AclInfo) Reset added in v1.6.0

func (x *Document_AclInfo) Reset()

func (*Document_AclInfo) String added in v1.6.0

func (x *Document_AclInfo) String() string

type Document_AclInfo_AccessRestriction added in v1.6.0

type Document_AclInfo_AccessRestriction struct {

	// List of principals.
	Principals []*Principal `protobuf:"bytes,1,rep,name=principals,proto3" json:"principals,omitempty"`
	// contains filtered or unexported fields
}

AclRestriction to model complex inheritance restrictions.

Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document.

Document Hierarchy - Space_S --> Page_P.

Readers:

Space_S: group_1, user_1
Page_P: group_2, group_3, user_2

Space_S ACL Restriction -

{
  "acl_info": {
    "readers": [
      {
        "principals": [
          {
            "group_id": "group_1"
          },
          {
            "user_id": "user_1"
          }
        ]
      }
    ]
  }
}

Page_P ACL Restriction.

{
  "acl_info": {
    "readers": [
      {
        "principals": [
          {
            "group_id": "group_2"
          },
          {
            "group_id": "group_3"
          },
          {
            "user_id": "user_2"
          }
        ],
      },
      {
        "principals": [
          {
            "group_id": "group_1"
          },
          {
            "user_id": "user_1"
          }
        ],
      }
    ]
  }
}

func (*Document_AclInfo_AccessRestriction) Descriptor deprecated added in v1.6.0

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

Deprecated: Use Document_AclInfo_AccessRestriction.ProtoReflect.Descriptor instead.

func (*Document_AclInfo_AccessRestriction) GetPrincipals added in v1.6.0

func (x *Document_AclInfo_AccessRestriction) GetPrincipals() []*Principal

func (*Document_AclInfo_AccessRestriction) ProtoMessage added in v1.6.0

func (*Document_AclInfo_AccessRestriction) ProtoMessage()

func (*Document_AclInfo_AccessRestriction) ProtoReflect added in v1.6.0

func (*Document_AclInfo_AccessRestriction) Reset added in v1.6.0

func (*Document_AclInfo_AccessRestriction) String added in v1.6.0

type Document_Content

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, only native PDFs are supported for now)
	// * `text/html` (HTML)
	// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
	// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
	// * `text/plain` (TXT)
	//
	// 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

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

Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.

func (*Document_Content) GetContent

func (m *Document_Content) GetContent() isDocument_Content_Content

func (*Document_Content) GetMimeType

func (x *Document_Content) GetMimeType() string

func (*Document_Content) GetRawBytes

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

func (*Document_Content) GetUri

func (x *Document_Content) GetUri() string

func (*Document_Content) ProtoMessage

func (*Document_Content) ProtoMessage()

func (*Document_Content) ProtoReflect

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

func (*Document_Content) Reset

func (x *Document_Content) Reset()

func (*Document_Content) String

func (x *Document_Content) String() string

type Document_Content_RawBytes

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

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 2.5 MB for text-based formats, 100 MB for other formats.
	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][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,4,opt,name=struct_data,json=structData,proto3,oneof"`
}

type DoubleList

type DoubleList struct {

	// Double values.
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Double list.

func (*DoubleList) Descriptor deprecated

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

Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.

func (*DoubleList) GetValues

func (x *DoubleList) GetValues() []float64

func (*DoubleList) ProtoMessage

func (*DoubleList) ProtoMessage()

func (*DoubleList) ProtoReflect

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

func (*DoubleList) Reset

func (x *DoubleList) Reset()

func (*DoubleList) String

func (x *DoubleList) String() string

type EmbeddingConfig added in v1.6.0

type EmbeddingConfig struct {

	// Full field path in the schema mapped as embedding field.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
	// contains filtered or unexported fields
}

Defines embedding config, used for bring your own embeddings feature.

func (*EmbeddingConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EmbeddingConfig.ProtoReflect.Descriptor instead.

func (*EmbeddingConfig) GetFieldPath added in v1.6.0

func (x *EmbeddingConfig) GetFieldPath() string

func (*EmbeddingConfig) ProtoMessage added in v1.6.0

func (*EmbeddingConfig) ProtoMessage()

func (*EmbeddingConfig) ProtoReflect added in v1.6.0

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

func (*EmbeddingConfig) Reset added in v1.6.0

func (x *EmbeddingConfig) Reset()

func (*EmbeddingConfig) String added in v1.6.0

func (x *EmbeddingConfig) String() string

type EnableAdvancedSiteSearchMetadata added in v1.4.0

type EnableAdvancedSiteSearchMetadata 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 related to the progress of the [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*EnableAdvancedSiteSearchMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchMetadata) GetCreateTime added in v1.4.0

func (*EnableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.4.0

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage added in v1.4.0

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()

func (*EnableAdvancedSiteSearchMetadata) ProtoReflect added in v1.4.0

func (*EnableAdvancedSiteSearchMetadata) Reset added in v1.4.0

func (*EnableAdvancedSiteSearchMetadata) String added in v1.4.0

type EnableAdvancedSiteSearchRequest added in v1.4.0

type EnableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] method.

func (*EnableAdvancedSiteSearchRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.4.0

func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*EnableAdvancedSiteSearchRequest) ProtoMessage added in v1.4.0

func (*EnableAdvancedSiteSearchRequest) ProtoMessage()

func (*EnableAdvancedSiteSearchRequest) ProtoReflect added in v1.4.0

func (*EnableAdvancedSiteSearchRequest) Reset added in v1.4.0

func (*EnableAdvancedSiteSearchRequest) String added in v1.4.0

type EnableAdvancedSiteSearchResponse added in v1.4.0

type EnableAdvancedSiteSearchResponse struct {
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] method.

func (*EnableAdvancedSiteSearchResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchResponse) ProtoMessage added in v1.4.0

func (*EnableAdvancedSiteSearchResponse) ProtoMessage()

func (*EnableAdvancedSiteSearchResponse) ProtoReflect added in v1.4.0

func (*EnableAdvancedSiteSearchResponse) Reset added in v1.4.0

func (*EnableAdvancedSiteSearchResponse) String added in v1.4.0

type Engine

type Engine struct {

	// Additional config specs that defines the behavior of the engine.
	//
	// Types that are assignable to EngineConfig:
	//
	//	*Engine_SimilarDocumentsConfig
	//	*Engine_ChatEngineConfig_
	//	*Engine_SearchEngineConfig_
	//	*Engine_MediaRecommendationEngineConfig_
	EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
	// Engine metadata to monitor the status of the engine.
	//
	// Types that are assignable to EngineMetadata:
	//
	//	*Engine_RecommendationMetadata_
	//	*Engine_ChatEngineMetadata_
	EngineMetadata isEngine_EngineMetadata `protobuf_oneof:"engine_metadata"`
	// Immutable. The fully qualified resource name of the engine.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	//
	// Format:
	// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
	// engine should be 1-63 characters, and valid characters are
	// /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The display name of the engine. Should be human readable. UTF-8
	// encoded string with limit of 1024 characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Timestamp the Recommendation Engine was created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp the Recommendation Engine was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The data stores associated with this engine.
	//
	// For
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
	// and
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
	// type of engines, they can only associate with at most one data store.
	//
	// If
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
	// multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
	// the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
	// be associated here.
	//
	// Note that when used in
	// [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
	// one DataStore id must be provided as the system will use it for necessary
	// initializations.
	DataStoreIds []string `protobuf:"bytes,5,rep,name=data_store_ids,json=dataStoreIds,proto3" json:"data_store_ids,omitempty"`
	// Required. The solutions of the engine.
	SolutionType SolutionType `` /* 153-byte string literal not displayed */
	// The industry vertical that the engine registers.
	// The restriction of the Engine industry vertical is based on
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
	// unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
	// of the DataStore liniked to the engine.
	IndustryVertical IndustryVertical `` /* 170-byte string literal not displayed */
	// Common config spec that specifies the metadata of the engine.
	CommonConfig *Engine_CommonConfig `protobuf:"bytes,15,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// contains filtered or unexported fields
}

Metadata that describes the training and serving parameters of an Engine[google.cloud.discoveryengine.v1alpha.Engine].

func (*Engine) Descriptor deprecated

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

Deprecated: Use Engine.ProtoReflect.Descriptor instead.

func (*Engine) GetChatEngineConfig

func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig

func (*Engine) GetChatEngineMetadata

func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata

func (*Engine) GetCommonConfig

func (x *Engine) GetCommonConfig() *Engine_CommonConfig

func (*Engine) GetCreateTime

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

func (*Engine) GetDataStoreIds

func (x *Engine) GetDataStoreIds() []string

func (*Engine) GetDisplayName

func (x *Engine) GetDisplayName() string

func (*Engine) GetEngineConfig

func (m *Engine) GetEngineConfig() isEngine_EngineConfig

func (*Engine) GetEngineMetadata

func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata

func (*Engine) GetIndustryVertical

func (x *Engine) GetIndustryVertical() IndustryVertical

func (*Engine) GetMediaRecommendationEngineConfig

func (x *Engine) GetMediaRecommendationEngineConfig() *Engine_MediaRecommendationEngineConfig

func (*Engine) GetName

func (x *Engine) GetName() string

func (*Engine) GetRecommendationMetadata

func (x *Engine) GetRecommendationMetadata() *Engine_RecommendationMetadata

func (*Engine) GetSearchEngineConfig

func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfig

func (*Engine) GetSimilarDocumentsConfig

func (x *Engine) GetSimilarDocumentsConfig() *Engine_SimilarDocumentsEngineConfig

func (*Engine) GetSolutionType

func (x *Engine) GetSolutionType() SolutionType

func (*Engine) GetUpdateTime

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

func (*Engine) ProtoMessage

func (*Engine) ProtoMessage()

func (*Engine) ProtoReflect

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

func (*Engine) Reset

func (x *Engine) Reset()

func (*Engine) String

func (x *Engine) String() string

type EngineServiceClient

type EngineServiceClient interface {
	// Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	CreateEngine(ctx context.Context, in *CreateEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	DeleteEngine(ctx context.Context, in *DeleteEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine]
	UpdateEngine(ctx context.Context, in *UpdateEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	GetEngine(ctx context.Context, in *GetEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s
	// associated with the project.
	ListEngines(ctx context.Context, in *ListEnginesRequest, opts ...grpc.CallOption) (*ListEnginesResponse, error)
	// Pauses the training of an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	PauseEngine(ctx context.Context, in *PauseEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Resumes the training of an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	ResumeEngine(ctx context.Context, in *ResumeEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Tunes an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	TuneEngine(ctx context.Context, in *TuneEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

EngineServiceClient is the client API for EngineService service.

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

type EngineServiceServer

type EngineServiceServer interface {
	// Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine]
	UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
	GetEngine(context.Context, *GetEngineRequest) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s
	// associated with the project.
	ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)
	// Pauses the training of an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)
	// Resumes the training of an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)
	// Tunes an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)
}

EngineServiceServer is the server API for EngineService service.

type Engine_ChatEngineConfig

type Engine_ChatEngineConfig struct {

	// The configurationt generate the Dialogflow agent that is associated to
	// this Engine.
	//
	// Note that these configurations are one-time consumed by
	// and passed to Dialogflow service. It means they cannot be retrieved using
	// [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines]
	// API after engine creation.
	AgentCreationConfig *Engine_ChatEngineConfig_AgentCreationConfig `protobuf:"bytes,1,opt,name=agent_creation_config,json=agentCreationConfig,proto3" json:"agent_creation_config,omitempty"`
	// The resource name of an exist Dialogflow agent to link to this Chat
	// Engine. Customers can either provide `agent_creation_config` to create
	// agent or provide an agent name that links the agent with the Chat engine.
	//
	// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
	// ID>`.
	//
	// Note that the `dialogflow_agent_to_link` are one-time consumed by and
	// passed to Dialogflow service. It means they cannot be retrieved using
	// [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines]
	// API after engine creation. Please use
	// [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.dialogflow_agent]
	// for actual agent association after Engine is created.
	DialogflowAgentToLink string `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configurations for a Chat Engine.

func (*Engine_ChatEngineConfig) Descriptor deprecated

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

Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig) GetAgentCreationConfig

func (x *Engine_ChatEngineConfig) GetDialogflowAgentToLink() string

func (*Engine_ChatEngineConfig) ProtoMessage

func (*Engine_ChatEngineConfig) ProtoMessage()

func (*Engine_ChatEngineConfig) ProtoReflect

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

func (*Engine_ChatEngineConfig) Reset

func (x *Engine_ChatEngineConfig) Reset()

func (*Engine_ChatEngineConfig) String

func (x *Engine_ChatEngineConfig) String() string

type Engine_ChatEngineConfig_

type Engine_ChatEngineConfig_ struct {
	// Configurations for the Chat Engine. Only applicable if
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
	ChatEngineConfig *Engine_ChatEngineConfig `protobuf:"bytes,11,opt,name=chat_engine_config,json=chatEngineConfig,proto3,oneof"`
}

type Engine_ChatEngineConfig_AgentCreationConfig

type Engine_ChatEngineConfig_AgentCreationConfig struct {

	// Name of the company, organization or other entity that the agent
	// represents. Used for knowledge connector LLM prompt and for knowledge
	// search.
	Business string `protobuf:"bytes,1,opt,name=business,proto3" json:"business,omitempty"`
	// Required. The default language of the agent as a language tag.
	// See [Language
	// Support](https://cloud.google.com/dialogflow/docs/reference/language)
	// for a list of the currently supported language codes.
	DefaultLanguageCode string `protobuf:"bytes,2,opt,name=default_language_code,json=defaultLanguageCode,proto3" json:"default_language_code,omitempty"`
	// Required. The time zone of the agent from the [time zone
	// database](https://www.iana.org/time-zones), e.g., America/New_York,
	// Europe/Paris.
	TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// Agent location for Agent creation, supported values: global/us/eu.
	// If not provided, us Engine will create Agent using us-central-1 by
	// default; eu Engine will create Agent using eu-west-1 by default.
	Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] API after engine creation.

func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor deprecated

Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation added in v1.6.0

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect

func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset

func (*Engine_ChatEngineConfig_AgentCreationConfig) String

type Engine_ChatEngineMetadata

type Engine_ChatEngineMetadata struct {

	// The resource name of a Dialogflow agent, that this Chat Engine refers
	// to.
	//
	// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
	// ID>`.
	DialogflowAgent string `protobuf:"bytes,1,opt,name=dialogflow_agent,json=dialogflowAgent,proto3" json:"dialogflow_agent,omitempty"`
	// contains filtered or unexported fields
}

Additional information of a Chat Engine. Fields in this message are output only.

func (*Engine_ChatEngineMetadata) Descriptor deprecated

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

Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineMetadata) GetDialogflowAgent

func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() string

func (*Engine_ChatEngineMetadata) ProtoMessage

func (*Engine_ChatEngineMetadata) ProtoMessage()

func (*Engine_ChatEngineMetadata) ProtoReflect

func (*Engine_ChatEngineMetadata) Reset

func (x *Engine_ChatEngineMetadata) Reset()

func (*Engine_ChatEngineMetadata) String

func (x *Engine_ChatEngineMetadata) String() string

type Engine_ChatEngineMetadata_

type Engine_ChatEngineMetadata_ struct {
	// Output only. Additional information of the Chat Engine. Only applicable
	// if
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
	ChatEngineMetadata *Engine_ChatEngineMetadata `protobuf:"bytes,12,opt,name=chat_engine_metadata,json=chatEngineMetadata,proto3,oneof"`
}

type Engine_CommonConfig

type Engine_CommonConfig struct {

	// Immutable. The name of the company, business or entity that is associated
	// with the engine. Setting this may help improve LLM related features.
	CompanyName string `protobuf:"bytes,1,opt,name=company_name,json=companyName,proto3" json:"company_name,omitempty"`
	// contains filtered or unexported fields
}

Common configurations for an Engine.

func (*Engine_CommonConfig) Descriptor deprecated

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

Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.

func (*Engine_CommonConfig) GetCompanyName

func (x *Engine_CommonConfig) GetCompanyName() string

func (*Engine_CommonConfig) ProtoMessage

func (*Engine_CommonConfig) ProtoMessage()

func (*Engine_CommonConfig) ProtoReflect

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

func (*Engine_CommonConfig) Reset

func (x *Engine_CommonConfig) Reset()

func (*Engine_CommonConfig) String

func (x *Engine_CommonConfig) String() string

type Engine_MediaRecommendationEngineConfig

type Engine_MediaRecommendationEngineConfig struct {

	// Required. The type of engine. e.g., `recommended-for-you`.
	//
	// This field together with
	// [optimization_objective][Engine.optimization_objective] describe engine
	// metadata to use to control engine training and serving.
	//
	// Currently supported values: `recommended-for-you`, `others-you-may-like`,
	// `more-like-this`, `most-popular-items`.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// The optimization objective. e.g., `cvr`.
	//
	// This field together with
	// [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
	// describe engine metadata to use to control engine training and serving.
	//
	// Currently supported
	// values: `ctr`, `cvr`.
	//
	//	If not specified, we choose default based on engine type.
	//
	// Default depends on type of recommendation:
	//
	// `recommended-for-you` => `ctr`
	//
	// `others-you-may-like` => `ctr`
	OptimizationObjective string `protobuf:"bytes,2,opt,name=optimization_objective,json=optimizationObjective,proto3" json:"optimization_objective,omitempty"`
	// Name and value of the custom threshold for cvr optimization_objective.
	// For target_field `watch-time`, target_field_value must be an integer
	// value indicating the media progress time in seconds between (0, 86400]
	// (excludes 0, includes 86400) (e.g., 90).
	// For target_field `watch-percentage`, the target_field_value must be a
	// valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
	// 0.5).
	OptimizationObjectiveConfig *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig `` /* 144-byte string literal not displayed */
	// The training state that the engine is in (e.g.
	// `TRAINING` or `PAUSED`).
	//
	// Since part of the cost of running the service
	// is frequency of training - this can be used to determine when to train
	// engine in order to control cost. If not specified: the default value for
	// `CreateEngine` method is `TRAINING`. The default value for
	// `UpdateEngine` method is to keep the state the same as before.
	TrainingState Engine_MediaRecommendationEngineConfig_TrainingState `` /* 196-byte string literal not displayed */
	// contains filtered or unexported fields
}

Additional config specs for a Media Recommendation engine.

func (*Engine_MediaRecommendationEngineConfig) Descriptor deprecated

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

Deprecated: Use Engine_MediaRecommendationEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjective

func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjective() string

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig

func (*Engine_MediaRecommendationEngineConfig) GetTrainingState

func (*Engine_MediaRecommendationEngineConfig) GetType

func (*Engine_MediaRecommendationEngineConfig) ProtoMessage

func (*Engine_MediaRecommendationEngineConfig) ProtoReflect

func (*Engine_MediaRecommendationEngineConfig) Reset

func (*Engine_MediaRecommendationEngineConfig) String

type Engine_MediaRecommendationEngineConfig_

type Engine_MediaRecommendationEngineConfig_ struct {
	// Configurations for the Media Engine. Only applicable on the data
	// stores with
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
	// and
	// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
	// vertical.
	MediaRecommendationEngineConfig *Engine_MediaRecommendationEngineConfig `protobuf:"bytes,14,opt,name=media_recommendation_engine_config,json=mediaRecommendationEngineConfig,proto3,oneof"`
}

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig struct {

	// Required. The name of the field to target. Currently supported
	// values: `watch-percentage`, `watch-time`.
	TargetField string `protobuf:"bytes,1,opt,name=target_field,json=targetField,proto3" json:"target_field,omitempty"`
	// Required. The threshold to be applied to the target (e.g., 0.5).
	TargetFieldValueFloat float32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Custom threshold for `cvr` optimization_objective.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor deprecated

Deprecated: Use Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String

type Engine_MediaRecommendationEngineConfig_TrainingState

type Engine_MediaRecommendationEngineConfig_TrainingState int32

The training state of the engine.

const (
	// Unspecified training state.
	Engine_MediaRecommendationEngineConfig_TRAINING_STATE_UNSPECIFIED Engine_MediaRecommendationEngineConfig_TrainingState = 0
	// The engine training is paused.
	Engine_MediaRecommendationEngineConfig_PAUSED Engine_MediaRecommendationEngineConfig_TrainingState = 1
	// The engine is training.
	Engine_MediaRecommendationEngineConfig_TRAINING Engine_MediaRecommendationEngineConfig_TrainingState = 2
)

func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor

func (Engine_MediaRecommendationEngineConfig_TrainingState) Enum

func (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor deprecated

Deprecated: Use Engine_MediaRecommendationEngineConfig_TrainingState.Descriptor instead.

func (Engine_MediaRecommendationEngineConfig_TrainingState) Number

func (Engine_MediaRecommendationEngineConfig_TrainingState) String

func (Engine_MediaRecommendationEngineConfig_TrainingState) Type

type Engine_RecommendationMetadata

type Engine_RecommendationMetadata struct {

	// Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
	ServingState Engine_RecommendationMetadata_ServingState `` /* 183-byte string literal not displayed */
	// Output only. The state of data requirements for this engine: `DATA_OK`
	// and `DATA_ERROR`.
	//
	// Engine cannot be trained if the data is in
	// `DATA_ERROR` state. Engine can have `DATA_ERROR` state even
	// if serving state is `ACTIVE`: engines were trained successfully before,
	// but cannot be refreshed because the underlying engine no longer has
	// sufficient data for training.
	DataState Engine_RecommendationMetadata_DataState `` /* 171-byte string literal not displayed */
	// Output only. The timestamp when the latest successful tune finished. Only
	// applicable on Media Recommendation engines.
	LastTuneTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_tune_time,json=lastTuneTime,proto3" json:"last_tune_time,omitempty"`
	// Output only. The latest tune operation id associated with the engine.
	// Only applicable on Media Recommendation engines.
	//
	// If present, this operation id can be used to determine if there is an
	// ongoing tune for this engine. To check the operation status, send the
	// GetOperation request with this operation id in the engine resource
	// format. If no tuning has happened for this engine, the string is empty.
	TuningOperation string `protobuf:"bytes,4,opt,name=tuning_operation,json=tuningOperation,proto3" json:"tuning_operation,omitempty"`
	// contains filtered or unexported fields
}

Additional information of a recommendation engine.

func (*Engine_RecommendationMetadata) Descriptor deprecated

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

Deprecated: Use Engine_RecommendationMetadata.ProtoReflect.Descriptor instead.

func (*Engine_RecommendationMetadata) GetDataState

func (*Engine_RecommendationMetadata) GetLastTuneTime

func (x *Engine_RecommendationMetadata) GetLastTuneTime() *timestamppb.Timestamp

func (*Engine_RecommendationMetadata) GetServingState

func (*Engine_RecommendationMetadata) GetTuningOperation

func (x *Engine_RecommendationMetadata) GetTuningOperation() string

func (*Engine_RecommendationMetadata) ProtoMessage

func (*Engine_RecommendationMetadata) ProtoMessage()

func (*Engine_RecommendationMetadata) ProtoReflect

func (*Engine_RecommendationMetadata) Reset

func (x *Engine_RecommendationMetadata) Reset()

func (*Engine_RecommendationMetadata) String

type Engine_RecommendationMetadata_

type Engine_RecommendationMetadata_ struct {
	// Output only. Additional information of a recommendation engine. Only
	// applicable if
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	RecommendationMetadata *Engine_RecommendationMetadata `protobuf:"bytes,10,opt,name=recommendation_metadata,json=recommendationMetadata,proto3,oneof"`
}

type Engine_RecommendationMetadata_DataState

type Engine_RecommendationMetadata_DataState int32

Describes whether this engine have sufficient training data to be continuously trained.

const (
	// Unspecified default value, should never be explicitly set.
	Engine_RecommendationMetadata_DATA_STATE_UNSPECIFIED Engine_RecommendationMetadata_DataState = 0
	// The engine has sufficient training data.
	Engine_RecommendationMetadata_DATA_OK Engine_RecommendationMetadata_DataState = 1
	// The engine does not have sufficient training data. Error
	// messages can be queried via Stackdriver.
	Engine_RecommendationMetadata_DATA_ERROR Engine_RecommendationMetadata_DataState = 2
)

func (Engine_RecommendationMetadata_DataState) Descriptor

func (Engine_RecommendationMetadata_DataState) Enum

func (Engine_RecommendationMetadata_DataState) EnumDescriptor deprecated

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

Deprecated: Use Engine_RecommendationMetadata_DataState.Descriptor instead.

func (Engine_RecommendationMetadata_DataState) Number

func (Engine_RecommendationMetadata_DataState) String

func (Engine_RecommendationMetadata_DataState) Type

type Engine_RecommendationMetadata_ServingState

type Engine_RecommendationMetadata_ServingState int32

The serving state of the recommendation engine.

const (
	// Unspecified serving state.
	Engine_RecommendationMetadata_SERVING_STATE_UNSPECIFIED Engine_RecommendationMetadata_ServingState = 0
	// The engine is not serving.
	Engine_RecommendationMetadata_INACTIVE Engine_RecommendationMetadata_ServingState = 1
	// The engine is serving and can be queried.
	Engine_RecommendationMetadata_ACTIVE Engine_RecommendationMetadata_ServingState = 2
	// The engine is trained on tuned hyperparameters and can be
	// queried.
	Engine_RecommendationMetadata_TUNED Engine_RecommendationMetadata_ServingState = 3
)

func (Engine_RecommendationMetadata_ServingState) Descriptor

func (Engine_RecommendationMetadata_ServingState) Enum

func (Engine_RecommendationMetadata_ServingState) EnumDescriptor deprecated

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

Deprecated: Use Engine_RecommendationMetadata_ServingState.Descriptor instead.

func (Engine_RecommendationMetadata_ServingState) Number

func (Engine_RecommendationMetadata_ServingState) String

func (Engine_RecommendationMetadata_ServingState) Type

type Engine_SearchEngineConfig

type Engine_SearchEngineConfig struct {

	// The search feature tier of this engine.
	//
	// Different tiers might have different
	// pricing. To learn more, please check the pricing documentation.
	//
	// Defaults to
	// [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1alpha.SearchTier.SEARCH_TIER_STANDARD]
	// if not specified.
	SearchTier SearchTier `` /* 145-byte string literal not displayed */
	// The add-on that this search engine enables.
	SearchAddOns []SearchAddOn `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configurations for a Search Engine.

func (*Engine_SearchEngineConfig) Descriptor deprecated

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

Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SearchEngineConfig) GetSearchAddOns

func (x *Engine_SearchEngineConfig) GetSearchAddOns() []SearchAddOn

func (*Engine_SearchEngineConfig) GetSearchTier

func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTier

func (*Engine_SearchEngineConfig) ProtoMessage

func (*Engine_SearchEngineConfig) ProtoMessage()

func (*Engine_SearchEngineConfig) ProtoReflect

func (*Engine_SearchEngineConfig) Reset

func (x *Engine_SearchEngineConfig) Reset()

func (*Engine_SearchEngineConfig) String

func (x *Engine_SearchEngineConfig) String() string

type Engine_SearchEngineConfig_

type Engine_SearchEngineConfig_ struct {
	// Configurations for the Search Engine. Only applicable if
	// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	SearchEngineConfig *Engine_SearchEngineConfig `protobuf:"bytes,13,opt,name=search_engine_config,json=searchEngineConfig,proto3,oneof"`
}

type Engine_SimilarDocumentsConfig

type Engine_SimilarDocumentsConfig struct {
	// Additional config specs for a `similar-items` engine.
	SimilarDocumentsConfig *Engine_SimilarDocumentsEngineConfig `protobuf:"bytes,9,opt,name=similar_documents_config,json=similarDocumentsConfig,proto3,oneof"`
}

type Engine_SimilarDocumentsEngineConfig

type Engine_SimilarDocumentsEngineConfig struct {
	// contains filtered or unexported fields
}

Additional config specs for a `similar-items` engine.

func (*Engine_SimilarDocumentsEngineConfig) Descriptor deprecated

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

Deprecated: Use Engine_SimilarDocumentsEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage

func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage()

func (*Engine_SimilarDocumentsEngineConfig) ProtoReflect

func (*Engine_SimilarDocumentsEngineConfig) Reset

func (*Engine_SimilarDocumentsEngineConfig) String

type EstimateBillingServiceClient added in v1.6.0

type EstimateBillingServiceClient interface {
	// Estimates the data size to be used by a customer.
	EstimateDataSize(ctx context.Context, in *EstimateDataSizeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

EstimateBillingServiceClient is the client API for EstimateBillingService service.

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

func NewEstimateBillingServiceClient added in v1.6.0

func NewEstimateBillingServiceClient(cc grpc.ClientConnInterface) EstimateBillingServiceClient

type EstimateBillingServiceServer added in v1.6.0

type EstimateBillingServiceServer interface {
	// Estimates the data size to be used by a customer.
	EstimateDataSize(context.Context, *EstimateDataSizeRequest) (*longrunningpb.Operation, error)
}

EstimateBillingServiceServer is the server API for EstimateBillingService service.

type EstimateDataSizeMetadata added in v1.6.0

type EstimateDataSizeMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.

func (*EstimateDataSizeMetadata) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EstimateDataSizeMetadata.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeMetadata) GetCreateTime added in v1.6.0

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

func (*EstimateDataSizeMetadata) ProtoMessage added in v1.6.0

func (*EstimateDataSizeMetadata) ProtoMessage()

func (*EstimateDataSizeMetadata) ProtoReflect added in v1.6.0

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

func (*EstimateDataSizeMetadata) Reset added in v1.6.0

func (x *EstimateDataSizeMetadata) Reset()

func (*EstimateDataSizeMetadata) String added in v1.6.0

func (x *EstimateDataSizeMetadata) String() string

type EstimateDataSizeRequest added in v1.6.0

type EstimateDataSizeRequest struct {

	// Data source for which we are estimating its size.
	//
	// Types that are assignable to DataSource:
	//
	//	*EstimateDataSizeRequest_WebsiteDataSource_
	//	*EstimateDataSizeRequest_FileDataSource_
	DataSource isEstimateDataSizeRequest_DataSource `protobuf_oneof:"data_source"`
	// Required. Full resource name of the location, such as
	// `projects/{project}/locations/{location}`.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] method

func (*EstimateDataSizeRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EstimateDataSizeRequest.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest) GetDataSource added in v1.6.0

func (m *EstimateDataSizeRequest) GetDataSource() isEstimateDataSizeRequest_DataSource

func (*EstimateDataSizeRequest) GetFileDataSource added in v1.6.0

func (*EstimateDataSizeRequest) GetLocation added in v1.6.0

func (x *EstimateDataSizeRequest) GetLocation() string

func (*EstimateDataSizeRequest) GetWebsiteDataSource added in v1.6.0

func (*EstimateDataSizeRequest) ProtoMessage added in v1.6.0

func (*EstimateDataSizeRequest) ProtoMessage()

func (*EstimateDataSizeRequest) ProtoReflect added in v1.6.0

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

func (*EstimateDataSizeRequest) Reset added in v1.6.0

func (x *EstimateDataSizeRequest) Reset()

func (*EstimateDataSizeRequest) String added in v1.6.0

func (x *EstimateDataSizeRequest) String() string

type EstimateDataSizeRequest_FileDataSource added in v1.6.0

type EstimateDataSizeRequest_FileDataSource struct {

	// Which source contains the files to be used.
	//
	// Types that are assignable to Source:
	//
	//	*EstimateDataSizeRequest_FileDataSource_GcsSource
	//	*EstimateDataSizeRequest_FileDataSource_BigquerySource
	Source isEstimateDataSizeRequest_FileDataSource_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

Data source contains files either in Cloud Storage or BigQuery.

func (*EstimateDataSizeRequest_FileDataSource) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EstimateDataSizeRequest_FileDataSource.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_FileDataSource) GetBigquerySource added in v1.6.0

func (*EstimateDataSizeRequest_FileDataSource) GetGcsSource added in v1.6.0

func (*EstimateDataSizeRequest_FileDataSource) GetSource added in v1.6.0

func (m *EstimateDataSizeRequest_FileDataSource) GetSource() isEstimateDataSizeRequest_FileDataSource_Source

func (*EstimateDataSizeRequest_FileDataSource) ProtoMessage added in v1.6.0

func (*EstimateDataSizeRequest_FileDataSource) ProtoReflect added in v1.6.0

func (*EstimateDataSizeRequest_FileDataSource) Reset added in v1.6.0

func (*EstimateDataSizeRequest_FileDataSource) String added in v1.6.0

type EstimateDataSizeRequest_FileDataSource_ added in v1.6.0

type EstimateDataSizeRequest_FileDataSource_ struct {
	// Structured or unstructured data.
	FileDataSource *EstimateDataSizeRequest_FileDataSource `protobuf:"bytes,3,opt,name=file_data_source,json=fileDataSource,proto3,oneof"`
}

type EstimateDataSizeRequest_FileDataSource_BigquerySource added in v1.6.0

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

type EstimateDataSizeRequest_FileDataSource_GcsSource added in v1.6.0

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

type EstimateDataSizeRequest_WebsiteDataSource added in v1.6.0

type EstimateDataSizeRequest_WebsiteDataSource struct {

	// Required. The URI patterns to estimate the data sizes. At most 10
	// patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
	EstimatorUriPatterns []*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern `protobuf:"bytes,1,rep,name=estimator_uri_patterns,json=estimatorUriPatterns,proto3" json:"estimator_uri_patterns,omitempty"`
	// contains filtered or unexported fields
}

Data source is a set of website patterns that we crawl to get the total number of websites.

func (*EstimateDataSizeRequest_WebsiteDataSource) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_WebsiteDataSource) GetEstimatorUriPatterns added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoMessage added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoReflect added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource) Reset added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource) String added in v1.6.0

type EstimateDataSizeRequest_WebsiteDataSource_ added in v1.6.0

type EstimateDataSizeRequest_WebsiteDataSource_ struct {
	// Website data.
	WebsiteDataSource *EstimateDataSizeRequest_WebsiteDataSource `protobuf:"bytes,2,opt,name=website_data_source,json=websiteDataSource,proto3,oneof"`
}

type EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern added in v1.6.0

type EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern struct {

	// User provided URI pattern. For example, `foo.com/bar/*`.
	ProvidedUriPattern string `protobuf:"bytes,1,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
	// Whether we infer the generated URI or use the exact provided one.
	ExactMatch bool `protobuf:"varint,2,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
	// Whether the pattern is exclusive or not. If set to true, the pattern is
	// considered exclusive. If unset or set to false, the pattern is
	// considered inclusive by default.
	Exclusive bool `protobuf:"varint,3,opt,name=exclusive,proto3" json:"exclusive,omitempty"`
	// contains filtered or unexported fields
}

URI patterns that we use to crawl.

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Descriptor deprecated added in v1.6.0

Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExactMatch added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExclusive added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetProvidedUriPattern added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoMessage added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoReflect added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Reset added in v1.6.0

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) String added in v1.6.0

type EstimateDataSizeResponse added in v1.6.0

type EstimateDataSizeResponse struct {

	// Data size in terms of bytes.
	DataSizeBytes int64 `protobuf:"varint,1,opt,name=data_size_bytes,json=dataSizeBytes,proto3" json:"data_size_bytes,omitempty"`
	// Total number of documents.
	DocumentCount int64 `protobuf:"varint,2,opt,name=document_count,json=documentCount,proto3" json:"document_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the EstimateDataSize request. 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 (*EstimateDataSizeResponse) Descriptor deprecated added in v1.6.0

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

Deprecated: Use EstimateDataSizeResponse.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeResponse) GetDataSizeBytes added in v1.6.0

func (x *EstimateDataSizeResponse) GetDataSizeBytes() int64

func (*EstimateDataSizeResponse) GetDocumentCount added in v1.6.0

func (x *EstimateDataSizeResponse) GetDocumentCount() int64

func (*EstimateDataSizeResponse) ProtoMessage added in v1.6.0

func (*EstimateDataSizeResponse) ProtoMessage()

func (*EstimateDataSizeResponse) ProtoReflect added in v1.6.0

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

func (*EstimateDataSizeResponse) Reset added in v1.6.0

func (x *EstimateDataSizeResponse) Reset()

func (*EstimateDataSizeResponse) String added in v1.6.0

func (x *EstimateDataSizeResponse) String() string

type FetchDomainVerificationStatusRequest added in v1.4.0

type FetchDomainVerificationStatusRequest struct {

	// Required. The site search engine resource under which we fetch all the
	// domain verification status.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// Requested page size. Server may return fewer items than requested. If
	// unspecified, server will pick an appropriate default. The maximum 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, received from a previous `FetchDomainVerificationStatus`
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `FetchDomainVerificationStatus` 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 [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusRequest) GetPageSize added in v1.4.0

func (*FetchDomainVerificationStatusRequest) GetPageToken added in v1.4.0

func (x *FetchDomainVerificationStatusRequest) GetPageToken() string

func (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine added in v1.4.0

func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() string

func (*FetchDomainVerificationStatusRequest) ProtoMessage added in v1.4.0

func (*FetchDomainVerificationStatusRequest) ProtoMessage()

func (*FetchDomainVerificationStatusRequest) ProtoReflect added in v1.4.0

func (*FetchDomainVerificationStatusRequest) Reset added in v1.4.0

func (*FetchDomainVerificationStatusRequest) String added in v1.4.0

type FetchDomainVerificationStatusResponse added in v1.4.0

type FetchDomainVerificationStatusResponse struct {

	// List of TargetSites containing the site verification status.
	TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
	// A token that can be sent as `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"`
	// The total number of items matching the request.
	// This will always be populated in the response.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusResponse) GetNextPageToken added in v1.4.0

func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() string

func (*FetchDomainVerificationStatusResponse) GetTargetSites added in v1.4.0

func (x *FetchDomainVerificationStatusResponse) GetTargetSites() []*TargetSite

func (*FetchDomainVerificationStatusResponse) GetTotalSize added in v1.4.0

func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32

func (*FetchDomainVerificationStatusResponse) ProtoMessage added in v1.4.0

func (*FetchDomainVerificationStatusResponse) ProtoMessage()

func (*FetchDomainVerificationStatusResponse) ProtoReflect added in v1.4.0

func (*FetchDomainVerificationStatusResponse) Reset added in v1.4.0

func (*FetchDomainVerificationStatusResponse) String added in v1.4.0

type FieldConfig

type FieldConfig struct {

	// Required. Field path of the schema field.
	// For example: `title`, `description`, `release_info.release_year`.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
	// Output only. Raw type of the field.
	FieldType FieldConfig_FieldType `` /* 153-byte string literal not displayed */
	// If
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is
	// [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
	// field values are indexed so that it can be filtered or faceted in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
	//
	// If
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is unset, the server behavior defaults to
	// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
	// for fields that support setting indexable options. For those fields that do
	// not support setting indexable options, such as `object` and `boolean` and
	// key properties, the server will skip
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// setting, and setting
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	IndexableOption FieldConfig_IndexableOption `` /* 177-byte string literal not displayed */
	// If
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// is
	// [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
	// field values are available for dynamic facet. Could only be
	// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
	// if
	// [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is
	// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
	// Otherwise, an `INVALID_ARGUMENT` error will be returned.
	//
	// If
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// is unset, the server behavior defaults to
	// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
	// for fields that support setting dynamic facetable options. For those fields
	// that do not support setting dynamic facetable options, such as `object` and
	// `boolean`, the server will skip dynamic facetable option setting, and
	// setting
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	DynamicFacetableOption FieldConfig_DynamicFacetableOption `` /* 207-byte string literal not displayed */
	// If
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// is
	// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
	// field values are searchable by text queries in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
	//
	// If
	// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
	// but field type is numerical, field values will not be searchable by text
	// queries in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
	// as there are no text values associated to numerical fields.
	//
	// If
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// is unset, the server behavior defaults to
	// [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
	// for fields that support setting searchable options. Only `string` fields
	// that have no key property mapping support setting
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].
	//
	// For those fields that do not support setting searchable options, the server
	// will skip searchable option setting, and setting
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	SearchableOption FieldConfig_SearchableOption `` /* 181-byte string literal not displayed */
	// If
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// is
	// [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
	// field values are included in the search results.
	//
	// If
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// is unset, the server behavior defaults to
	// [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
	// for fields that support setting retrievable options. For those fields
	// that do not support setting retrievable options, such as `object` and
	// `boolean`, the server will skip retrievable option setting, and setting
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	RetrievableOption FieldConfig_RetrievableOption `` /* 185-byte string literal not displayed */
	// If
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// is
	// [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
	// field values are directly used and returned as suggestions for Autocomplete
	// in
	// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
	//
	// If
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// is unset, the server behavior defaults to
	// [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
	// for fields that support setting completable options, which are just
	// `string` fields. For those fields that do not support setting completable
	// options, the server will skip completable option setting, and setting
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	CompletableOption FieldConfig_CompletableOption `` /* 185-byte string literal not displayed */
	// If
	// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
	// is
	// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
	// field values are filterable by filter expression in
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
	//
	// If
	// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
	// but the field type is numerical, field values are not filterable by text
	// queries in
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
	// Only textual fields are supported.
	//
	// If
	// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
	// is unset, the default setting is
	// [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
	// for fields that support setting filterable options.
	//
	// When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
	// generated and an empty result is returned.
	RecsFilterableOption FieldConfig_FilterableOption `` /* 195-byte string literal not displayed */
	// Output only. Type of the key property that this field is mapped to. Empty
	// string if this is not annotated as mapped to a key property.
	//
	// Example types are `title`, `description`. Full list is defined
	// by `keyPropertyMapping` in the schema field annotation.
	//
	// If the schema field has a `KeyPropertyMapping` annotation,
	// `indexable_option` and `searchable_option` of this field cannot be
	// modified.
	KeyPropertyType string `protobuf:"bytes,7,opt,name=key_property_type,json=keyPropertyType,proto3" json:"key_property_type,omitempty"`
	// contains filtered or unexported fields
}

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

func (*FieldConfig) Descriptor deprecated

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

Deprecated: Use FieldConfig.ProtoReflect.Descriptor instead.

func (*FieldConfig) GetCompletableOption

func (x *FieldConfig) GetCompletableOption() FieldConfig_CompletableOption

func (*FieldConfig) GetDynamicFacetableOption

func (x *FieldConfig) GetDynamicFacetableOption() FieldConfig_DynamicFacetableOption

func (*FieldConfig) GetFieldPath

func (x *FieldConfig) GetFieldPath() string

func (*FieldConfig) GetFieldType

func (x *FieldConfig) GetFieldType() FieldConfig_FieldType

func (*FieldConfig) GetIndexableOption

func (x *FieldConfig) GetIndexableOption() FieldConfig_IndexableOption

func (*FieldConfig) GetKeyPropertyType

func (x *FieldConfig) GetKeyPropertyType() string

func (*FieldConfig) GetRecsFilterableOption

func (x *FieldConfig) GetRecsFilterableOption() FieldConfig_FilterableOption

func (*FieldConfig) GetRetrievableOption

func (x *FieldConfig) GetRetrievableOption() FieldConfig_RetrievableOption

func (*FieldConfig) GetSearchableOption

func (x *FieldConfig) GetSearchableOption() FieldConfig_SearchableOption

func (*FieldConfig) ProtoMessage

func (*FieldConfig) ProtoMessage()

func (*FieldConfig) ProtoReflect

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

func (*FieldConfig) Reset

func (x *FieldConfig) Reset()

func (*FieldConfig) String

func (x *FieldConfig) String() string

type FieldConfig_CompletableOption

type FieldConfig_CompletableOption int32

The setting of Completable options in schema.

const (
	// Value used when unset.
	FieldConfig_COMPLETABLE_OPTION_UNSPECIFIED FieldConfig_CompletableOption = 0
	// Completable option enabled for a schema field.
	FieldConfig_COMPLETABLE_ENABLED FieldConfig_CompletableOption = 1
	// Completable option disabled for a schema field.
	FieldConfig_COMPLETABLE_DISABLED FieldConfig_CompletableOption = 2
)

func (FieldConfig_CompletableOption) Descriptor

func (FieldConfig_CompletableOption) Enum

func (FieldConfig_CompletableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_CompletableOption.Descriptor instead.

func (FieldConfig_CompletableOption) Number

func (FieldConfig_CompletableOption) String

func (FieldConfig_CompletableOption) Type

type FieldConfig_DynamicFacetableOption

type FieldConfig_DynamicFacetableOption int32

The status of the dynamic facetable option of a schema field.

const (
	// Value used when unset.
	FieldConfig_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED FieldConfig_DynamicFacetableOption = 0
	// Dynamic facetable option enabled for a schema field.
	FieldConfig_DYNAMIC_FACETABLE_ENABLED FieldConfig_DynamicFacetableOption = 1
	// Dynamic facetable option disabled for a schema field.
	FieldConfig_DYNAMIC_FACETABLE_DISABLED FieldConfig_DynamicFacetableOption = 2
)

func (FieldConfig_DynamicFacetableOption) Descriptor

func (FieldConfig_DynamicFacetableOption) Enum

func (FieldConfig_DynamicFacetableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_DynamicFacetableOption.Descriptor instead.

func (FieldConfig_DynamicFacetableOption) Number

func (FieldConfig_DynamicFacetableOption) String

func (FieldConfig_DynamicFacetableOption) Type

type FieldConfig_FieldType

type FieldConfig_FieldType int32

Field value type in the Schema.

const (
	// Field type is unspecified.
	FieldConfig_FIELD_TYPE_UNSPECIFIED FieldConfig_FieldType = 0
	// Field value type is Object.
	FieldConfig_OBJECT FieldConfig_FieldType = 1
	// Field value type is String.
	FieldConfig_STRING FieldConfig_FieldType = 2
	// Field value type is Number.
	FieldConfig_NUMBER FieldConfig_FieldType = 3
	// Field value type is Integer.
	FieldConfig_INTEGER FieldConfig_FieldType = 4
	// Field value type is Boolean.
	FieldConfig_BOOLEAN FieldConfig_FieldType = 5
	// Field value type is Geolocation.
	FieldConfig_GEOLOCATION FieldConfig_FieldType = 6
	// Field value type is Datetime.
	FieldConfig_DATETIME FieldConfig_FieldType = 7
)

func (FieldConfig_FieldType) Descriptor

func (FieldConfig_FieldType) Enum

func (FieldConfig_FieldType) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_FieldType.Descriptor instead.

func (FieldConfig_FieldType) Number

func (FieldConfig_FieldType) String

func (x FieldConfig_FieldType) String() string

func (FieldConfig_FieldType) Type

type FieldConfig_FilterableOption

type FieldConfig_FilterableOption int32

Sets the filterable option for schema fields.

const (
	// Value used when unset.
	FieldConfig_FILTERABLE_OPTION_UNSPECIFIED FieldConfig_FilterableOption = 0
	// Filterable option enabled for a schema field.
	FieldConfig_FILTERABLE_ENABLED FieldConfig_FilterableOption = 1
	// Filterable option disabled for a schema field.
	FieldConfig_FILTERABLE_DISABLED FieldConfig_FilterableOption = 2
)

func (FieldConfig_FilterableOption) Descriptor

func (FieldConfig_FilterableOption) Enum

func (FieldConfig_FilterableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_FilterableOption.Descriptor instead.

func (FieldConfig_FilterableOption) Number

func (FieldConfig_FilterableOption) String

func (FieldConfig_FilterableOption) Type

type FieldConfig_IndexableOption

type FieldConfig_IndexableOption int32

The setting of Indexable options in schema.

const (
	// Value used when unset.
	FieldConfig_INDEXABLE_OPTION_UNSPECIFIED FieldConfig_IndexableOption = 0
	// Indexable option enabled for a schema field.
	FieldConfig_INDEXABLE_ENABLED FieldConfig_IndexableOption = 1
	// Indexable option disabled for a schema field.
	FieldConfig_INDEXABLE_DISABLED FieldConfig_IndexableOption = 2
)

func (FieldConfig_IndexableOption) Descriptor

func (FieldConfig_IndexableOption) Enum

func (FieldConfig_IndexableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_IndexableOption.Descriptor instead.

func (FieldConfig_IndexableOption) Number

func (FieldConfig_IndexableOption) String

func (FieldConfig_IndexableOption) Type

type FieldConfig_RetrievableOption

type FieldConfig_RetrievableOption int32

The setting of Retrievable options in schema.

const (
	// Value used when unset.
	FieldConfig_RETRIEVABLE_OPTION_UNSPECIFIED FieldConfig_RetrievableOption = 0
	// Retrievable option enabled for a schema field.
	FieldConfig_RETRIEVABLE_ENABLED FieldConfig_RetrievableOption = 1
	// Retrievable option disabled for a schema field.
	FieldConfig_RETRIEVABLE_DISABLED FieldConfig_RetrievableOption = 2
)

func (FieldConfig_RetrievableOption) Descriptor

func (FieldConfig_RetrievableOption) Enum

func (FieldConfig_RetrievableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_RetrievableOption.Descriptor instead.

func (FieldConfig_RetrievableOption) Number

func (FieldConfig_RetrievableOption) String

func (FieldConfig_RetrievableOption) Type

type FieldConfig_SearchableOption

type FieldConfig_SearchableOption int32

The setting of Searchable options in schema.

const (
	// Value used when unset.
	FieldConfig_SEARCHABLE_OPTION_UNSPECIFIED FieldConfig_SearchableOption = 0
	// Searchable option enabled for a schema field.
	FieldConfig_SEARCHABLE_ENABLED FieldConfig_SearchableOption = 1
	// Searchable option disabled for a schema field.
	FieldConfig_SEARCHABLE_DISABLED FieldConfig_SearchableOption = 2
)

func (FieldConfig_SearchableOption) Descriptor

func (FieldConfig_SearchableOption) Enum

func (FieldConfig_SearchableOption) EnumDescriptor deprecated

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

Deprecated: Use FieldConfig_SearchableOption.Descriptor instead.

func (FieldConfig_SearchableOption) Number

func (FieldConfig_SearchableOption) String

func (FieldConfig_SearchableOption) Type

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.v1alpha.Document] per line. Each
	// document must
	//
	//	have a valid
	//	[Document.id][google.cloud.discoveryengine.v1alpha.Document.id].
	//   - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
	//     `input_uris` becomes 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
	//     to the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of
	//     the data store. This can only be used by Gen App Builder.
	//   - `csv`: A CSV file with header conforming to the defined
	//
	// [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
	//
	//	data store. Each entry after the header is imported as a Document.
	//	This can only be used by Gen App Builder.
	//
	// Supported values for user even imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.discoveryengine.v1alpha.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 GetAclConfigRequest added in v1.6.0

type GetAclConfigRequest struct {

	// Required. Resource name of
	// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
	// `projects/*/locations/*/aclConfig`.
	//
	// If the caller does not have permission to access the
	// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetAclConfigRequest method.

func (*GetAclConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use GetAclConfigRequest.ProtoReflect.Descriptor instead.

func (*GetAclConfigRequest) GetName added in v1.6.0

func (x *GetAclConfigRequest) GetName() string

func (*GetAclConfigRequest) ProtoMessage added in v1.6.0

func (*GetAclConfigRequest) ProtoMessage()

func (*GetAclConfigRequest) ProtoReflect added in v1.6.0

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

func (*GetAclConfigRequest) Reset added in v1.6.0

func (x *GetAclConfigRequest) Reset()

func (*GetAclConfigRequest) String added in v1.6.0

func (x *GetAclConfigRequest) String() string

type GetChunkRequest added in v1.6.0

type GetChunkRequest struct {

	// Required. Full resource name of
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.
	//
	// If the caller does not have permission to access the
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether
	// or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] 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 [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] method.

func (*GetChunkRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use GetChunkRequest.ProtoReflect.Descriptor instead.

func (*GetChunkRequest) GetName added in v1.6.0

func (x *GetChunkRequest) GetName() string

func (*GetChunkRequest) ProtoMessage added in v1.6.0

func (*GetChunkRequest) ProtoMessage()

func (*GetChunkRequest) ProtoReflect added in v1.6.0

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

func (*GetChunkRequest) Reset added in v1.6.0

func (x *GetChunkRequest) Reset()

func (*GetChunkRequest) String added in v1.6.0

func (x *GetChunkRequest) String() string

type GetConversationRequest

type GetConversationRequest struct {

	// Required. The resource name of the Conversation to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetConversation method.

func (*GetConversationRequest) Descriptor deprecated

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

Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.

func (*GetConversationRequest) GetName

func (x *GetConversationRequest) GetName() string

func (*GetConversationRequest) ProtoMessage

func (*GetConversationRequest) ProtoMessage()

func (*GetConversationRequest) ProtoReflect

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

func (*GetConversationRequest) Reset

func (x *GetConversationRequest) Reset()

func (*GetConversationRequest) String

func (x *GetConversationRequest) String() string

type GetDataStoreRequest

type GetDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	//
	// If the caller does not have permission to access the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] 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 [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] method.

func (*GetDataStoreRequest) Descriptor deprecated

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

Deprecated: Use GetDataStoreRequest.ProtoReflect.Descriptor instead.

func (*GetDataStoreRequest) GetName

func (x *GetDataStoreRequest) GetName() string

func (*GetDataStoreRequest) ProtoMessage

func (*GetDataStoreRequest) ProtoMessage()

func (*GetDataStoreRequest) ProtoReflect

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

func (*GetDataStoreRequest) Reset

func (x *GetDataStoreRequest) Reset()

func (*GetDataStoreRequest) String

func (x *GetDataStoreRequest) String() string

type GetDocumentProcessingConfigRequest added in v1.6.0

type GetDocumentProcessingConfigRequest struct {

	// Required. Full DocumentProcessingConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] method.

func (*GetDocumentProcessingConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use GetDocumentProcessingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentProcessingConfigRequest) GetName added in v1.6.0

func (*GetDocumentProcessingConfigRequest) ProtoMessage added in v1.6.0

func (*GetDocumentProcessingConfigRequest) ProtoMessage()

func (*GetDocumentProcessingConfigRequest) ProtoReflect added in v1.6.0

func (*GetDocumentProcessingConfigRequest) Reset added in v1.6.0

func (*GetDocumentProcessingConfigRequest) String added in v1.6.0

type GetDocumentRequest

type GetDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.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 GetEngineRequest

type GetEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] method.

func (*GetEngineRequest) Descriptor deprecated

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

Deprecated: Use GetEngineRequest.ProtoReflect.Descriptor instead.

func (*GetEngineRequest) GetName

func (x *GetEngineRequest) GetName() string

func (*GetEngineRequest) ProtoMessage

func (*GetEngineRequest) ProtoMessage()

func (*GetEngineRequest) ProtoReflect

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

func (*GetEngineRequest) Reset

func (x *GetEngineRequest) Reset()

func (*GetEngineRequest) String

func (x *GetEngineRequest) String() string

type GetSchemaRequest

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.v1alpha.SchemaService.GetSchema] method.

func (*GetSchemaRequest) Descriptor deprecated

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

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) ProtoMessage

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect

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

func (*GetSchemaRequest) Reset

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String

func (x *GetSchemaRequest) String() string

type GetServingConfigRequest added in v1.6.0

type GetServingConfigRequest struct {

	// Required. The resource name of the ServingConfig to get. Format:
	// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetServingConfig method.

func (*GetServingConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetServingConfigRequest) GetName added in v1.6.0

func (x *GetServingConfigRequest) GetName() string

func (*GetServingConfigRequest) ProtoMessage added in v1.6.0

func (*GetServingConfigRequest) ProtoMessage()

func (*GetServingConfigRequest) ProtoReflect added in v1.6.0

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

func (*GetServingConfigRequest) Reset added in v1.6.0

func (x *GetServingConfigRequest) Reset()

func (*GetServingConfigRequest) String added in v1.6.0

func (x *GetServingConfigRequest) String() string

type GetSiteSearchEngineRequest added in v1.4.0

type GetSiteSearchEngineRequest struct {

	// Required. Resource name of
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	//
	// If the caller does not have permission to access the [SiteSearchEngine],
	// regardless of whether or not it exists, a PERMISSION_DENIED error is
	// returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] method.

func (*GetSiteSearchEngineRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use GetSiteSearchEngineRequest.ProtoReflect.Descriptor instead.

func (*GetSiteSearchEngineRequest) GetName added in v1.4.0

func (x *GetSiteSearchEngineRequest) GetName() string

func (*GetSiteSearchEngineRequest) ProtoMessage added in v1.4.0

func (*GetSiteSearchEngineRequest) ProtoMessage()

func (*GetSiteSearchEngineRequest) ProtoReflect added in v1.4.0

func (*GetSiteSearchEngineRequest) Reset added in v1.4.0

func (x *GetSiteSearchEngineRequest) Reset()

func (*GetSiteSearchEngineRequest) String added in v1.4.0

func (x *GetSiteSearchEngineRequest) String() string

type GetTargetSiteRequest added in v1.4.0

type GetTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
	//
	// If the caller does not have permission to access the
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] 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 [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] method.

func (*GetTargetSiteRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use GetTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*GetTargetSiteRequest) GetName added in v1.4.0

func (x *GetTargetSiteRequest) GetName() string

func (*GetTargetSiteRequest) ProtoMessage added in v1.4.0

func (*GetTargetSiteRequest) ProtoMessage()

func (*GetTargetSiteRequest) ProtoReflect added in v1.4.0

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

func (*GetTargetSiteRequest) Reset added in v1.4.0

func (x *GetTargetSiteRequest) Reset()

func (*GetTargetSiteRequest) String added in v1.4.0

func (x *GetTargetSiteRequest) String() string

type GuidedSearchSpec added in v1.6.0

type GuidedSearchSpec struct {

	// Whether or not to enable and include refinement attributes in gudied search
	// result.
	EnableRefinementAttributes bool `` /* 142-byte string literal not displayed */
	// Whether or not to enable and include related questions in search response.
	EnableRelatedQuestions bool `` /* 130-byte string literal not displayed */
	// Max number of related questions to be returned. The valid range is [1, 5].
	// If enable_related_questions is true, the default value is 3.
	MaxRelatedQuestions int32 `protobuf:"varint,3,opt,name=max_related_questions,json=maxRelatedQuestions,proto3" json:"max_related_questions,omitempty"`
	// contains filtered or unexported fields
}

Defines guided search spec.

func (*GuidedSearchSpec) Descriptor deprecated added in v1.6.0

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

Deprecated: Use GuidedSearchSpec.ProtoReflect.Descriptor instead.

func (*GuidedSearchSpec) GetEnableRefinementAttributes added in v1.6.0

func (x *GuidedSearchSpec) GetEnableRefinementAttributes() bool

func (*GuidedSearchSpec) GetEnableRelatedQuestions added in v1.6.0

func (x *GuidedSearchSpec) GetEnableRelatedQuestions() bool

func (*GuidedSearchSpec) GetMaxRelatedQuestions added in v1.6.0

func (x *GuidedSearchSpec) GetMaxRelatedQuestions() int32

func (*GuidedSearchSpec) ProtoMessage added in v1.6.0

func (*GuidedSearchSpec) ProtoMessage()

func (*GuidedSearchSpec) ProtoReflect added in v1.6.0

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

func (*GuidedSearchSpec) Reset added in v1.6.0

func (x *GuidedSearchSpec) Reset()

func (*GuidedSearchSpec) String added in v1.6.0

func (x *GuidedSearchSpec) String() string

type IdpConfig added in v1.6.0

type IdpConfig struct {

	// Identity provider type configured.
	IdpType IdpConfig_IdpType `` /* 143-byte string literal not displayed */
	// External Identity provider config.
	ExternalIdpConfig *IdpConfig_ExternalIdpConfig `protobuf:"bytes,2,opt,name=external_idp_config,json=externalIdpConfig,proto3" json:"external_idp_config,omitempty"`
	// contains filtered or unexported fields
}

Identity Provider Config.

func (*IdpConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use IdpConfig.ProtoReflect.Descriptor instead.

func (*IdpConfig) GetExternalIdpConfig added in v1.6.0

func (x *IdpConfig) GetExternalIdpConfig() *IdpConfig_ExternalIdpConfig

func (*IdpConfig) GetIdpType added in v1.6.0

func (x *IdpConfig) GetIdpType() IdpConfig_IdpType

func (*IdpConfig) ProtoMessage added in v1.6.0

func (*IdpConfig) ProtoMessage()

func (*IdpConfig) ProtoReflect added in v1.6.0

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

func (*IdpConfig) Reset added in v1.6.0

func (x *IdpConfig) Reset()

func (*IdpConfig) String added in v1.6.0

func (x *IdpConfig) String() string

type IdpConfig_ExternalIdpConfig added in v1.6.0

type IdpConfig_ExternalIdpConfig struct {

	// Workforce pool name.
	// Example: "locations/global/workforcePools/pool_id"
	WorkforcePoolName string `protobuf:"bytes,1,opt,name=workforce_pool_name,json=workforcePoolName,proto3" json:"workforce_pool_name,omitempty"`
	// contains filtered or unexported fields
}

Third party IDP Config.

func (*IdpConfig_ExternalIdpConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use IdpConfig_ExternalIdpConfig.ProtoReflect.Descriptor instead.

func (*IdpConfig_ExternalIdpConfig) GetWorkforcePoolName added in v1.6.0

func (x *IdpConfig_ExternalIdpConfig) GetWorkforcePoolName() string

func (*IdpConfig_ExternalIdpConfig) ProtoMessage added in v1.6.0

func (*IdpConfig_ExternalIdpConfig) ProtoMessage()

func (*IdpConfig_ExternalIdpConfig) ProtoReflect added in v1.6.0

func (*IdpConfig_ExternalIdpConfig) Reset added in v1.6.0

func (x *IdpConfig_ExternalIdpConfig) Reset()

func (*IdpConfig_ExternalIdpConfig) String added in v1.6.0

func (x *IdpConfig_ExternalIdpConfig) String() string

type IdpConfig_IdpType added in v1.6.0

type IdpConfig_IdpType int32

Identity Provider Type.

const (
	// Default value. ACL search not enabled.
	IdpConfig_IDP_TYPE_UNSPECIFIED IdpConfig_IdpType = 0
	// Google 1P provider.
	IdpConfig_GSUITE IdpConfig_IdpType = 1
	// Third party provider.
	IdpConfig_THIRD_PARTY IdpConfig_IdpType = 2
)

func (IdpConfig_IdpType) Descriptor added in v1.6.0

func (IdpConfig_IdpType) Enum added in v1.6.0

func (IdpConfig_IdpType) EnumDescriptor deprecated added in v1.6.0

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

Deprecated: Use IdpConfig_IdpType.Descriptor instead.

func (IdpConfig_IdpType) Number added in v1.6.0

func (IdpConfig_IdpType) String added in v1.6.0

func (x IdpConfig_IdpType) String() string

func (IdpConfig_IdpType) Type added in v1.6.0

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 is 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.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
	ReconciliationMode ImportDocumentsRequest_ReconciliationMode `` /* 200-byte string literal not displayed */
	// Whether to automatically generate IDs for the documents if absent.
	//
	// If set to `true`,
	// [Document.id][google.cloud.discoveryengine.v1alpha.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.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL]
	// is highly recommended to avoid duplicate contents. If unset or set to
	// `false`, [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s
	// have to be specified using
	// [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field],
	// otherwise, documents without IDs fail to be imported.
	//
	// Only set this field when using
	// [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] or
	// [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource], and
	// when
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
	// or
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
	// is `custom` or `csv`. 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.v1alpha.GcsSource] it is the
	// key of the JSON field. For instance, `my_id` for JSON `{"my_id":
	// "some_uuid"}`. For
	// [BigQuerySource][google.cloud.discoveryengine.v1alpha.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 are used as the
	// [Document.id][google.cloud.discoveryengine.v1alpha.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 fail to be imported.
	//
	// Only set this field when using
	// [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] or
	// [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource], and
	// when
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
	// or
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
	// is `custom`. And only set this field when
	// [auto_generate_ids][google.cloud.discoveryengine.v1alpha.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

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

func (x *ImportDocumentsRequest) GetIdField() string

func (*ImportDocumentsRequest) GetInlineSource

func (*ImportDocumentsRequest) GetParent

func (x *ImportDocumentsRequest) GetParent() string

func (*ImportDocumentsRequest) GetReconciliationMode

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.v1alpha.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 (*ImportDocumentsRequest_InlineSource) Reset

func (*ImportDocumentsRequest_InlineSource) 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) Enum

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor deprecated

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

Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.

func (ImportDocumentsRequest_ReconciliationMode) Number

func (ImportDocumentsRequest_ReconciliationMode) String

func (ImportDocumentsRequest_ReconciliationMode) Type

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.v1alpha.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 are 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 ImportSuggestionDenyListEntriesMetadata added in v1.6.0

type ImportSuggestionDenyListEntriesMetadata 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 related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ImportSuggestionDenyListEntriesMetadata) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ImportSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesMetadata) GetCreateTime added in v1.6.0

func (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime added in v1.6.0

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage added in v1.6.0

func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect added in v1.6.0

func (*ImportSuggestionDenyListEntriesMetadata) Reset added in v1.6.0

func (*ImportSuggestionDenyListEntriesMetadata) String added in v1.6.0

type ImportSuggestionDenyListEntriesRequest added in v1.6.0

type ImportSuggestionDenyListEntriesRequest struct {

	// The source of the updated SuggestionDenyList.
	//
	// Types that are assignable to Source:
	//
	//	*ImportSuggestionDenyListEntriesRequest_InlineSource_
	//	*ImportSuggestionDenyListEntriesRequest_GcsSource
	Source isImportSuggestionDenyListEntriesRequest_Source `protobuf_oneof:"source"`
	// Required. The parent data store resource name for which to import denylist
	// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.

func (*ImportSuggestionDenyListEntriesRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) GetInlineSource added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) GetParent added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) GetSource added in v1.6.0

func (m *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Source

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) Reset added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest) String added in v1.6.0

type ImportSuggestionDenyListEntriesRequest_GcsSource added in v1.6.0

type ImportSuggestionDenyListEntriesRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	//
	// Only 1 file can be specified that contains all entries to import.
	// Supported values `gcs_source.schema` for autocomplete suggestion deny
	// list entry imports:
	//
	// * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
	// per line.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportSuggestionDenyListEntriesRequest_InlineSource added in v1.6.0

type ImportSuggestionDenyListEntriesRequest_InlineSource struct {

	// Required. A list of all denylist entries to import. Max of 1000 items.
	Entries []*SuggestionDenyListEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

The inline source for SuggestionDenyListEntry.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor deprecated added in v1.6.0

Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset added in v1.6.0

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) String added in v1.6.0

type ImportSuggestionDenyListEntriesRequest_InlineSource_ added in v1.6.0

type ImportSuggestionDenyListEntriesRequest_InlineSource_ struct {
	// The Inline source for the input content for suggestion deny list entries.
	InlineSource *ImportSuggestionDenyListEntriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportSuggestionDenyListEntriesResponse added in v1.6.0

type ImportSuggestionDenyListEntriesResponse 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"`
	// Count of deny list entries successfully imported.
	ImportedEntriesCount int64 `protobuf:"varint,2,opt,name=imported_entries_count,json=importedEntriesCount,proto3" json:"imported_entries_count,omitempty"`
	// Count of deny list entries that failed to be imported.
	FailedEntriesCount int64 `protobuf:"varint,3,opt,name=failed_entries_count,json=failedEntriesCount,proto3" json:"failed_entries_count,omitempty"`
	// contains filtered or unexported fields
}

Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.

func (*ImportSuggestionDenyListEntriesResponse) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ImportSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesResponse) GetErrorSamples added in v1.6.0

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

func (*ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount added in v1.6.0

func (x *ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount added in v1.6.0

func (x *ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage added in v1.6.0

func (*ImportSuggestionDenyListEntriesResponse) ProtoReflect added in v1.6.0

func (*ImportSuggestionDenyListEntriesResponse) Reset added in v1.6.0

func (*ImportSuggestionDenyListEntriesResponse) String added in v1.6.0

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 is 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 {

	// Required - 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 (*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 {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportUserEventsRequest_GcsSource

type ImportUserEventsRequest_GcsSource struct {
	// 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 (*ImportUserEventsRequest_InlineSource) Reset

func (*ImportUserEventsRequest_InlineSource) String

type ImportUserEventsRequest_InlineSource_

type ImportUserEventsRequest_InlineSource_ struct {
	// 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 IndustryVertical

type IndustryVertical int32

The industry vertical associated with the DataStore[google.cloud.discoveryengine.v1alpha.DataStore].

const (
	// Value used when unset.
	IndustryVertical_INDUSTRY_VERTICAL_UNSPECIFIED IndustryVertical = 0
	// The generic vertical for documents that are not specific to any industry
	// vertical.
	IndustryVertical_GENERIC IndustryVertical = 1
	// The media industry vertical.
	IndustryVertical_MEDIA IndustryVertical = 2
)

func (IndustryVertical) Descriptor

func (IndustryVertical) Enum

func (IndustryVertical) EnumDescriptor deprecated

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

Deprecated: Use IndustryVertical.Descriptor instead.

func (IndustryVertical) Number

func (IndustryVertical) String

func (x IndustryVertical) String() string

func (IndustryVertical) Type

type Interval

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

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

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect

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

func (*Interval) Reset

func (x *Interval) Reset()

func (*Interval) String

func (x *Interval) String() string

type Interval_ExclusiveMaximum

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

type Interval_ExclusiveMinimum

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

type Interval_Maximum

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

type Interval_Minimum

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

type ListChunksRequest added in v1.6.0

type ListChunksRequest struct {

	// Required. The parent document resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to list
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document,
	// regardless of whether or not this document exists, a `PERMISSION_DENIED`
	// error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]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
	// [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token],
	// received from a previous
	// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
	// 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 [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.

func (*ListChunksRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ListChunksRequest.ProtoReflect.Descriptor instead.

func (*ListChunksRequest) GetPageSize added in v1.6.0

func (x *ListChunksRequest) GetPageSize() int32

func (*ListChunksRequest) GetPageToken added in v1.6.0

func (x *ListChunksRequest) GetPageToken() string

func (*ListChunksRequest) GetParent added in v1.6.0

func (x *ListChunksRequest) GetParent() string

func (*ListChunksRequest) ProtoMessage added in v1.6.0

func (*ListChunksRequest) ProtoMessage()

func (*ListChunksRequest) ProtoReflect added in v1.6.0

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

func (*ListChunksRequest) Reset added in v1.6.0

func (x *ListChunksRequest) Reset()

func (*ListChunksRequest) String added in v1.6.0

func (x *ListChunksRequest) String() string

type ListChunksResponse added in v1.6.0

type ListChunksResponse struct {

	// The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
	Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// A token that can be sent as
	// [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.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 [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.

func (*ListChunksResponse) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ListChunksResponse.ProtoReflect.Descriptor instead.

func (*ListChunksResponse) GetChunks added in v1.6.0

func (x *ListChunksResponse) GetChunks() []*Chunk

func (*ListChunksResponse) GetNextPageToken added in v1.6.0

func (x *ListChunksResponse) GetNextPageToken() string

func (*ListChunksResponse) ProtoMessage added in v1.6.0

func (*ListChunksResponse) ProtoMessage()

func (*ListChunksResponse) ProtoReflect added in v1.6.0

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

func (*ListChunksResponse) Reset added in v1.6.0

func (x *ListChunksResponse) Reset()

func (*ListChunksResponse) String added in v1.6.0

func (x *ListChunksResponse) String() string

type ListConversationsRequest

type ListConversationsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListConversations` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter to apply on the list results. The supported features are:
	// user_pseudo_id, state.
	//
	// Example:
	// "user_pseudo_id = some_id"
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//   - `update_time`
	//   - `create_time`
	//   - `conversation_name`
	//
	// Example:
	// "update_time desc"
	// "create_time"
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request for ListConversations method.

func (*ListConversationsRequest) Descriptor deprecated

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

Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.

func (*ListConversationsRequest) GetFilter

func (x *ListConversationsRequest) GetFilter() string

func (*ListConversationsRequest) GetOrderBy

func (x *ListConversationsRequest) GetOrderBy() string

func (*ListConversationsRequest) GetPageSize

func (x *ListConversationsRequest) GetPageSize() int32

func (*ListConversationsRequest) GetPageToken

func (x *ListConversationsRequest) GetPageToken() string

func (*ListConversationsRequest) GetParent

func (x *ListConversationsRequest) GetParent() string

func (*ListConversationsRequest) ProtoMessage

func (*ListConversationsRequest) ProtoMessage()

func (*ListConversationsRequest) ProtoReflect

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

func (*ListConversationsRequest) Reset

func (x *ListConversationsRequest) Reset()

func (*ListConversationsRequest) String

func (x *ListConversationsRequest) String() string

type ListConversationsResponse

type ListConversationsResponse struct {

	// All the Conversations for a given data store.
	Conversations []*Conversation `protobuf:"bytes,1,rep,name=conversations,proto3" json:"conversations,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListConversations method.

func (*ListConversationsResponse) Descriptor deprecated

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

Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.

func (*ListConversationsResponse) GetConversations

func (x *ListConversationsResponse) GetConversations() []*Conversation

func (*ListConversationsResponse) GetNextPageToken

func (x *ListConversationsResponse) GetNextPageToken() string

func (*ListConversationsResponse) ProtoMessage

func (*ListConversationsResponse) ProtoMessage()

func (*ListConversationsResponse) ProtoReflect

func (*ListConversationsResponse) Reset

func (x *ListConversationsResponse) Reset()

func (*ListConversationsResponse) String

func (x *ListConversationsResponse) String() string

type ListDataStoresRequest

type ListDataStoresRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection_id}`.
	//
	// If the caller does not have permission to list
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s under this
	// location, regardless of whether or not this data store exists, a
	// PERMISSION_DENIED error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s to return. If
	// unspecified, defaults to 10. The maximum allowed value is 50. Values above
	// 50 will be coerced to 50.
	//
	// If this field is negative, an INVALID_ARGUMENT is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token],
	// received from a previous
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
	// 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"`
	// Filter by solution type. For example: filter =
	// 'solution_type:SOLUTION_TYPE_SEARCH'
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.

func (*ListDataStoresRequest) Descriptor deprecated

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

Deprecated: Use ListDataStoresRequest.ProtoReflect.Descriptor instead.

func (*ListDataStoresRequest) GetFilter

func (x *ListDataStoresRequest) GetFilter() string

func (*ListDataStoresRequest) GetPageSize

func (x *ListDataStoresRequest) GetPageSize() int32

func (*ListDataStoresRequest) GetPageToken

func (x *ListDataStoresRequest) GetPageToken() string

func (*ListDataStoresRequest) GetParent

func (x *ListDataStoresRequest) GetParent() string

func (*ListDataStoresRequest) ProtoMessage

func (*ListDataStoresRequest) ProtoMessage()

func (*ListDataStoresRequest) ProtoReflect

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

func (*ListDataStoresRequest) Reset

func (x *ListDataStoresRequest) Reset()

func (*ListDataStoresRequest) String

func (x *ListDataStoresRequest) String() string

type ListDataStoresResponse

type ListDataStoresResponse struct {

	// All the customer's
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s.
	DataStores []*DataStore `protobuf:"bytes,1,rep,name=data_stores,json=dataStores,proto3" json:"data_stores,omitempty"`
	// A token that can be sent as
	// [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.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 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.

func (*ListDataStoresResponse) Descriptor deprecated

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

Deprecated: Use ListDataStoresResponse.ProtoReflect.Descriptor instead.

func (*ListDataStoresResponse) GetDataStores

func (x *ListDataStoresResponse) GetDataStores() []*DataStore

func (*ListDataStoresResponse) GetNextPageToken

func (x *ListDataStoresResponse) GetNextPageToken() string

func (*ListDataStoresResponse) ProtoMessage

func (*ListDataStoresResponse) ProtoMessage()

func (*ListDataStoresResponse) ProtoReflect

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

func (*ListDataStoresResponse) Reset

func (x *ListDataStoresResponse) Reset()

func (*ListDataStoresResponse) String

func (x *ListDataStoresResponse) String() string

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
	// [Document][google.cloud.discoveryengine.v1alpha.Document]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.v1alpha.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.v1alpha.ListDocumentsResponse.next_page_token],
	// received from a previous
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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 ListEnginesRequest

type ListEnginesRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Not supported.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. Not supported.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filter by solution type. For example:
	// solution_type=SOLUTION_TYPE_SEARCH
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.

func (*ListEnginesRequest) Descriptor deprecated

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

Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.

func (*ListEnginesRequest) GetFilter

func (x *ListEnginesRequest) GetFilter() string

func (*ListEnginesRequest) GetPageSize

func (x *ListEnginesRequest) GetPageSize() int32

func (*ListEnginesRequest) GetPageToken

func (x *ListEnginesRequest) GetPageToken() string

func (*ListEnginesRequest) GetParent

func (x *ListEnginesRequest) GetParent() string

func (*ListEnginesRequest) ProtoMessage

func (*ListEnginesRequest) ProtoMessage()

func (*ListEnginesRequest) ProtoReflect

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

func (*ListEnginesRequest) Reset

func (x *ListEnginesRequest) Reset()

func (*ListEnginesRequest) String

func (x *ListEnginesRequest) String() string

type ListEnginesResponse

type ListEnginesResponse struct {

	// All the customer's [Engine][google.cloud.discoveryengine.v1alpha.Engine]s.
	Engines []*Engine `protobuf:"bytes,1,rep,name=engines,proto3" json:"engines,omitempty"`
	// Not supported.
	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 [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.

func (*ListEnginesResponse) Descriptor deprecated

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

Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.

func (*ListEnginesResponse) GetEngines

func (x *ListEnginesResponse) GetEngines() []*Engine

func (*ListEnginesResponse) GetNextPageToken

func (x *ListEnginesResponse) GetNextPageToken() string

func (*ListEnginesResponse) ProtoMessage

func (*ListEnginesResponse) ProtoMessage()

func (*ListEnginesResponse) ProtoReflect

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

func (*ListEnginesResponse) Reset

func (x *ListEnginesResponse) Reset()

func (*ListEnginesResponse) String

func (x *ListEnginesResponse) String() string

type ListSchemasRequest

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.v1alpha.Schema]s to return. The
	// service may return fewer than this value.
	//
	// If unspecified, at most 100
	// [Schema][google.cloud.discoveryengine.v1alpha.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.v1alpha.SchemaService.ListSchemas]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.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.v1alpha.SchemaService.ListSchemas] method.

func (*ListSchemasRequest) Descriptor deprecated

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

Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListSchemasRequest) GetPageSize

func (x *ListSchemasRequest) GetPageSize() int32

func (*ListSchemasRequest) GetPageToken

func (x *ListSchemasRequest) GetPageToken() string

func (*ListSchemasRequest) GetParent

func (x *ListSchemasRequest) GetParent() string

func (*ListSchemasRequest) ProtoMessage

func (*ListSchemasRequest) ProtoMessage()

func (*ListSchemasRequest) ProtoReflect

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

func (*ListSchemasRequest) Reset

func (x *ListSchemasRequest) Reset()

func (*ListSchemasRequest) String

func (x *ListSchemasRequest) String() string

type ListSchemasResponse

type ListSchemasResponse struct {

	// The [Schema][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.SchemaService.ListSchemas] method.

func (*ListSchemasResponse) Descriptor deprecated

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

Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListSchemasResponse) GetNextPageToken

func (x *ListSchemasResponse) GetNextPageToken() string

func (*ListSchemasResponse) GetSchemas

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

func (*ListSchemasResponse) ProtoMessage

func (*ListSchemasResponse) ProtoMessage()

func (*ListSchemasResponse) ProtoReflect

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

func (*ListSchemasResponse) Reset

func (x *ListSchemasResponse) Reset()

func (*ListSchemasResponse) String

func (x *ListSchemasResponse) String() string

type ListServingConfigsRequest added in v1.6.0

type ListServingConfigsRequest struct {

	// Required. Full resource name of the parent resource. Format:
	// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 100. If a value greater than 100 is provided, at most 100 results are
	// returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListServingConfigs` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for ListServingConfigs method.

func (*ListServingConfigsRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ListServingConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListServingConfigsRequest) GetPageSize added in v1.6.0

func (x *ListServingConfigsRequest) GetPageSize() int32

func (*ListServingConfigsRequest) GetPageToken added in v1.6.0

func (x *ListServingConfigsRequest) GetPageToken() string

func (*ListServingConfigsRequest) GetParent added in v1.6.0

func (x *ListServingConfigsRequest) GetParent() string

func (*ListServingConfigsRequest) ProtoMessage added in v1.6.0

func (*ListServingConfigsRequest) ProtoMessage()

func (*ListServingConfigsRequest) ProtoReflect added in v1.6.0

func (*ListServingConfigsRequest) Reset added in v1.6.0

func (x *ListServingConfigsRequest) Reset()

func (*ListServingConfigsRequest) String added in v1.6.0

func (x *ListServingConfigsRequest) String() string

type ListServingConfigsResponse added in v1.6.0

type ListServingConfigsResponse struct {

	// All the ServingConfigs for a given dataStore.
	ServingConfigs []*ServingConfig `protobuf:"bytes,1,rep,name=serving_configs,json=servingConfigs,proto3" json:"serving_configs,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListServingConfigs method.

func (*ListServingConfigsResponse) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ListServingConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListServingConfigsResponse) GetNextPageToken added in v1.6.0

func (x *ListServingConfigsResponse) GetNextPageToken() string

func (*ListServingConfigsResponse) GetServingConfigs added in v1.6.0

func (x *ListServingConfigsResponse) GetServingConfigs() []*ServingConfig

func (*ListServingConfigsResponse) ProtoMessage added in v1.6.0

func (*ListServingConfigsResponse) ProtoMessage()

func (*ListServingConfigsResponse) ProtoReflect added in v1.6.0

func (*ListServingConfigsResponse) Reset added in v1.6.0

func (x *ListServingConfigsResponse) Reset()

func (*ListServingConfigsResponse) String added in v1.6.0

func (x *ListServingConfigsResponse) String() string

type ListTargetSitesRequest added in v1.4.0

type ListTargetSitesRequest struct {

	// Required. The parent site search engine resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	//
	// If the caller does not have permission to list
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s under this
	// site search engine, 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"`
	// Requested page size. Server may return fewer items than requested. If
	// unspecified, server will pick an appropriate default. The maximum 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, received from a previous `ListTargetSites` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListTargetSites`
	// 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 [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] method.

func (*ListTargetSitesRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use ListTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*ListTargetSitesRequest) GetPageSize added in v1.4.0

func (x *ListTargetSitesRequest) GetPageSize() int32

func (*ListTargetSitesRequest) GetPageToken added in v1.4.0

func (x *ListTargetSitesRequest) GetPageToken() string

func (*ListTargetSitesRequest) GetParent added in v1.4.0

func (x *ListTargetSitesRequest) GetParent() string

func (*ListTargetSitesRequest) ProtoMessage added in v1.4.0

func (*ListTargetSitesRequest) ProtoMessage()

func (*ListTargetSitesRequest) ProtoReflect added in v1.4.0

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

func (*ListTargetSitesRequest) Reset added in v1.4.0

func (x *ListTargetSitesRequest) Reset()

func (*ListTargetSitesRequest) String added in v1.4.0

func (x *ListTargetSitesRequest) String() string

type ListTargetSitesResponse added in v1.4.0

type ListTargetSitesResponse struct {

	// List of TargetSites.
	TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
	// A token that can be sent as `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"`
	// The total number of items matching the request.
	// This will always be populated in the response.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] method.

func (*ListTargetSitesResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use ListTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*ListTargetSitesResponse) GetNextPageToken added in v1.4.0

func (x *ListTargetSitesResponse) GetNextPageToken() string

func (*ListTargetSitesResponse) GetTargetSites added in v1.4.0

func (x *ListTargetSitesResponse) GetTargetSites() []*TargetSite

func (*ListTargetSitesResponse) GetTotalSize added in v1.4.0

func (x *ListTargetSitesResponse) GetTotalSize() int32

func (*ListTargetSitesResponse) ProtoMessage added in v1.4.0

func (*ListTargetSitesResponse) ProtoMessage()

func (*ListTargetSitesResponse) ProtoReflect added in v1.4.0

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

func (*ListTargetSitesResponse) Reset added in v1.4.0

func (x *ListTargetSitesResponse) Reset()

func (*ListTargetSitesResponse) String added in v1.4.0

func (x *ListTargetSitesResponse) 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][google.protobuf.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][google.cloud.discoveryengine.v1alpha.MediaInfo.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 `pageview_id` 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.v1alpha.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.v1alpha.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 PauseEngineRequest

type PauseEngineRequest struct {

	// Required. The name of the engine to pause.
	// Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for pausing training of an engine.

func (*PauseEngineRequest) Descriptor deprecated

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

Deprecated: Use PauseEngineRequest.ProtoReflect.Descriptor instead.

func (*PauseEngineRequest) GetName

func (x *PauseEngineRequest) GetName() string

func (*PauseEngineRequest) ProtoMessage

func (*PauseEngineRequest) ProtoMessage()

func (*PauseEngineRequest) ProtoReflect

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

func (*PauseEngineRequest) Reset

func (x *PauseEngineRequest) Reset()

func (*PauseEngineRequest) String

func (x *PauseEngineRequest) String() string

type Principal added in v1.6.0

type Principal struct {

	// Union field principal. Principal can be a user or a group.
	//
	// Types that are assignable to Principal:
	//
	//	*Principal_UserId
	//	*Principal_GroupId
	Principal isPrincipal_Principal `protobuf_oneof:"principal"`
	// contains filtered or unexported fields
}

Principal identifier of a user or a group.

func (*Principal) Descriptor deprecated added in v1.6.0

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

Deprecated: Use Principal.ProtoReflect.Descriptor instead.

func (*Principal) GetGroupId added in v1.6.0

func (x *Principal) GetGroupId() string

func (*Principal) GetPrincipal added in v1.6.0

func (m *Principal) GetPrincipal() isPrincipal_Principal

func (*Principal) GetUserId added in v1.6.0

func (x *Principal) GetUserId() string

func (*Principal) ProtoMessage added in v1.6.0

func (*Principal) ProtoMessage()

func (*Principal) ProtoReflect added in v1.6.0

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

func (*Principal) Reset added in v1.6.0

func (x *Principal) Reset()

func (*Principal) String added in v1.6.0

func (x *Principal) String() string

type Principal_GroupId added in v1.6.0

type Principal_GroupId struct {
	// Group identifier.
	// For Google Workspace user account, group_id should be the google
	// workspace group email.
	// For non-google identity provider user account, group_id is the mapped
	// group identifier configured during the workforcepool config.
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3,oneof"`
}

type Principal_UserId added in v1.6.0

type Principal_UserId struct {
	// User identifier.
	// For Google Workspace user account, user_id should be the google workspace
	// user email.
	// For non-google identity provider user account, user_id is the mapped user
	// identifier configured during the workforcepool config.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof"`
}

type PurgeDocumentsMetadata

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"`
	// Count of entries that were ignored as entries were not found.
	IgnoredCount int64 `protobuf:"varint,5,opt,name=ignored_count,json=ignoredCount,proto3" json:"ignored_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

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

Deprecated: Use PurgeDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsMetadata) GetCreateTime

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

func (*PurgeDocumentsMetadata) GetFailureCount

func (x *PurgeDocumentsMetadata) GetFailureCount() int64

func (*PurgeDocumentsMetadata) GetIgnoredCount added in v1.6.0

func (x *PurgeDocumentsMetadata) GetIgnoredCount() int64

func (*PurgeDocumentsMetadata) GetSuccessCount

func (x *PurgeDocumentsMetadata) GetSuccessCount() int64

func (*PurgeDocumentsMetadata) GetUpdateTime

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

func (*PurgeDocumentsMetadata) ProtoMessage

func (*PurgeDocumentsMetadata) ProtoMessage()

func (*PurgeDocumentsMetadata) ProtoReflect

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

func (*PurgeDocumentsMetadata) Reset

func (x *PurgeDocumentsMetadata) Reset()

func (*PurgeDocumentsMetadata) String

func (x *PurgeDocumentsMetadata) String() string

type PurgeDocumentsRequest

type PurgeDocumentsRequest struct {

	// The desired input source for the purging documents based on document ids.
	//
	// Types that are assignable to Source:
	//
	//	*PurgeDocumentsRequest_GcsSource
	Source isPurgeDocumentsRequest_Source `protobuf_oneof:"source"`
	// 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"`
	// The desired location of errors incurred during the purge.
	ErrorConfig *PurgeErrorConfig `protobuf:"bytes,7,opt,name=error_config,json=errorConfig,proto3" json:"error_config,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.v1alpha.DocumentService.PurgeDocuments] method.

func (*PurgeDocumentsRequest) Descriptor deprecated

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

Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest) GetErrorConfig added in v1.6.0

func (x *PurgeDocumentsRequest) GetErrorConfig() *PurgeErrorConfig

func (*PurgeDocumentsRequest) GetFilter

func (x *PurgeDocumentsRequest) GetFilter() string

func (*PurgeDocumentsRequest) GetForce

func (x *PurgeDocumentsRequest) GetForce() bool

func (*PurgeDocumentsRequest) GetGcsSource added in v1.6.0

func (x *PurgeDocumentsRequest) GetGcsSource() *GcsSource

func (*PurgeDocumentsRequest) GetParent

func (x *PurgeDocumentsRequest) GetParent() string

func (*PurgeDocumentsRequest) GetSource added in v1.6.0

func (m *PurgeDocumentsRequest) GetSource() isPurgeDocumentsRequest_Source

func (*PurgeDocumentsRequest) ProtoMessage

func (*PurgeDocumentsRequest) ProtoMessage()

func (*PurgeDocumentsRequest) ProtoReflect

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

func (*PurgeDocumentsRequest) Reset

func (x *PurgeDocumentsRequest) Reset()

func (*PurgeDocumentsRequest) String

func (x *PurgeDocumentsRequest) String() string

type PurgeDocumentsRequest_GcsSource added in v1.6.0

type PurgeDocumentsRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	// Supported `data_schema`:
	// * `document_id`: One valid
	// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
	GcsSource *GcsSource `protobuf:"bytes,5,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type PurgeDocumentsResponse

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.v1alpha.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

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

Deprecated: Use PurgeDocumentsResponse.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsResponse) GetPurgeCount

func (x *PurgeDocumentsResponse) GetPurgeCount() int64

func (*PurgeDocumentsResponse) GetPurgeSample

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

func (*PurgeDocumentsResponse) ProtoMessage

func (*PurgeDocumentsResponse) ProtoMessage()

func (*PurgeDocumentsResponse) ProtoReflect

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

func (*PurgeDocumentsResponse) Reset

func (x *PurgeDocumentsResponse) Reset()

func (*PurgeDocumentsResponse) String

func (x *PurgeDocumentsResponse) String() string

type PurgeErrorConfig added in v1.6.0

type PurgeErrorConfig struct {

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

Configuration of destination for Purge related errors.

func (*PurgeErrorConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use PurgeErrorConfig.ProtoReflect.Descriptor instead.

func (*PurgeErrorConfig) GetDestination added in v1.6.0

func (m *PurgeErrorConfig) GetDestination() isPurgeErrorConfig_Destination

func (*PurgeErrorConfig) GetGcsPrefix added in v1.6.0

func (x *PurgeErrorConfig) GetGcsPrefix() string

func (*PurgeErrorConfig) ProtoMessage added in v1.6.0

func (*PurgeErrorConfig) ProtoMessage()

func (*PurgeErrorConfig) ProtoReflect added in v1.6.0

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

func (*PurgeErrorConfig) Reset added in v1.6.0

func (x *PurgeErrorConfig) Reset()

func (*PurgeErrorConfig) String added in v1.6.0

func (x *PurgeErrorConfig) String() string

type PurgeErrorConfig_GcsPrefix added in v1.6.0

type PurgeErrorConfig_GcsPrefix struct {
	// Cloud Storage prefix for purge errors. This must be an empty,
	// existing Cloud Storage directory. Purge errors are 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 PurgeSuggestionDenyListEntriesMetadata added in v1.6.0

type PurgeSuggestionDenyListEntriesMetadata 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 related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

func (*PurgeSuggestionDenyListEntriesMetadata) Descriptor deprecated added in v1.6.0

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

Deprecated: Use PurgeSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesMetadata) GetCreateTime added in v1.6.0

func (*PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime added in v1.6.0

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage added in v1.6.0

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoReflect added in v1.6.0

func (*PurgeSuggestionDenyListEntriesMetadata) Reset added in v1.6.0

func (*PurgeSuggestionDenyListEntriesMetadata) String added in v1.6.0

type PurgeSuggestionDenyListEntriesRequest added in v1.6.0

type PurgeSuggestionDenyListEntriesRequest struct {

	// Required. The parent data store resource name for which to import denylist
	// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] method.

func (*PurgeSuggestionDenyListEntriesRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use PurgeSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesRequest) GetParent added in v1.6.0

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage added in v1.6.0

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage()

func (*PurgeSuggestionDenyListEntriesRequest) ProtoReflect added in v1.6.0

func (*PurgeSuggestionDenyListEntriesRequest) Reset added in v1.6.0

func (*PurgeSuggestionDenyListEntriesRequest) String added in v1.6.0

type PurgeSuggestionDenyListEntriesResponse added in v1.6.0

type PurgeSuggestionDenyListEntriesResponse struct {

	// Number of suggestion deny list entries purged.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

Response message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] method.

func (*PurgeSuggestionDenyListEntriesResponse) Descriptor deprecated added in v1.6.0

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

Deprecated: Use PurgeSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesResponse) GetErrorSamples added in v1.6.0

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

func (*PurgeSuggestionDenyListEntriesResponse) GetPurgeCount added in v1.6.0

func (x *PurgeSuggestionDenyListEntriesResponse) GetPurgeCount() int64

func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage added in v1.6.0

func (*PurgeSuggestionDenyListEntriesResponse) ProtoReflect added in v1.6.0

func (*PurgeSuggestionDenyListEntriesResponse) Reset added in v1.6.0

func (*PurgeSuggestionDenyListEntriesResponse) String added in v1.6.0

type PurgeUserEventsMetadata

type PurgeUserEventsMetadata 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 PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*PurgeUserEventsMetadata) Descriptor deprecated

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

Deprecated: Use PurgeUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsMetadata) GetCreateTime

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

func (*PurgeUserEventsMetadata) GetFailureCount

func (x *PurgeUserEventsMetadata) GetFailureCount() int64

func (*PurgeUserEventsMetadata) GetSuccessCount

func (x *PurgeUserEventsMetadata) GetSuccessCount() int64

func (*PurgeUserEventsMetadata) GetUpdateTime

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

func (*PurgeUserEventsMetadata) ProtoMessage

func (*PurgeUserEventsMetadata) ProtoMessage()

func (*PurgeUserEventsMetadata) ProtoReflect

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

func (*PurgeUserEventsMetadata) Reset

func (x *PurgeUserEventsMetadata) Reset()

func (*PurgeUserEventsMetadata) String

func (x *PurgeUserEventsMetadata) String() string

type PurgeUserEventsRequest

type PurgeUserEventsRequest struct {

	// Required. The resource name of the catalog under which the events are
	// created. The format is
	// `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The filter string to specify the events to be deleted with a
	// length limit of 5,000 characters. The eligible fields for filtering are:
	//
	// * `eventType`: Double quoted
	// [UserEvent.event_type][google.cloud.discoveryengine.v1alpha.UserEvent.event_type]
	// string.
	//   - `eventTime`: in ISO 8601 "zulu" format.
	//   - `userPseudoId`: Double quoted string. Specifying this will delete all
	//     events associated with a visitor.
	//   - `userId`: Double quoted string. Specifying this will delete all events
	//     associated with a user.
	//
	// Examples:
	//
	//   - Deleting all events in a time range:
	//     `eventTime > "2012-04-23T18:25:43.511Z"
	//     eventTime < "2012-04-23T18:30:43.511Z"`
	//   - Deleting specific eventType:
	//     `eventType = "search"`
	//   - Deleting all events for a specific visitor:
	//     `userPseudoId = "visitor1024"`
	//   - Deleting all events inside a DataStore:
	//     `*`
	//
	// The filtering fields are assumed to have an implicit AND.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The `force` field is currently not supported. Purge user event requests
	// will permanently delete all purgeable events. Once the development is
	// complete:
	// If `force` is set to false, the method will return the expected
	// purge count without deleting any user events. This field will default to
	// false if not included in the request.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for PurgeUserEvents method.

func (*PurgeUserEventsRequest) Descriptor deprecated

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

Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsRequest) GetFilter

func (x *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce

func (x *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent

func (x *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) ProtoReflect

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

func (*PurgeUserEventsRequest) Reset

func (x *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String

func (x *PurgeUserEventsRequest) String() string

type PurgeUserEventsResponse

type PurgeUserEventsResponse struct {

	// The total count of events purged as a result of the operation.
	PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

func (*PurgeUserEventsResponse) Descriptor deprecated

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

Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsResponse) GetPurgeCount

func (x *PurgeUserEventsResponse) GetPurgeCount() int64

func (*PurgeUserEventsResponse) ProtoMessage

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) ProtoReflect

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

func (*PurgeUserEventsResponse) Reset

func (x *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String

func (x *PurgeUserEventsResponse) String() string

type RecommendRequest

type RecommendRequest struct {

	// Required. Full resource name of a
	// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]:
	// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
	// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
	//
	// One default serving config is created along with your recommendation engine
	// creation. The engine ID will be used as the ID of the default serving
	// config. For example, for Engine
	// `projects/*/locations/global/collections/*/engines/my-engine`, you can use
	// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
	// for your
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]
	// requests.
	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.v1alpha.UserEvent.user_pseudo_id]
	// or
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.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.v1alpha.UserEvent.user_pseudo_id]
	// to a random unique ID and leave
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.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 `attributeFilteringSyntax` is set to true under the `params` field, then
	// attribute-based expressions are expected instead of the above described
	// tag-based syntax. Examples:
	//
	//   - (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
	//   - (available: true) AND
	//     (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
	//
	// 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.v1alpha.RecommendRequest.params]
	// to receive empty results instead.
	//
	// Note that the API will never return
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.
	//   - `attributeFilteringSyntax`: Boolean. False by default. If set to true,
	//     the `filter` field is interpreted according to the new,
	//     attribute-based syntax.
	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.v1alpha.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.v1alpha.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 (*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.v1alpha.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.v1alpha.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 (*RecommendResponse_RecommendationResult) GetId

func (*RecommendResponse_RecommendationResult) GetMetadata

func (*RecommendResponse_RecommendationResult) ProtoMessage

func (*RecommendResponse_RecommendationResult) ProtoReflect

func (*RecommendResponse_RecommendationResult) Reset

func (*RecommendResponse_RecommendationResult) 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.

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 RecrawlUrisMetadata

type RecrawlUrisMetadata 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"`
	// Unique URIs in the request that don't match any TargetSite in the
	// DataStore, only match TargetSites that haven't been fully indexed, or match
	// a TargetSite with type EXCLUDE.
	InvalidUris []string `protobuf:"bytes,3,rep,name=invalid_uris,json=invalidUris,proto3" json:"invalid_uris,omitempty"`
	// Total number of unique URIs in the request that are not in invalid_uris.
	ValidUrisCount int32 `protobuf:"varint,4,opt,name=valid_uris_count,json=validUrisCount,proto3" json:"valid_uris_count,omitempty"`
	// Total number of URIs that have been crawled so far.
	SuccessCount int32 `protobuf:"varint,5,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Total number of URIs that have yet to be crawled.
	PendingCount int32 `protobuf:"varint,6,opt,name=pending_count,json=pendingCount,proto3" json:"pending_count,omitempty"`
	// Total number of URIs that were rejected due to insufficient indexing
	// resources.
	QuotaExceededCount int32 `protobuf:"varint,7,opt,name=quota_exceeded_count,json=quotaExceededCount,proto3" json:"quota_exceeded_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*RecrawlUrisMetadata) Descriptor deprecated

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

Deprecated: Use RecrawlUrisMetadata.ProtoReflect.Descriptor instead.

func (*RecrawlUrisMetadata) GetCreateTime

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

func (*RecrawlUrisMetadata) GetInvalidUris

func (x *RecrawlUrisMetadata) GetInvalidUris() []string

func (*RecrawlUrisMetadata) GetPendingCount

func (x *RecrawlUrisMetadata) GetPendingCount() int32

func (*RecrawlUrisMetadata) GetQuotaExceededCount

func (x *RecrawlUrisMetadata) GetQuotaExceededCount() int32

func (*RecrawlUrisMetadata) GetSuccessCount

func (x *RecrawlUrisMetadata) GetSuccessCount() int32

func (*RecrawlUrisMetadata) GetUpdateTime

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

func (*RecrawlUrisMetadata) GetValidUrisCount

func (x *RecrawlUrisMetadata) GetValidUrisCount() int32

func (*RecrawlUrisMetadata) ProtoMessage

func (*RecrawlUrisMetadata) ProtoMessage()

func (*RecrawlUrisMetadata) ProtoReflect

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

func (*RecrawlUrisMetadata) Reset

func (x *RecrawlUrisMetadata) Reset()

func (*RecrawlUrisMetadata) String

func (x *RecrawlUrisMetadata) String() string

type RecrawlUrisRequest

type RecrawlUrisRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
	// an INVALID_ARGUMENT error is thrown. Each URI should match at least one
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in
	// `site_search_engine`.
	Uris []string `protobuf:"bytes,2,rep,name=uris,proto3" json:"uris,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] method.

func (*RecrawlUrisRequest) Descriptor deprecated

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

Deprecated: Use RecrawlUrisRequest.ProtoReflect.Descriptor instead.

func (*RecrawlUrisRequest) GetSiteSearchEngine

func (x *RecrawlUrisRequest) GetSiteSearchEngine() string

func (*RecrawlUrisRequest) GetUris

func (x *RecrawlUrisRequest) GetUris() []string

func (*RecrawlUrisRequest) ProtoMessage

func (*RecrawlUrisRequest) ProtoMessage()

func (*RecrawlUrisRequest) ProtoReflect

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

func (*RecrawlUrisRequest) Reset

func (x *RecrawlUrisRequest) Reset()

func (*RecrawlUrisRequest) String

func (x *RecrawlUrisRequest) String() string

type RecrawlUrisResponse

type RecrawlUrisResponse struct {

	// Details for a sample of up to 10 `failed_uris`.
	FailureSamples []*RecrawlUrisResponse_FailureInfo `protobuf:"bytes,1,rep,name=failure_samples,json=failureSamples,proto3" json:"failure_samples,omitempty"`
	// URIs that were not crawled before the LRO terminated.
	FailedUris []string `protobuf:"bytes,2,rep,name=failed_uris,json=failedUris,proto3" json:"failed_uris,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] method.

func (*RecrawlUrisResponse) Descriptor deprecated

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

Deprecated: Use RecrawlUrisResponse.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse) GetFailedUris

func (x *RecrawlUrisResponse) GetFailedUris() []string

func (*RecrawlUrisResponse) GetFailureSamples

func (x *RecrawlUrisResponse) GetFailureSamples() []*RecrawlUrisResponse_FailureInfo

func (*RecrawlUrisResponse) ProtoMessage

func (*RecrawlUrisResponse) ProtoMessage()

func (*RecrawlUrisResponse) ProtoReflect

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

func (*RecrawlUrisResponse) Reset

func (x *RecrawlUrisResponse) Reset()

func (*RecrawlUrisResponse) String

func (x *RecrawlUrisResponse) String() string

type RecrawlUrisResponse_FailureInfo

type RecrawlUrisResponse_FailureInfo struct {

	// URI that failed to be crawled.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// List of failure reasons by corpus type (e.g. desktop, mobile).
	FailureReasons []*RecrawlUrisResponse_FailureInfo_FailureReason `protobuf:"bytes,2,rep,name=failure_reasons,json=failureReasons,proto3" json:"failure_reasons,omitempty"`
	// contains filtered or unexported fields
}

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

func (*RecrawlUrisResponse_FailureInfo) Descriptor deprecated

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

Deprecated: Use RecrawlUrisResponse_FailureInfo.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse_FailureInfo) GetFailureReasons

func (*RecrawlUrisResponse_FailureInfo) GetUri

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage()

func (*RecrawlUrisResponse_FailureInfo) ProtoReflect

func (*RecrawlUrisResponse_FailureInfo) Reset

func (*RecrawlUrisResponse_FailureInfo) String

type RecrawlUrisResponse_FailureInfo_FailureReason

type RecrawlUrisResponse_FailureInfo_FailureReason struct {

	// DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
	CorpusType RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType `` /* 191-byte string literal not displayed */
	// Reason why the URI was not crawled.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

func (*RecrawlUrisResponse_FailureInfo_FailureReason) Descriptor deprecated

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect

func (*RecrawlUrisResponse_FailureInfo_FailureReason) Reset

func (*RecrawlUrisResponse_FailureInfo_FailureReason) String

type RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType

type RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType int32

CorpusType for the failed crawling operation.

const (
	// Default value.
	RecrawlUrisResponse_FailureInfo_FailureReason_CORPUS_TYPE_UNSPECIFIED RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 0
	// Denotes a crawling attempt for the desktop version of a page.
	RecrawlUrisResponse_FailureInfo_FailureReason_DESKTOP RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 1
	// Denotes a crawling attempt for the mobile version of a page.
	RecrawlUrisResponse_FailureInfo_FailureReason_MOBILE RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 2
)

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor deprecated

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.Descriptor instead.

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type

type Reply

type Reply struct {

	// DEPRECATED: use `summary` instead.
	// Text reply.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
	Reply string `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
	// References in the reply.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
	References []*Reply_Reference `protobuf:"bytes,2,rep,name=references,proto3" json:"references,omitempty"`
	// Summary based on search results.
	Summary *SearchResponse_Summary `protobuf:"bytes,3,opt,name=summary,proto3" json:"summary,omitempty"`
	// contains filtered or unexported fields
}

Defines a reply message to user.

func (*Reply) Descriptor deprecated

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

Deprecated: Use Reply.ProtoReflect.Descriptor instead.

func (*Reply) GetReferences deprecated

func (x *Reply) GetReferences() []*Reply_Reference

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.

func (*Reply) GetReply deprecated

func (x *Reply) GetReply() string

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.

func (*Reply) GetSummary

func (x *Reply) GetSummary() *SearchResponse_Summary

func (*Reply) ProtoMessage

func (*Reply) ProtoMessage()

func (*Reply) ProtoReflect

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

func (*Reply) Reset

func (x *Reply) Reset()

func (*Reply) String

func (x *Reply) String() string

type Reply_Reference deprecated

type Reply_Reference struct {

	// URI link reference.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Anchor text.
	AnchorText string `protobuf:"bytes,2,opt,name=anchor_text,json=anchorText,proto3" json:"anchor_text,omitempty"`
	// Anchor text start index.
	Start int32 `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`
	// Anchor text end index.
	End int32 `protobuf:"varint,4,opt,name=end,proto3" json:"end,omitempty"`
	// contains filtered or unexported fields
}

Defines reference in reply.

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.

func (*Reply_Reference) Descriptor deprecated

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

Deprecated: Use Reply_Reference.ProtoReflect.Descriptor instead.

func (*Reply_Reference) GetAnchorText

func (x *Reply_Reference) GetAnchorText() string

func (*Reply_Reference) GetEnd

func (x *Reply_Reference) GetEnd() int32

func (*Reply_Reference) GetStart

func (x *Reply_Reference) GetStart() int32

func (*Reply_Reference) GetUri

func (x *Reply_Reference) GetUri() string

func (*Reply_Reference) ProtoMessage

func (*Reply_Reference) ProtoMessage()

func (*Reply_Reference) ProtoReflect

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

func (*Reply_Reference) Reset

func (x *Reply_Reference) Reset()

func (*Reply_Reference) String

func (x *Reply_Reference) String() string

type ResumeEngineRequest

type ResumeEngineRequest struct {

	// Required. The name of the engine to resume.
	// Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for resuming training of an engine.

func (*ResumeEngineRequest) Descriptor deprecated

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

Deprecated: Use ResumeEngineRequest.ProtoReflect.Descriptor instead.

func (*ResumeEngineRequest) GetName

func (x *ResumeEngineRequest) GetName() string

func (*ResumeEngineRequest) ProtoMessage

func (*ResumeEngineRequest) ProtoMessage()

func (*ResumeEngineRequest) ProtoReflect

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

func (*ResumeEngineRequest) Reset

func (x *ResumeEngineRequest) Reset()

func (*ResumeEngineRequest) String

func (x *ResumeEngineRequest) String() string

type Schema

type Schema struct {

	// Schema representation. One of
	// [struct_schema][google.cloud.discoveryengine.v1alpha.Schema.struct_schema]
	// or [json_schema][google.cloud.discoveryengine.v1alpha.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"`
	// Output only. Configurations for fields of the schema.
	FieldConfigs []*FieldConfig `protobuf:"bytes,4,rep,name=field_configs,json=fieldConfigs,proto3" json:"field_configs,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Schema) Descriptor deprecated

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetFieldConfigs

func (x *Schema) GetFieldConfigs() []*FieldConfig

func (*Schema) GetJsonSchema

func (x *Schema) GetJsonSchema() string

func (*Schema) GetName

func (x *Schema) GetName() string

func (*Schema) GetSchema

func (m *Schema) GetSchema() isSchema_Schema

func (*Schema) GetStructSchema

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

func (*Schema) ProtoMessage

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect

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

func (*Schema) Reset

func (x *Schema) Reset()

func (*Schema) String

func (x *Schema) String() string

type SchemaServiceClient

type SchemaServiceClient interface {
	// Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
	GetSchema(ctx context.Context, in *GetSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
	// Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
	ListSchemas(ctx context.Context, in *ListSchemasRequest, opts ...grpc.CallOption) (*ListSchemasResponse, error)
	// Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
	CreateSchema(ctx context.Context, in *CreateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
	UpdateSchema(ctx context.Context, in *UpdateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Schema][google.cloud.discoveryengine.v1alpha.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.

type SchemaServiceServer

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

SchemaServiceServer is the server API for SchemaService service.

type Schema_JsonSchema

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

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 SearchAddOn

type SearchAddOn int32

Add-on that provides additional functionality for search.

const (
	// Default value when the enum is unspecified. This is invalid to use.
	SearchAddOn_SEARCH_ADD_ON_UNSPECIFIED SearchAddOn = 0
	// Large language model add-on.
	SearchAddOn_SEARCH_ADD_ON_LLM SearchAddOn = 1
)

func (SearchAddOn) Descriptor

func (SearchAddOn) Enum

func (x SearchAddOn) Enum() *SearchAddOn

func (SearchAddOn) EnumDescriptor deprecated

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

Deprecated: Use SearchAddOn.Descriptor instead.

func (SearchAddOn) Number

func (x SearchAddOn) Number() protoreflect.EnumNumber

func (SearchAddOn) String

func (x SearchAddOn) String() string

func (SearchAddOn) Type

type SearchInfo

type SearchInfo struct {

	// The user's search query.
	//
	// See
	// [SearchRequest.query][google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchInfo.search_query]
	// or
	// [PageInfo.page_category][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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

type SearchRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
	// or
	// `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"`
	// Raw image query.
	ImageQuery *SearchRequest_ImageQuery `protobuf:"bytes,19,opt,name=image_query,json=imageQuery,proto3" json:"image_query,omitempty"`
	// Maximum number of
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
	// unspecified, defaults to a reasonable value. The maximum allowed value is
	// 100. Values above 100 are 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.v1alpha.SearchService.Search]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]s deemed by the
	// API as relevant) in search results. This field is only considered if
	// [page_token][google.cloud.discoveryengine.v1alpha.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"`
	// A list of data store specs to apply on a search call.
	DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,32,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,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.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
	// key property defined in the Vertex AI Search backend -- this mapping is
	// defined by the customer in their schema. For example a media customer might
	// have a field 'name' in their schema. In this case the filter would look
	// like this: filter --> name:'ANY("king kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,7,opt,name=filter,proto3" json:"filter,omitempty"`
	// The default filter that is applied when a user performs a search without
	// checking any filters on the search page.
	//
	// The filter applied to every search request when quality improvement such as
	// query expansion is needed. In the case a query does not have a sufficient
	// amount of results this filter will be used to determine whether or not to
	// enable the query expansion flow. The original filter will still be used for
	// the query expanded search.
	// This field is strongly recommended to achieve high search quality.
	//
	// For more information about filter syntax, see
	// [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter].
	CanonicalFilter string `protobuf:"bytes,29,opt,name=canonical_filter,json=canonicalFilter,proto3" json:"canonical_filter,omitempty"`
	// The order in which documents are returned. Documents can be ordered by
	// a field in an [Document][google.cloud.discoveryengine.v1alpha.Document]
	// object. Leave it unset if ordered by relevance. `order_by` expression is
	// case-sensitive. For more information on ordering, see
	// [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
	//
	// 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.
	// [UserInfo.user_agent][google.cloud.discoveryengine.v1alpha.UserInfo.user_agent]
	// is 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.
	// For more information on boosting, see
	// [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	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.
	//     Example:
	//     user_country_code: "au"
	//
	//     For available codes see [Country
	//     Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
	//
	//   - `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.
	//     Example:
	//     search_type: 1
	Params map[string]*structpb.Value `` /* 154-byte string literal not displayed */
	// The query expansion specification that specifies the conditions under which
	// query expansion occurs.
	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 takes 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.v1alpha.UserEvent.user_pseudo_id]
	// and
	// [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.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"`
	// A specification for configuring the behavior of content search.
	ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,24,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
	// Uses the provided embedding to do additional semantic document retrieval.
	// The retrieval is based on the dot product of
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// and the document embedding that is provided in
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].
	//
	// If
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
	// is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
	EmbeddingSpec *SearchRequest_EmbeddingSpec `protobuf:"bytes,23,opt,name=embedding_spec,json=embeddingSpec,proto3" json:"embedding_spec,omitempty"`
	// The ranking expression controls the customized ranking on retrieval
	// documents. This overrides
	// [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression].
	// The ranking expression is a single function or multiple functions that are
	// joint by "+".
	//   - ranking_expression = function, { " + ", function };
	//
	// Supported functions:
	//   - double * relevance_score
	//   - double * dotProduct(embedding_field_path)
	//
	// Function variables:
	//
	//	 `relevance_score`: pre-defined keywords, used for measure relevance
	//	 between query and document.
	//	 `embedding_field_path`: the document embedding field
	//	 used with query embedding vector.
	//	 `dotProduct`: embedding function between embedding_field_path and query
	//	 embedding vector.
	//
	//	Example ranking expression:
	//	  If document has an embedding field doc_embedding, the ranking expression
	//	  could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
	RankingExpression string `protobuf:"bytes,26,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
	// Whether to turn on safe search. This is only supported for
	// website search.
	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 */
	// Custom fine tuning configs.
	CustomFineTuningSpec *CustomFineTuningSpec `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*SearchRequest) Descriptor deprecated

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBoostSpec

func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*SearchRequest) GetBranch

func (x *SearchRequest) GetBranch() string

func (*SearchRequest) GetCanonicalFilter added in v1.4.0

func (x *SearchRequest) GetCanonicalFilter() string

func (*SearchRequest) GetContentSearchSpec

func (x *SearchRequest) GetContentSearchSpec() *SearchRequest_ContentSearchSpec

func (*SearchRequest) GetCustomFineTuningSpec added in v1.6.0

func (x *SearchRequest) GetCustomFineTuningSpec() *CustomFineTuningSpec

func (*SearchRequest) GetDataStoreSpecs added in v1.6.0

func (x *SearchRequest) GetDataStoreSpecs() []*SearchRequest_DataStoreSpec

func (*SearchRequest) GetEmbeddingSpec

func (x *SearchRequest) GetEmbeddingSpec() *SearchRequest_EmbeddingSpec

func (*SearchRequest) GetFacetSpecs

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

func (*SearchRequest) GetFilter

func (x *SearchRequest) GetFilter() string

func (*SearchRequest) GetImageQuery

func (x *SearchRequest) GetImageQuery() *SearchRequest_ImageQuery

func (*SearchRequest) GetOffset

func (x *SearchRequest) GetOffset() int32

func (*SearchRequest) GetOrderBy

func (x *SearchRequest) GetOrderBy() string

func (*SearchRequest) GetPageSize

func (x *SearchRequest) GetPageSize() int32

func (*SearchRequest) GetPageToken

func (x *SearchRequest) GetPageToken() string

func (*SearchRequest) GetParams

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

func (*SearchRequest) GetQuery

func (x *SearchRequest) GetQuery() string

func (*SearchRequest) GetQueryExpansionSpec

func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpec

func (*SearchRequest) GetRankingExpression

func (x *SearchRequest) GetRankingExpression() string

func (*SearchRequest) GetSafeSearch

func (x *SearchRequest) GetSafeSearch() bool

func (*SearchRequest) GetServingConfig

func (x *SearchRequest) GetServingConfig() string

func (*SearchRequest) GetSpellCorrectionSpec

func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpec

func (*SearchRequest) GetUserInfo

func (x *SearchRequest) GetUserInfo() *UserInfo

func (*SearchRequest) GetUserLabels

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

func (*SearchRequest) GetUserPseudoId

func (x *SearchRequest) GetUserPseudoId() string

func (*SearchRequest) ProtoMessage

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect

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

func (*SearchRequest) Reset

func (x *SearchRequest) Reset()

func (*SearchRequest) String

func (x *SearchRequest) String() string

type SearchRequest_BoostSpec

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

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

Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec) GetConditionBoostSpecs

func (*SearchRequest_BoostSpec) ProtoMessage

func (*SearchRequest_BoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec) ProtoReflect

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

func (*SearchRequest_BoostSpec) Reset

func (x *SearchRequest_BoostSpec) Reset()

func (*SearchRequest_BoostSpec) String

func (x *SearchRequest_BoostSpec) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec

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.v1alpha.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost documents with document ID "doc_1" or "doc_2", and
	// color "Red" or "Blue":
	// `(document_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

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset

func (*SearchRequest_BoostSpec_ConditionBoostSpec) String

type SearchRequest_ContentSearchSpec

type SearchRequest_ContentSearchSpec struct {

	// If `snippetSpec` is not specified, snippets are not included in the
	// search response.
	SnippetSpec *SearchRequest_ContentSearchSpec_SnippetSpec `protobuf:"bytes,1,opt,name=snippet_spec,json=snippetSpec,proto3" json:"snippet_spec,omitempty"`
	// If `summarySpec` is not specified, summaries are not included in the
	// search response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,2,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
	// If there is no extractive_content_spec provided, there will be no
	// extractive answer in the search response.
	ExtractiveContentSpec *SearchRequest_ContentSearchSpec_ExtractiveContentSpec `` /* 126-byte string literal not displayed */
	// Specifies the search result mode. If unspecified, the
	// search result mode is based on
	// [DataStore.DocumentProcessingConfig.chunking_config][]:
	//   - If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
	//     it defaults to `CHUNKS`.
	//   - Otherwise, it defaults to `DOCUMENTS`.
	SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `` /* 203-byte string literal not displayed */
	// contains filtered or unexported fields
}

A specification for configuring the behavior of content search.

func (*SearchRequest_ContentSearchSpec) Descriptor deprecated

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

Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec) GetExtractiveContentSpec

func (*SearchRequest_ContentSearchSpec) GetSearchResultMode added in v1.6.0

func (*SearchRequest_ContentSearchSpec) GetSnippetSpec

func (*SearchRequest_ContentSearchSpec) GetSummarySpec

func (*SearchRequest_ContentSearchSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec) Reset

func (*SearchRequest_ContentSearchSpec) String

type SearchRequest_ContentSearchSpec_ExtractiveContentSpec

type SearchRequest_ContentSearchSpec_ExtractiveContentSpec struct {

	// The maximum number of extractive answers returned in each search
	// result.
	//
	// An extractive answer is a verbatim answer extracted from the original
	// document, which provides a precise and contextually relevant answer to
	// the search query.
	//
	// If the number of matching answers is less than the
	// `max_extractive_answer_count`, return all of the answers. Otherwise,
	// return the `max_extractive_answer_count`.
	//
	// At most five answers are returned for each
	// [SearchResult][google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult].
	MaxExtractiveAnswerCount int32 `` /* 138-byte string literal not displayed */
	// The max number of extractive segments returned in each search result.
	// Only applied if the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is set to
	// [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.CONTENT_REQUIRED]
	// or
	// [DataStore.solution_types][google.cloud.discoveryengine.v1alpha.DataStore.solution_types]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
	//
	// An extractive segment is a text segment extracted from the original
	// document that is relevant to the search query, and, in general, more
	// verbose than an extractive answer. The segment could then be used as
	// input for LLMs to generate summaries and answers.
	//
	// If the number of matching segments is less than
	// `max_extractive_segment_count`, return all of the segments. Otherwise,
	// return the `max_extractive_segment_count`.
	MaxExtractiveSegmentCount int32 `` /* 141-byte string literal not displayed */
	// Specifies whether to return the confidence score from the extractive
	// segments in each search result. The default value is `false`.
	//
	// Note: this is a priavte preview feature and only works for allowlisted
	// users, please reach out to Cloud Support team if you want to use it.
	ReturnExtractiveSegmentScore bool `` /* 150-byte string literal not displayed */
	// Specifies whether to also include the adjacent from each selected
	// segments.
	// Return at most `num_previous_segments` segments before each selected
	// segments.
	NumPreviousSegments int32 `protobuf:"varint,4,opt,name=num_previous_segments,json=numPreviousSegments,proto3" json:"num_previous_segments,omitempty"`
	// Return at most `num_next_segments` segments after each selected
	// segments.
	NumNextSegments int32 `protobuf:"varint,5,opt,name=num_next_segments,json=numNextSegments,proto3" json:"num_next_segments,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring the extractive content in a search response.

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor deprecated

Deprecated: Use SearchRequest_ContentSearchSpec_ExtractiveContentSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore() bool

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String

type SearchRequest_ContentSearchSpec_SearchResultMode added in v1.6.0

type SearchRequest_ContentSearchSpec_SearchResultMode int32

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to `CHUNKS`.
  • Otherwise, it defaults to `DOCUMENTS`.
const (
	// Default value.
	SearchRequest_ContentSearchSpec_SEARCH_RESULT_MODE_UNSPECIFIED SearchRequest_ContentSearchSpec_SearchResultMode = 0
	// Returns documents in the search result.
	SearchRequest_ContentSearchSpec_DOCUMENTS SearchRequest_ContentSearchSpec_SearchResultMode = 1
	// Returns chunks in the search result. Only available if the
	// [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
	SearchRequest_ContentSearchSpec_CHUNKS SearchRequest_ContentSearchSpec_SearchResultMode = 2
)

func (SearchRequest_ContentSearchSpec_SearchResultMode) Descriptor added in v1.6.0

func (SearchRequest_ContentSearchSpec_SearchResultMode) Enum added in v1.6.0

func (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor deprecated added in v1.6.0

Deprecated: Use SearchRequest_ContentSearchSpec_SearchResultMode.Descriptor instead.

func (SearchRequest_ContentSearchSpec_SearchResultMode) Number added in v1.6.0

func (SearchRequest_ContentSearchSpec_SearchResultMode) String added in v1.6.0

func (SearchRequest_ContentSearchSpec_SearchResultMode) Type added in v1.6.0

type SearchRequest_ContentSearchSpec_SnippetSpec

type SearchRequest_ContentSearchSpec_SnippetSpec struct {

	// [DEPRECATED] This field is deprecated. To control snippet return, use
	// `return_snippet` field. For backwards compatibility, we will return
	// snippet if max_snippet_count > 0.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
	MaxSnippetCount int32 `protobuf:"varint,1,opt,name=max_snippet_count,json=maxSnippetCount,proto3" json:"max_snippet_count,omitempty"`
	// [DEPRECATED] This field is deprecated and will have no affect on the
	// snippet.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
	ReferenceOnly bool `protobuf:"varint,2,opt,name=reference_only,json=referenceOnly,proto3" json:"reference_only,omitempty"`
	// If `true`, then return snippet. If no snippet can be generated, we
	// return "No snippet is available for this page." A `snippet_status` with
	// `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
	ReturnSnippet bool `protobuf:"varint,3,opt,name=return_snippet,json=returnSnippet,proto3" json:"return_snippet,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring snippets in a search response.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor deprecated

Deprecated: Use SearchRequest_ContentSearchSpec_SnippetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount deprecated

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount() int32

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly deprecated

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() bool

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet() bool

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset

func (*SearchRequest_ContentSearchSpec_SnippetSpec) String

type SearchRequest_ContentSearchSpec_SummarySpec

type SearchRequest_ContentSearchSpec_SummarySpec struct {

	// The number of top results to generate the summary from. If the number
	// of results returned is less than `summaryResultCount`, the summary is
	// generated from all of the results.
	//
	// At most 10 results can be used to generate a summary.
	SummaryResultCount int32 `protobuf:"varint,1,opt,name=summary_result_count,json=summaryResultCount,proto3" json:"summary_result_count,omitempty"`
	// Specifies whether to include citations in the summary. The default
	// value is `false`.
	//
	// When this field is set to `true`, summaries include in-line citation
	// numbers.
	//
	// Example summary including citations:
	//
	// BigQuery is Google Cloud's fully managed and completely serverless
	// enterprise data warehouse [1]. BigQuery supports all data types, works
	// across clouds, and has built-in machine learning and business
	// intelligence, all within a unified platform [2, 3].
	//
	// The citation numbers refer to the returned search results and are
	// 1-indexed. For example, [1] means that the sentence is attributed to
	// the first search result. [2, 3] means that the sentence is attributed
	// to both the second and third search results.
	IncludeCitations bool `protobuf:"varint,2,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
	// Specifies whether to filter out adversarial queries. The default value
	// is `false`.
	//
	// Google employs search-query classification to detect adversarial
	// queries. No summary is returned if the search query is classified as an
	// adversarial query. For example, a user might ask a question regarding
	// negative comments about the company or submit a query designed to
	// generate unsafe, policy-violating output. If this field is set to
	// `true`, we skip generating summaries for adversarial queries and return
	// fallback messages instead.
	IgnoreAdversarialQuery bool `` /* 130-byte string literal not displayed */
	// Specifies whether to filter out queries that are not summary-seeking.
	// The default value is `false`.
	//
	// Google employs search-query classification to detect summary-seeking
	// queries. No summary is returned if the search query is classified as a
	// non-summary seeking query. For example, `why is the sky blue` and `Who
	// is the best soccer player in the world?` are summary-seeking queries,
	// but `SFO airport` and `world cup 2026` are not. They are most likely
	// navigational queries. If this field is set to `true`, we skip
	// generating summaries for non-summary seeking queries and return
	// fallback messages instead.
	IgnoreNonSummarySeekingQuery bool `` /* 152-byte string literal not displayed */
	// If specified, the spec will be used to modify the prompt provided to
	// the LLM.
	ModelPromptSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec `protobuf:"bytes,5,opt,name=model_prompt_spec,json=modelPromptSpec,proto3" json:"model_prompt_spec,omitempty"`
	// Language code for Summary. Use language tags defined by
	// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
	// Note: This is an experimental feature.
	LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// If specified, the spec will be used to modify the model specification
	// provided to the LLM.
	ModelSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec `protobuf:"bytes,7,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring a summary returned in a search response.

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor deprecated

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount() int32

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SummarySpec) Reset

func (*SearchRequest_ContentSearchSpec_SummarySpec) String

type SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec added in v1.4.0

type SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec struct {

	// Text at the beginning of the prompt that instructs the assistant.
	// Examples are available in the user guide.
	Preamble string `protobuf:"bytes,1,opt,name=preamble,proto3" json:"preamble,omitempty"`
	// contains filtered or unexported fields
}

Specification of the prompt to use with the model.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Descriptor deprecated added in v1.4.0

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String added in v1.4.0

type SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec added in v1.4.0

type SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec struct {

	// The model version used to generate the summary.
	//
	// Supported values are:
	//
	//   - `stable`: string. Default value when no value is specified. Uses a
	//     generally available, fine-tuned version of the text-bison@001
	//     model.
	//   - `preview`: string. (Public preview) Uses a fine-tuned version of
	//     the text-bison@002 model. This model works only for summaries in
	//     English.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Specification of the model.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Descriptor deprecated added in v1.4.0

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset added in v1.4.0

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String added in v1.4.0

type SearchRequest_DataStoreSpec added in v1.6.0

type SearchRequest_DataStoreSpec struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

A struct to define data stores to filter on in a search call.

func (*SearchRequest_DataStoreSpec) Descriptor deprecated added in v1.6.0

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

Deprecated: Use SearchRequest_DataStoreSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_DataStoreSpec) GetDataStore added in v1.6.0

func (x *SearchRequest_DataStoreSpec) GetDataStore() string

func (*SearchRequest_DataStoreSpec) ProtoMessage added in v1.6.0

func (*SearchRequest_DataStoreSpec) ProtoMessage()

func (*SearchRequest_DataStoreSpec) ProtoReflect added in v1.6.0

func (*SearchRequest_DataStoreSpec) Reset added in v1.6.0

func (x *SearchRequest_DataStoreSpec) Reset()

func (*SearchRequest_DataStoreSpec) String added in v1.6.0

func (x *SearchRequest_DataStoreSpec) String() string

type SearchRequest_EmbeddingSpec

type SearchRequest_EmbeddingSpec struct {

	// The embedding vector used for retrieval. Limit to 1.
	EmbeddingVectors []*SearchRequest_EmbeddingSpec_EmbeddingVector `protobuf:"bytes,1,rep,name=embedding_vectors,json=embeddingVectors,proto3" json:"embedding_vectors,omitempty"`
	// contains filtered or unexported fields
}

The specification that uses customized query embedding vector to do semantic document retrieval.

func (*SearchRequest_EmbeddingSpec) Descriptor deprecated

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

Deprecated: Use SearchRequest_EmbeddingSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_EmbeddingSpec) GetEmbeddingVectors

func (*SearchRequest_EmbeddingSpec) ProtoMessage

func (*SearchRequest_EmbeddingSpec) ProtoMessage()

func (*SearchRequest_EmbeddingSpec) ProtoReflect

func (*SearchRequest_EmbeddingSpec) Reset

func (x *SearchRequest_EmbeddingSpec) Reset()

func (*SearchRequest_EmbeddingSpec) String

func (x *SearchRequest_EmbeddingSpec) String() string

type SearchRequest_EmbeddingSpec_EmbeddingVector

type SearchRequest_EmbeddingSpec_EmbeddingVector struct {

	// Embedding field path in schema.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
	// Query embedding vector.
	Vector []float32 `protobuf:"fixed32,2,rep,packed,name=vector,proto3" json:"vector,omitempty"`
	// contains filtered or unexported fields
}

Embedding vector.

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor deprecated

Deprecated: Use SearchRequest_EmbeddingSpec_EmbeddingVector.ProtoReflect.Descriptor instead.

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Reset

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) String

type SearchRequest_FacetSpec

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 are 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.v1alpha.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.v1alpha.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.
	// If dynamic facets are enabled, it is ordered together.
	// If set to false, the position of this facet in the
	// response is the same as in the request, and it is 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 is 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 enabled, which generates 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" are always
	// ranked at first and second position because their enable_dynamic_position
	// is 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

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

Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec) GetEnableDynamicPosition

func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() bool

func (*SearchRequest_FacetSpec) GetExcludedFilterKeys

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

func (*SearchRequest_FacetSpec) GetFacetKey

func (*SearchRequest_FacetSpec) GetLimit

func (x *SearchRequest_FacetSpec) GetLimit() int32

func (*SearchRequest_FacetSpec) ProtoMessage

func (*SearchRequest_FacetSpec) ProtoMessage()

func (*SearchRequest_FacetSpec) ProtoReflect

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

func (*SearchRequest_FacetSpec) Reset

func (x *SearchRequest_FacetSpec) Reset()

func (*SearchRequest_FacetSpec) String

func (x *SearchRequest_FacetSpec) String() string

type SearchRequest_FacetSpec_FacetKey

type SearchRequest_FacetSpec_FacetKey struct {

	// Required. Supported textual and numerical facet keys in
	// [Document][google.cloud.discoveryengine.v1alpha.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 bucketed 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 only
	// contains "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 only contains "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 only contains "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.v1alpha.SearchResponse.Facet.FacetValue.count]
	// descending.
	//
	// * "value desc", which means order by
	// [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.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

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

Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive

func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() bool

func (*SearchRequest_FacetSpec_FacetKey) GetContains

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

func (*SearchRequest_FacetSpec_FacetKey) GetIntervals

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

func (*SearchRequest_FacetSpec_FacetKey) GetKey

func (*SearchRequest_FacetSpec_FacetKey) GetOrderBy

func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string

func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes

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

func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues

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

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()

func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect

func (*SearchRequest_FacetSpec_FacetKey) Reset

func (*SearchRequest_FacetSpec_FacetKey) String

type SearchRequest_ImageQuery

type SearchRequest_ImageQuery struct {

	// Types that are assignable to Image:
	//
	//	*SearchRequest_ImageQuery_ImageBytes
	Image isSearchRequest_ImageQuery_Image `protobuf_oneof:"image"`
	// contains filtered or unexported fields
}

Specifies the image query input.

func (*SearchRequest_ImageQuery) Descriptor deprecated

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

Deprecated: Use SearchRequest_ImageQuery.ProtoReflect.Descriptor instead.

func (*SearchRequest_ImageQuery) GetImage

func (m *SearchRequest_ImageQuery) GetImage() isSearchRequest_ImageQuery_Image

func (*SearchRequest_ImageQuery) GetImageBytes

func (x *SearchRequest_ImageQuery) GetImageBytes() string

func (*SearchRequest_ImageQuery) ProtoMessage

func (*SearchRequest_ImageQuery) ProtoMessage()

func (*SearchRequest_ImageQuery) ProtoReflect

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

func (*SearchRequest_ImageQuery) Reset

func (x *SearchRequest_ImageQuery) Reset()

func (*SearchRequest_ImageQuery) String

func (x *SearchRequest_ImageQuery) String() string

type SearchRequest_ImageQuery_ImageBytes

type SearchRequest_ImageQuery_ImageBytes struct {
	// Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
	// BMP.
	ImageBytes string `protobuf:"bytes,1,opt,name=image_bytes,json=imageBytes,proto3,oneof"`
}

type SearchRequest_QueryExpansionSpec

type SearchRequest_QueryExpansionSpec struct {

	// The condition under which query expansion should occur. Default to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	Condition SearchRequest_QueryExpansionSpec_Condition `` /* 157-byte string literal not displayed */
	// Whether to pin unexpanded results. If this field is set to true,
	// unexpanded products are always at the top of the search results, followed
	// by the expanded results.
	PinUnexpandedResults bool `protobuf:"varint,2,opt,name=pin_unexpanded_results,json=pinUnexpandedResults,proto3" json:"pin_unexpanded_results,omitempty"`
	// contains filtered or unexported fields
}

Specification to determine under which conditions query expansion should occur.

func (*SearchRequest_QueryExpansionSpec) Descriptor deprecated

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

Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_QueryExpansionSpec) GetCondition

func (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults

func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() bool

func (*SearchRequest_QueryExpansionSpec) ProtoMessage

func (*SearchRequest_QueryExpansionSpec) ProtoMessage()

func (*SearchRequest_QueryExpansionSpec) ProtoReflect

func (*SearchRequest_QueryExpansionSpec) Reset

func (*SearchRequest_QueryExpansionSpec) String

type SearchRequest_QueryExpansionSpec_Condition

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.v1alpha.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.v1alpha.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

func (SearchRequest_QueryExpansionSpec_Condition) Enum

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor deprecated

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

Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.

func (SearchRequest_QueryExpansionSpec_Condition) Number

func (SearchRequest_QueryExpansionSpec_Condition) String

func (SearchRequest_QueryExpansionSpec_Condition) Type

type SearchRequest_SpellCorrectionSpec

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.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	Mode SearchRequest_SpellCorrectionSpec_Mode `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

The specification for query spell correction.

func (*SearchRequest_SpellCorrectionSpec) Descriptor deprecated

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

Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SpellCorrectionSpec) GetMode

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()

func (*SearchRequest_SpellCorrectionSpec) ProtoReflect

func (*SearchRequest_SpellCorrectionSpec) Reset

func (*SearchRequest_SpellCorrectionSpec) String

type SearchRequest_SpellCorrectionSpec_Mode

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.v1alpha.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.v1alpha.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

func (SearchRequest_SpellCorrectionSpec_Mode) Enum

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor deprecated

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

Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.

func (SearchRequest_SpellCorrectionSpec_Mode) Number

func (SearchRequest_SpellCorrectionSpec_Mode) String

func (SearchRequest_SpellCorrectionSpec_Mode) Type

type SearchResponse

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.v1alpha.SearchResponse.results]
	// returned by pagination may be less than the
	// [total_size][google.cloud.discoveryengine.v1alpha.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.v1alpha.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"`
	// The URI of a customer-defined redirect page. If redirect action is
	// triggered, no search is performed, and only
	// [redirect_uri][google.cloud.discoveryengine.v1alpha.SearchResponse.redirect_uri]
	// and
	// [attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token]
	// are set in the response.
	RedirectUri string `protobuf:"bytes,12,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// A token that can be sent as
	// [SearchRequest.page_token][google.cloud.discoveryengine.v1alpha.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.v1alpha.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"`
	GeoSearchDebugInfo []*SearchResponse_GeoSearchDebugInfo `protobuf:"bytes,16,rep,name=geo_search_debug_info,json=geoSearchDebugInfo,proto3" json:"geo_search_debug_info,omitempty"`
	// Query expansion information for the returned results.
	QueryExpansionInfo *SearchResponse_QueryExpansionInfo `protobuf:"bytes,14,opt,name=query_expansion_info,json=queryExpansionInfo,proto3" json:"query_expansion_info,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchResponse) Descriptor deprecated

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetAppliedControls

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

func (*SearchResponse) GetAttributionToken

func (x *SearchResponse) GetAttributionToken() string

func (*SearchResponse) GetCorrectedQuery

func (x *SearchResponse) GetCorrectedQuery() string

func (*SearchResponse) GetFacets

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

func (*SearchResponse) GetGeoSearchDebugInfo

func (x *SearchResponse) GetGeoSearchDebugInfo() []*SearchResponse_GeoSearchDebugInfo

func (*SearchResponse) GetGuidedSearchResult

func (x *SearchResponse) GetGuidedSearchResult() *SearchResponse_GuidedSearchResult

func (*SearchResponse) GetNextPageToken

func (x *SearchResponse) GetNextPageToken() string

func (*SearchResponse) GetQueryExpansionInfo

func (x *SearchResponse) GetQueryExpansionInfo() *SearchResponse_QueryExpansionInfo

func (*SearchResponse) GetRedirectUri

func (x *SearchResponse) GetRedirectUri() string

func (*SearchResponse) GetResults

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

func (*SearchResponse) GetSummary

func (x *SearchResponse) GetSummary() *SearchResponse_Summary

func (*SearchResponse) GetTotalSize

func (x *SearchResponse) GetTotalSize() int32

func (*SearchResponse) ProtoMessage

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect

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

func (*SearchResponse) Reset

func (x *SearchResponse) Reset()

func (*SearchResponse) String

func (x *SearchResponse) String() string

type SearchResponse_Facet

type SearchResponse_Facet struct {

	// The key for this facet. E.g., "colors" or "price". It matches
	// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1alpha.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

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

Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet) GetDynamicFacet

func (x *SearchResponse_Facet) GetDynamicFacet() bool

func (*SearchResponse_Facet) GetKey

func (x *SearchResponse_Facet) GetKey() string

func (*SearchResponse_Facet) GetValues

func (*SearchResponse_Facet) ProtoMessage

func (*SearchResponse_Facet) ProtoMessage()

func (*SearchResponse_Facet) ProtoReflect

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

func (*SearchResponse_Facet) Reset

func (x *SearchResponse_Facet) Reset()

func (*SearchResponse_Facet) String

func (x *SearchResponse_Facet) String() string

type SearchResponse_Facet_FacetValue

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

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

Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet_FacetValue) GetCount

func (x *SearchResponse_Facet_FacetValue) GetCount() int64

func (*SearchResponse_Facet_FacetValue) GetFacetValue

func (m *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValue

func (*SearchResponse_Facet_FacetValue) GetInterval

func (x *SearchResponse_Facet_FacetValue) GetInterval() *Interval

func (*SearchResponse_Facet_FacetValue) GetValue

func (*SearchResponse_Facet_FacetValue) ProtoMessage

func (*SearchResponse_Facet_FacetValue) ProtoMessage()

func (*SearchResponse_Facet_FacetValue) ProtoReflect

func (*SearchResponse_Facet_FacetValue) Reset

func (*SearchResponse_Facet_FacetValue) String

type SearchResponse_Facet_FacetValue_Interval

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.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals].
	Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}

type SearchResponse_Facet_FacetValue_Value

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_GeoSearchDebugInfo

type SearchResponse_GeoSearchDebugInfo struct {

	// The address from which forward geocoding ingestion produced issues.
	OriginalAddressQuery string `protobuf:"bytes,1,opt,name=original_address_query,json=originalAddressQuery,proto3" json:"original_address_query,omitempty"`
	// The error produced.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

func (*SearchResponse_GeoSearchDebugInfo) Descriptor deprecated

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

Deprecated: Use SearchResponse_GeoSearchDebugInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_GeoSearchDebugInfo) GetErrorMessage

func (x *SearchResponse_GeoSearchDebugInfo) GetErrorMessage() string

func (*SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery

func (x *SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery() string

func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage

func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage()

func (*SearchResponse_GeoSearchDebugInfo) ProtoReflect

func (*SearchResponse_GeoSearchDebugInfo) Reset

func (*SearchResponse_GeoSearchDebugInfo) String

type SearchResponse_GuidedSearchResult

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"`
	// Suggested follow-up questions.
	FollowUpQuestions []string `protobuf:"bytes,2,rep,name=follow_up_questions,json=followUpQuestions,proto3" json:"follow_up_questions,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

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

Deprecated: Use SearchResponse_GuidedSearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult) GetFollowUpQuestions

func (x *SearchResponse_GuidedSearchResult) GetFollowUpQuestions() []string

func (*SearchResponse_GuidedSearchResult) GetRefinementAttributes

func (*SearchResponse_GuidedSearchResult) ProtoMessage

func (*SearchResponse_GuidedSearchResult) ProtoMessage()

func (*SearchResponse_GuidedSearchResult) ProtoReflect

func (*SearchResponse_GuidedSearchResult) Reset

func (*SearchResponse_GuidedSearchResult) String

type SearchResponse_GuidedSearchResult_RefinementAttribute

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

Deprecated: Use SearchResponse_GuidedSearchResult_RefinementAttribute.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Reset

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) String

type SearchResponse_QueryExpansionInfo

type SearchResponse_QueryExpansionInfo struct {

	// Bool describing whether query expansion has occurred.
	ExpandedQuery bool `protobuf:"varint,1,opt,name=expanded_query,json=expandedQuery,proto3" json:"expanded_query,omitempty"`
	// Number of pinned results. This field will only be set when expansion
	// happens and
	// [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
	// is set to true.
	PinnedResultCount int64 `protobuf:"varint,2,opt,name=pinned_result_count,json=pinnedResultCount,proto3" json:"pinned_result_count,omitempty"`
	// contains filtered or unexported fields
}

Information describing query expansion including whether expansion has occurred.

func (*SearchResponse_QueryExpansionInfo) Descriptor deprecated

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

Deprecated: Use SearchResponse_QueryExpansionInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_QueryExpansionInfo) GetExpandedQuery

func (x *SearchResponse_QueryExpansionInfo) GetExpandedQuery() bool

func (*SearchResponse_QueryExpansionInfo) GetPinnedResultCount

func (x *SearchResponse_QueryExpansionInfo) GetPinnedResultCount() int64

func (*SearchResponse_QueryExpansionInfo) ProtoMessage

func (*SearchResponse_QueryExpansionInfo) ProtoMessage()

func (*SearchResponse_QueryExpansionInfo) ProtoReflect

func (*SearchResponse_QueryExpansionInfo) Reset

func (*SearchResponse_QueryExpansionInfo) String

type SearchResponse_SearchResult

type SearchResponse_SearchResult struct {

	// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] of the
	// searched [Document][google.cloud.discoveryengine.v1alpha.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"`
	// The chunk data in the search response if the
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
	Chunk *Chunk `protobuf:"bytes,18,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Google provided available scores.
	ModelScores map[string]*DoubleList `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents the search results.

func (*SearchResponse_SearchResult) Descriptor deprecated

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

Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchResult) GetChunk added in v1.6.0

func (x *SearchResponse_SearchResult) GetChunk() *Chunk

func (*SearchResponse_SearchResult) GetDocument

func (x *SearchResponse_SearchResult) GetDocument() *Document

func (*SearchResponse_SearchResult) GetId

func (*SearchResponse_SearchResult) GetModelScores

func (x *SearchResponse_SearchResult) GetModelScores() map[string]*DoubleList

func (*SearchResponse_SearchResult) ProtoMessage

func (*SearchResponse_SearchResult) ProtoMessage()

func (*SearchResponse_SearchResult) ProtoReflect

func (*SearchResponse_SearchResult) Reset

func (x *SearchResponse_SearchResult) Reset()

func (*SearchResponse_SearchResult) String

func (x *SearchResponse_SearchResult) String() string

type SearchResponse_Summary

type SearchResponse_Summary struct {

	// The summary content.
	SummaryText string `protobuf:"bytes,1,opt,name=summary_text,json=summaryText,proto3" json:"summary_text,omitempty"`
	// Additional summary-skipped reasons. This provides the reason for ignored
	// cases. If nothing is skipped, this field is not set.
	SummarySkippedReasons []SearchResponse_Summary_SummarySkippedReason `` /* 220-byte string literal not displayed */
	// A collection of Safety Attribute categories and their associated
	// confidence scores.
	SafetyAttributes *SearchResponse_Summary_SafetyAttributes `protobuf:"bytes,3,opt,name=safety_attributes,json=safetyAttributes,proto3" json:"safety_attributes,omitempty"`
	// Summary with metadata information.
	SummaryWithMetadata *SearchResponse_Summary_SummaryWithMetadata `protobuf:"bytes,4,opt,name=summary_with_metadata,json=summaryWithMetadata,proto3" json:"summary_with_metadata,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchResponse_Summary) Descriptor deprecated

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

Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary) GetSafetyAttributes

func (*SearchResponse_Summary) GetSummarySkippedReasons

func (*SearchResponse_Summary) GetSummaryText

func (x *SearchResponse_Summary) GetSummaryText() string

func (*SearchResponse_Summary) GetSummaryWithMetadata added in v1.4.0

func (*SearchResponse_Summary) ProtoMessage

func (*SearchResponse_Summary) ProtoMessage()

func (*SearchResponse_Summary) ProtoReflect

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

func (*SearchResponse_Summary) Reset

func (x *SearchResponse_Summary) Reset()

func (*SearchResponse_Summary) String

func (x *SearchResponse_Summary) String() string

type SearchResponse_Summary_Citation added in v1.4.0

type SearchResponse_Summary_Citation struct {

	// Index indicates the start of the segment, measured in bytes/unicode.
	StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// End of the attributed segment, exclusive.
	EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// Citation sources for the attributed segment.
	Sources []*SearchResponse_Summary_CitationSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
	// contains filtered or unexported fields
}

Citation info for a segment.

func (*SearchResponse_Summary_Citation) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SearchResponse_Summary_Citation.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Citation) GetEndIndex added in v1.4.0

func (x *SearchResponse_Summary_Citation) GetEndIndex() int64

func (*SearchResponse_Summary_Citation) GetSources added in v1.4.0

func (*SearchResponse_Summary_Citation) GetStartIndex added in v1.4.0

func (x *SearchResponse_Summary_Citation) GetStartIndex() int64

func (*SearchResponse_Summary_Citation) ProtoMessage added in v1.4.0

func (*SearchResponse_Summary_Citation) ProtoMessage()

func (*SearchResponse_Summary_Citation) ProtoReflect added in v1.4.0

func (*SearchResponse_Summary_Citation) Reset added in v1.4.0

func (*SearchResponse_Summary_Citation) String added in v1.4.0

type SearchResponse_Summary_CitationMetadata added in v1.4.0

type SearchResponse_Summary_CitationMetadata struct {

	// Citations for segments.
	Citations []*SearchResponse_Summary_Citation `protobuf:"bytes,1,rep,name=citations,proto3" json:"citations,omitempty"`
	// contains filtered or unexported fields
}

Citation metadata.

func (*SearchResponse_Summary_CitationMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SearchResponse_Summary_CitationMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_CitationMetadata) GetCitations added in v1.4.0

func (*SearchResponse_Summary_CitationMetadata) ProtoMessage added in v1.4.0

func (*SearchResponse_Summary_CitationMetadata) ProtoReflect added in v1.4.0

func (*SearchResponse_Summary_CitationMetadata) Reset added in v1.4.0

func (*SearchResponse_Summary_CitationMetadata) String added in v1.4.0

type SearchResponse_Summary_CitationSource added in v1.4.0

type SearchResponse_Summary_CitationSource struct {

	// Document reference index from SummaryWithMetadata.references.
	// It is 0-indexed and the value will be zero if the reference_index is
	// not set explicitly.
	ReferenceIndex int64 `protobuf:"varint,4,opt,name=reference_index,json=referenceIndex,proto3" json:"reference_index,omitempty"`
	// contains filtered or unexported fields
}

Citation source.

func (*SearchResponse_Summary_CitationSource) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SearchResponse_Summary_CitationSource.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_CitationSource) GetReferenceIndex added in v1.4.0

func (x *SearchResponse_Summary_CitationSource) GetReferenceIndex() int64

func (*SearchResponse_Summary_CitationSource) ProtoMessage added in v1.4.0

func (*SearchResponse_Summary_CitationSource) ProtoMessage()

func (*SearchResponse_Summary_CitationSource) ProtoReflect added in v1.4.0

func (*SearchResponse_Summary_CitationSource) Reset added in v1.4.0

func (*SearchResponse_Summary_CitationSource) String added in v1.4.0

type SearchResponse_Summary_Reference added in v1.4.0

type SearchResponse_Summary_Reference struct {

	// Title of the document.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Required.
	// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name] of
	// the document. Full resource name of the referenced document, in the
	// format
	// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
	Document string `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Cloud Storage or HTTP uri for the document.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

Document reference.

func (*SearchResponse_Summary_Reference) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SearchResponse_Summary_Reference.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Reference) GetDocument added in v1.4.0

func (x *SearchResponse_Summary_Reference) GetDocument() string

func (*SearchResponse_Summary_Reference) GetTitle added in v1.4.0

func (*SearchResponse_Summary_Reference) GetUri added in v1.4.0

func (*SearchResponse_Summary_Reference) ProtoMessage added in v1.4.0

func (*SearchResponse_Summary_Reference) ProtoMessage()

func (*SearchResponse_Summary_Reference) ProtoReflect added in v1.4.0

func (*SearchResponse_Summary_Reference) Reset added in v1.4.0

func (*SearchResponse_Summary_Reference) String added in v1.4.0

type SearchResponse_Summary_SafetyAttributes

type SearchResponse_Summary_SafetyAttributes struct {

	// The display names of Safety Attribute categories associated with the
	// generated content. Order matches the Scores.
	Categories []string `protobuf:"bytes,1,rep,name=categories,proto3" json:"categories,omitempty"`
	// The confidence scores of the each category, higher
	// value means higher confidence. Order matches the Categories.
	Scores []float32 `protobuf:"fixed32,2,rep,packed,name=scores,proto3" json:"scores,omitempty"`
	// contains filtered or unexported fields
}

Safety Attribute categories and their associated confidence scores.

func (*SearchResponse_Summary_SafetyAttributes) Descriptor deprecated

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

Deprecated: Use SearchResponse_Summary_SafetyAttributes.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_SafetyAttributes) GetCategories

func (x *SearchResponse_Summary_SafetyAttributes) GetCategories() []string

func (*SearchResponse_Summary_SafetyAttributes) GetScores

func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage

func (*SearchResponse_Summary_SafetyAttributes) ProtoReflect

func (*SearchResponse_Summary_SafetyAttributes) Reset

func (*SearchResponse_Summary_SafetyAttributes) String

type SearchResponse_Summary_SummarySkippedReason

type SearchResponse_Summary_SummarySkippedReason int32

An Enum for summary-skipped reasons.

const (
	// Default value. The summary skipped reason is not specified.
	SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED SearchResponse_Summary_SummarySkippedReason = 0
	// The adversarial query ignored case.
	//
	// Only populated when
	// [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query]
	// is set to `true`.
	SearchResponse_Summary_ADVERSARIAL_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 1
	// The non-summary seeking query ignored case.
	//
	// Only populated when
	// [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
	// is set to `true`.
	SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 2
	// The out-of-domain query ignored case.
	//
	// Google skips the summary if there are no high-relevance search results.
	// For example, the data store contains facts about company A but the
	// user query is asking questions about company B.
	SearchResponse_Summary_OUT_OF_DOMAIN_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 3
	// The potential policy violation case.
	//
	// Google skips the summary if there is a potential policy violation
	// detected. This includes content that may be violent or toxic.
	SearchResponse_Summary_POTENTIAL_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 4
	// The LLM addon not enabled case.
	//
	// Google skips the summary if the LLM addon is not enabled.
	SearchResponse_Summary_LLM_ADDON_NOT_ENABLED SearchResponse_Summary_SummarySkippedReason = 5
)

func (SearchResponse_Summary_SummarySkippedReason) Descriptor

func (SearchResponse_Summary_SummarySkippedReason) Enum

func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor deprecated

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

Deprecated: Use SearchResponse_Summary_SummarySkippedReason.Descriptor instead.

func (SearchResponse_Summary_SummarySkippedReason) Number

func (SearchResponse_Summary_SummarySkippedReason) String

func (SearchResponse_Summary_SummarySkippedReason) Type

type SearchResponse_Summary_SummaryWithMetadata added in v1.4.0

type SearchResponse_Summary_SummaryWithMetadata struct {

	// Summary text with no citation information.
	Summary string `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	// Citation metadata for given summary.
	CitationMetadata *SearchResponse_Summary_CitationMetadata `protobuf:"bytes,2,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
	// Document References.
	References []*SearchResponse_Summary_Reference `protobuf:"bytes,3,rep,name=references,proto3" json:"references,omitempty"`
	// contains filtered or unexported fields
}

Summary with metadata information.

func (*SearchResponse_Summary_SummaryWithMetadata) Descriptor deprecated added in v1.4.0

Deprecated: Use SearchResponse_Summary_SummaryWithMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) GetReferences added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) GetSummary added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoReflect added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) Reset added in v1.4.0

func (*SearchResponse_Summary_SummaryWithMetadata) String added in v1.4.0

type SearchServiceClient

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.

type SearchServiceServer

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

SearchServiceServer is the server API for SearchService service.

type SearchTier

type SearchTier int32

Tiers of search features. Different tiers might have different pricing. To learn more, please check the pricing documentation.

const (
	// Default value when the enum is unspecified. This is invalid to use.
	SearchTier_SEARCH_TIER_UNSPECIFIED SearchTier = 0
	// Standard tier.
	SearchTier_SEARCH_TIER_STANDARD SearchTier = 1
	// Enterprise tier.
	SearchTier_SEARCH_TIER_ENTERPRISE SearchTier = 2
)

func (SearchTier) Descriptor

func (SearchTier) Descriptor() protoreflect.EnumDescriptor

func (SearchTier) Enum

func (x SearchTier) Enum() *SearchTier

func (SearchTier) EnumDescriptor deprecated

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

Deprecated: Use SearchTier.Descriptor instead.

func (SearchTier) Number

func (x SearchTier) Number() protoreflect.EnumNumber

func (SearchTier) String

func (x SearchTier) String() string

func (SearchTier) Type

type SearchTuningServiceClient added in v1.4.0

type SearchTuningServiceClient interface {
	// Trains a custom model.
	TrainCustomModel(ctx context.Context, in *TrainCustomModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

SearchTuningServiceClient is the client API for SearchTuningService service.

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

func NewSearchTuningServiceClient added in v1.4.0

func NewSearchTuningServiceClient(cc grpc.ClientConnInterface) SearchTuningServiceClient

type SearchTuningServiceServer added in v1.4.0

type SearchTuningServiceServer interface {
	// Trains a custom model.
	TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
}

SearchTuningServiceServer is the server API for SearchTuningService service.

type ServingConfig added in v1.6.0

type ServingConfig struct {

	// Industry vertical specific config.
	//
	// Types that are assignable to VerticalConfig:
	//
	//	*ServingConfig_MediaConfig_
	//	*ServingConfig_GenericConfig_
	VerticalConfig isServingConfig_VerticalConfig `protobuf_oneof:"vertical_config"`
	// Immutable. Fully qualified name
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The human readable serving config display name. Used in Discovery
	// UI.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Immutable. Specifies the solution type that a serving config can
	// be associated with.
	SolutionType SolutionType `` /* 153-byte string literal not displayed */
	// The id of the model to use at serving time.
	// Currently only RecommendationModels are supported.
	// Can be changed but only to a compatible model (e.g.
	// others-you-may-like CTR to others-you-may-like CVR).
	//
	// Required when
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	ModelId string `protobuf:"bytes,4,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// How much diversity to use in recommendation model results e.g.
	// `medium-diversity` or `high-diversity`. Currently supported values:
	//
	// * `no-diversity`
	// * `low-diversity`
	// * `medium-diversity`
	// * `high-diversity`
	// * `auto-diversity`
	//
	// If not specified, we choose default based on recommendation model
	// type. Default value: `no-diversity`.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	DiversityLevel string `protobuf:"bytes,5,opt,name=diversity_level,json=diversityLevel,proto3" json:"diversity_level,omitempty"`
	// Bring your own embedding config. The config is used for search semantic
	// retrieval. The retrieval is based on the dot product of
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// and the document embeddings that are provided by this EmbeddingConfig. If
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// is provided, it overrides this
	// [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
	EmbeddingConfig *EmbeddingConfig `protobuf:"bytes,20,opt,name=embedding_config,json=embeddingConfig,proto3" json:"embedding_config,omitempty"`
	// The ranking expression controls the customized ranking on retrieval
	// documents. To leverage this, document embedding is required. The ranking
	// expression setting in ServingConfig applies to all search requests served
	// by the serving config. However, if
	// [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression]
	// is specified, it overrides the ServingConfig ranking expression.
	//
	// The ranking expression is a single function or multiple functions that are
	// joined by "+".
	//   - ranking_expression = function, { " + ", function };
	//
	// Supported functions:
	//   - double * relevance_score
	//   - double * dotProduct(embedding_field_path)
	//
	// Function variables:
	//
	//	 relevance_score: pre-defined keywords, used for measure relevance between
	//	 query and document.
	//	 embedding_field_path: the document embedding field
	//	 used with query embedding vector.
	//	 dotProduct: embedding function between embedding_field_path and query
	//	 embedding vector.
	//
	//	Example ranking expression:
	//	  If document has an embedding field doc_embedding, the ranking expression
	//	  could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
	RankingExpression string `protobuf:"bytes,21,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
	// Guided search configs.
	GuidedSearchSpec *GuidedSearchSpec `protobuf:"bytes,22,opt,name=guided_search_spec,json=guidedSearchSpec,proto3" json:"guided_search_spec,omitempty"`
	// Custom fine tuning configs.
	CustomFineTuningSpec *CustomFineTuningSpec `` /* 126-byte string literal not displayed */
	// Output only. ServingConfig created timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. ServingConfig updated timestamp.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Filter controls to use in serving path.
	// All triggered filter controls will be applied.
	// Filter controls must be in the same data store as the serving config.
	// Maximum of 20 filter controls.
	FilterControlIds []string `protobuf:"bytes,11,rep,name=filter_control_ids,json=filterControlIds,proto3" json:"filter_control_ids,omitempty"`
	// Boost controls to use in serving path.
	// All triggered boost controls will be applied.
	// Boost controls must be in the same data store as the serving config.
	// Maximum of 20 boost controls.
	BoostControlIds []string `protobuf:"bytes,12,rep,name=boost_control_ids,json=boostControlIds,proto3" json:"boost_control_ids,omitempty"`
	// IDs of the redirect controls. Only the first triggered redirect
	// action is applied, even if multiple apply. Maximum number of
	// specifications is 100.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	RedirectControlIds []string `protobuf:"bytes,14,rep,name=redirect_control_ids,json=redirectControlIds,proto3" json:"redirect_control_ids,omitempty"`
	// Condition synonyms specifications. If multiple synonyms conditions
	// match, all matching synonyms controls in the list will execute.
	// Maximum number of specifications is 100.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	SynonymsControlIds []string `protobuf:"bytes,15,rep,name=synonyms_control_ids,json=synonymsControlIds,proto3" json:"synonyms_control_ids,omitempty"`
	// Condition oneway synonyms specifications. If multiple oneway synonyms
	// conditions match, all matching oneway synonyms controls in the list
	// will execute. Maximum number of specifications is 100.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	OnewaySynonymsControlIds []string `` /* 138-byte string literal not displayed */
	// Condition do not associate specifications. If multiple do not
	// associate conditions match, all matching do not associate controls in
	// the list will execute.
	// Order does not matter.
	// Maximum number of specifications is 100.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	DissociateControlIds []string `protobuf:"bytes,17,rep,name=dissociate_control_ids,json=dissociateControlIds,proto3" json:"dissociate_control_ids,omitempty"`
	// Condition replacement specifications.
	// Applied according to the order in the list.
	// A previously replaced term can not be re-replaced.
	// Maximum number of specifications is 100.
	//
	// Can only be set if
	// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	ReplacementControlIds []string `` /* 127-byte string literal not displayed */
	// Condition ignore specifications. If multiple ignore
	// conditions match, all matching ignore controls in the list will
	// execute.
	// Order does not matter.
	// Maximum number of specifications is 100.
	IgnoreControlIds []string `protobuf:"bytes,19,rep,name=ignore_control_ids,json=ignoreControlIds,proto3" json:"ignore_control_ids,omitempty"`
	// contains filtered or unexported fields
}

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

func (*ServingConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ServingConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig) GetBoostControlIds added in v1.6.0

func (x *ServingConfig) GetBoostControlIds() []string

func (*ServingConfig) GetCreateTime added in v1.6.0

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

func (*ServingConfig) GetCustomFineTuningSpec added in v1.6.0

func (x *ServingConfig) GetCustomFineTuningSpec() *CustomFineTuningSpec

func (*ServingConfig) GetDisplayName added in v1.6.0

func (x *ServingConfig) GetDisplayName() string

func (*ServingConfig) GetDissociateControlIds added in v1.6.0

func (x *ServingConfig) GetDissociateControlIds() []string

func (*ServingConfig) GetDiversityLevel added in v1.6.0

func (x *ServingConfig) GetDiversityLevel() string

func (*ServingConfig) GetEmbeddingConfig added in v1.6.0

func (x *ServingConfig) GetEmbeddingConfig() *EmbeddingConfig

func (*ServingConfig) GetFilterControlIds added in v1.6.0

func (x *ServingConfig) GetFilterControlIds() []string

func (*ServingConfig) GetGenericConfig added in v1.6.0

func (x *ServingConfig) GetGenericConfig() *ServingConfig_GenericConfig

func (*ServingConfig) GetGuidedSearchSpec added in v1.6.0

func (x *ServingConfig) GetGuidedSearchSpec() *GuidedSearchSpec

func (*ServingConfig) GetIgnoreControlIds added in v1.6.0

func (x *ServingConfig) GetIgnoreControlIds() []string

func (*ServingConfig) GetMediaConfig added in v1.6.0

func (x *ServingConfig) GetMediaConfig() *ServingConfig_MediaConfig

func (*ServingConfig) GetModelId added in v1.6.0

func (x *ServingConfig) GetModelId() string

func (*ServingConfig) GetName added in v1.6.0

func (x *ServingConfig) GetName() string

func (*ServingConfig) GetOnewaySynonymsControlIds added in v1.6.0

func (x *ServingConfig) GetOnewaySynonymsControlIds() []string

func (*ServingConfig) GetRankingExpression added in v1.6.0

func (x *ServingConfig) GetRankingExpression() string

func (*ServingConfig) GetRedirectControlIds added in v1.6.0

func (x *ServingConfig) GetRedirectControlIds() []string

func (*ServingConfig) GetReplacementControlIds added in v1.6.0

func (x *ServingConfig) GetReplacementControlIds() []string

func (*ServingConfig) GetSolutionType added in v1.6.0

func (x *ServingConfig) GetSolutionType() SolutionType

func (*ServingConfig) GetSynonymsControlIds added in v1.6.0

func (x *ServingConfig) GetSynonymsControlIds() []string

func (*ServingConfig) GetUpdateTime added in v1.6.0

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

func (*ServingConfig) GetVerticalConfig added in v1.6.0

func (m *ServingConfig) GetVerticalConfig() isServingConfig_VerticalConfig

func (*ServingConfig) ProtoMessage added in v1.6.0

func (*ServingConfig) ProtoMessage()

func (*ServingConfig) ProtoReflect added in v1.6.0

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

func (*ServingConfig) Reset added in v1.6.0

func (x *ServingConfig) Reset()

func (*ServingConfig) String added in v1.6.0

func (x *ServingConfig) String() string

type ServingConfigServiceClient added in v1.6.0

type ServingConfigServiceClient interface {
	// Updates a ServingConfig.
	//
	// Returns a NOT_FOUND error if the ServingConfig does not exist.
	UpdateServingConfig(ctx context.Context, in *UpdateServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// Gets a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	GetServingConfig(ctx context.Context, in *GetServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// Lists all ServingConfigs linked to this dataStore.
	ListServingConfigs(ctx context.Context, in *ListServingConfigsRequest, opts ...grpc.CallOption) (*ListServingConfigsResponse, error)
}

ServingConfigServiceClient is the client API for ServingConfigService service.

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

func NewServingConfigServiceClient added in v1.6.0

func NewServingConfigServiceClient(cc grpc.ClientConnInterface) ServingConfigServiceClient

type ServingConfigServiceServer added in v1.6.0

type ServingConfigServiceServer interface {
	// Updates a ServingConfig.
	//
	// Returns a NOT_FOUND error if the ServingConfig does not exist.
	UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)
	// Gets a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)
	// Lists all ServingConfigs linked to this dataStore.
	ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)
}

ServingConfigServiceServer is the server API for ServingConfigService service.

type ServingConfig_GenericConfig added in v1.6.0

type ServingConfig_GenericConfig struct {

	// Specifies the expected behavior of content search.
	// Only valid for content-search enabled data store.
	ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,1,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
	// contains filtered or unexported fields
}

Specifies the configurations needed for Generic Discovery.Currently we support:

* `content_search_spec`: configuration for generic content search.

func (*ServingConfig_GenericConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ServingConfig_GenericConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig_GenericConfig) GetContentSearchSpec added in v1.6.0

func (*ServingConfig_GenericConfig) ProtoMessage added in v1.6.0

func (*ServingConfig_GenericConfig) ProtoMessage()

func (*ServingConfig_GenericConfig) ProtoReflect added in v1.6.0

func (*ServingConfig_GenericConfig) Reset added in v1.6.0

func (x *ServingConfig_GenericConfig) Reset()

func (*ServingConfig_GenericConfig) String added in v1.6.0

func (x *ServingConfig_GenericConfig) String() string

type ServingConfig_GenericConfig_ added in v1.6.0

type ServingConfig_GenericConfig_ struct {
	// The GenericConfig of the serving configuration.
	GenericConfig *ServingConfig_GenericConfig `protobuf:"bytes,10,opt,name=generic_config,json=genericConfig,proto3,oneof"`
}

type ServingConfig_MediaConfig added in v1.6.0

type ServingConfig_MediaConfig struct {

	// Specify the threshold for demoting watched content, the threshold can be
	// either percentage or minutes value.
	// This must be set for `media-complete` event type.
	//
	// Types that are assignable to DemoteContentWatched:
	//
	//	*ServingConfig_MediaConfig_ContentWatchedPercentageThreshold
	//	*ServingConfig_MediaConfig_ContentWatchedSecondsThreshold
	DemoteContentWatched isServingConfig_MediaConfig_DemoteContentWatched `protobuf_oneof:"demote_content_watched"`
	// Specifies the event type used for demoting recommendation result.
	// Currently supported values:
	//
	// * `view-item`: Item viewed.
	// * `media-play`: Start/resume watching a video, playing a song, etc.
	// * `media-complete`: Finished or stopped midway through a video, song,
	// etc.
	//
	// If unset, watch history demotion will not be applied. Content freshness
	// demotion will still be applied.
	DemotionEventType string `protobuf:"bytes,1,opt,name=demotion_event_type,json=demotionEventType,proto3" json:"demotion_event_type,omitempty"`
	// Specifies the content freshness used for recommendation result.
	// Contents will be demoted if contents were published for more than content
	// freshness cutoff days.
	ContentFreshnessCutoffDays int32 `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies the configurations needed for Media Discovery. Currently we support:

* `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType[google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

func (*ServingConfig_MediaConfig) Descriptor deprecated added in v1.6.0

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

Deprecated: Use ServingConfig_MediaConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig_MediaConfig) GetContentFreshnessCutoffDays added in v1.6.0

func (x *ServingConfig_MediaConfig) GetContentFreshnessCutoffDays() int32

func (*ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold added in v1.6.0

func (x *ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold() float32

func (*ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold added in v1.6.0

func (x *ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold() float32

func (*ServingConfig_MediaConfig) GetDemoteContentWatched added in v1.6.0

func (m *ServingConfig_MediaConfig) GetDemoteContentWatched() isServingConfig_MediaConfig_DemoteContentWatched

func (*ServingConfig_MediaConfig) GetDemotionEventType added in v1.6.0

func (x *ServingConfig_MediaConfig) GetDemotionEventType() string

func (*ServingConfig_MediaConfig) ProtoMessage added in v1.6.0

func (*ServingConfig_MediaConfig) ProtoMessage()

func (*ServingConfig_MediaConfig) ProtoReflect added in v1.6.0

func (*ServingConfig_MediaConfig) Reset added in v1.6.0

func (x *ServingConfig_MediaConfig) Reset()

func (*ServingConfig_MediaConfig) String added in v1.6.0

func (x *ServingConfig_MediaConfig) String() string

type ServingConfig_MediaConfig_ added in v1.6.0

type ServingConfig_MediaConfig_ struct {
	// The MediaConfig of the serving configuration.
	MediaConfig *ServingConfig_MediaConfig `protobuf:"bytes,7,opt,name=media_config,json=mediaConfig,proto3,oneof"`
}

type ServingConfig_MediaConfig_ContentWatchedPercentageThreshold added in v1.6.0

type ServingConfig_MediaConfig_ContentWatchedPercentageThreshold struct {
	// Specifies the content watched percentage threshold for demotion.
	// Threshold value must be between [0, 1.0] inclusive.
	ContentWatchedPercentageThreshold float32 `protobuf:"fixed32,2,opt,name=content_watched_percentage_threshold,json=contentWatchedPercentageThreshold,proto3,oneof"`
}

type ServingConfig_MediaConfig_ContentWatchedSecondsThreshold added in v1.6.0

type ServingConfig_MediaConfig_ContentWatchedSecondsThreshold struct {
	// Specifies the content watched minutes threshold for demotion.
	ContentWatchedSecondsThreshold float32 `protobuf:"fixed32,5,opt,name=content_watched_seconds_threshold,json=contentWatchedSecondsThreshold,proto3,oneof"`
}

type SiteSearchEngine added in v1.4.0

type SiteSearchEngine struct {

	// The fully qualified resource name of the site search engine.
	// Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

func (*SiteSearchEngine) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SiteSearchEngine.ProtoReflect.Descriptor instead.

func (*SiteSearchEngine) GetName added in v1.4.0

func (x *SiteSearchEngine) GetName() string

func (*SiteSearchEngine) ProtoMessage added in v1.4.0

func (*SiteSearchEngine) ProtoMessage()

func (*SiteSearchEngine) ProtoReflect added in v1.4.0

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

func (*SiteSearchEngine) Reset added in v1.4.0

func (x *SiteSearchEngine) Reset()

func (*SiteSearchEngine) String added in v1.4.0

func (x *SiteSearchEngine) String() string

type SiteSearchEngineServiceClient

type SiteSearchEngineServiceClient interface {
	// Gets the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine].
	GetSiteSearchEngine(ctx context.Context, in *GetSiteSearchEngineRequest, opts ...grpc.CallOption) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	CreateTargetSite(ctx context.Context, in *CreateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in a
	// batch.
	BatchCreateTargetSites(ctx context.Context, in *BatchCreateTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	GetTargetSite(ctx context.Context, in *GetTargetSiteRequest, opts ...grpc.CallOption) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	UpdateTargetSite(ctx context.Context, in *UpdateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	DeleteTargetSite(ctx context.Context, in *DeleteTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s.
	ListTargetSites(ctx context.Context, in *ListTargetSitesRequest, opts ...grpc.CallOption) (*ListTargetSitesResponse, error)
	// Upgrade from basic site search to advanced site search.
	EnableAdvancedSiteSearch(ctx context.Context, in *EnableAdvancedSiteSearchRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Downgrade from advanced site search to basic site search.
	DisableAdvancedSiteSearch(ctx context.Context, in *DisableAdvancedSiteSearchRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Request on-demand recrawl for a list of URIs.
	RecrawlUris(ctx context.Context, in *RecrawlUrisRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Verify target sites' ownership and validity.
	// This API sends all the target sites under site search engine for
	// verification.
	BatchVerifyTargetSites(ctx context.Context, in *BatchVerifyTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns list of target sites with its domain verification status.
	// This method can only be called under data store with BASIC_SITE_SEARCH
	// state at the moment.
	FetchDomainVerificationStatus(ctx context.Context, in *FetchDomainVerificationStatusRequest, opts ...grpc.CallOption) (*FetchDomainVerificationStatusResponse, error)
}

SiteSearchEngineServiceClient is the client API for SiteSearchEngineService service.

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

type SiteSearchEngineServiceServer

type SiteSearchEngineServiceServer interface {
	// Gets the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine].
	GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in a
	// batch.
	BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
	DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)
	// Gets a list of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s.
	ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)
	// Upgrade from basic site search to advanced site search.
	EnableAdvancedSiteSearch(context.Context, *EnableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
	// Downgrade from advanced site search to basic site search.
	DisableAdvancedSiteSearch(context.Context, *DisableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
	// Request on-demand recrawl for a list of URIs.
	RecrawlUris(context.Context, *RecrawlUrisRequest) (*longrunningpb.Operation, error)
	// Verify target sites' ownership and validity.
	// This API sends all the target sites under site search engine for
	// verification.
	BatchVerifyTargetSites(context.Context, *BatchVerifyTargetSitesRequest) (*longrunningpb.Operation, error)
	// Returns list of target sites with its domain verification status.
	// This method can only be called under data store with BASIC_SITE_SEARCH
	// state at the moment.
	FetchDomainVerificationStatus(context.Context, *FetchDomainVerificationStatusRequest) (*FetchDomainVerificationStatusResponse, error)
}

SiteSearchEngineServiceServer is the server API for SiteSearchEngineService service.

type SiteVerificationInfo added in v1.4.0

type SiteVerificationInfo struct {

	// Site verification state indicating the ownership and validity.
	SiteVerificationState SiteVerificationInfo_SiteVerificationState `` /* 212-byte string literal not displayed */
	// Latest site verification time.
	VerifyTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=verify_time,json=verifyTime,proto3" json:"verify_time,omitempty"`
	// contains filtered or unexported fields
}

Verification information for target sites in advanced site search.

func (*SiteVerificationInfo) Descriptor deprecated added in v1.4.0

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

Deprecated: Use SiteVerificationInfo.ProtoReflect.Descriptor instead.

func (*SiteVerificationInfo) GetSiteVerificationState added in v1.4.0

func (*SiteVerificationInfo) GetVerifyTime added in v1.4.0

func (x *SiteVerificationInfo) GetVerifyTime() *timestamppb.Timestamp

func (*SiteVerificationInfo) ProtoMessage added in v1.4.0

func (*SiteVerificationInfo) ProtoMessage()

func (*SiteVerificationInfo) ProtoReflect added in v1.4.0

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

func (*SiteVerificationInfo) Reset added in v1.4.0

func (x *SiteVerificationInfo) Reset()

func (*SiteVerificationInfo) String added in v1.4.0

func (x *SiteVerificationInfo) String() string

type SiteVerificationInfo_SiteVerificationState added in v1.4.0

type SiteVerificationInfo_SiteVerificationState int32

Site verification state.

const (
	// Defaults to VERIFIED.
	SiteVerificationInfo_SITE_VERIFICATION_STATE_UNSPECIFIED SiteVerificationInfo_SiteVerificationState = 0
	// Site ownership verified.
	SiteVerificationInfo_VERIFIED SiteVerificationInfo_SiteVerificationState = 1
	// Site ownership pending verification or verification failed.
	SiteVerificationInfo_UNVERIFIED SiteVerificationInfo_SiteVerificationState = 2
	// Site exempt from verification, e.g., a public website that opens to all.
	SiteVerificationInfo_EXEMPTED SiteVerificationInfo_SiteVerificationState = 3
)

func (SiteVerificationInfo_SiteVerificationState) Descriptor added in v1.4.0

func (SiteVerificationInfo_SiteVerificationState) Enum added in v1.4.0

func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor deprecated added in v1.4.0

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

Deprecated: Use SiteVerificationInfo_SiteVerificationState.Descriptor instead.

func (SiteVerificationInfo_SiteVerificationState) Number added in v1.4.0

func (SiteVerificationInfo_SiteVerificationState) String added in v1.4.0

func (SiteVerificationInfo_SiteVerificationState) Type added in v1.4.0

type SolutionType

type SolutionType int32

The type of solution.

const (
	// Default value.
	SolutionType_SOLUTION_TYPE_UNSPECIFIED SolutionType = 0
	// Used for Recommendations AI.
	SolutionType_SOLUTION_TYPE_RECOMMENDATION SolutionType = 1
	// Used for Discovery Search.
	SolutionType_SOLUTION_TYPE_SEARCH SolutionType = 2
	// Used for use cases related to the Generative AI agent.
	SolutionType_SOLUTION_TYPE_CHAT SolutionType = 3
)

func (SolutionType) Descriptor

func (SolutionType) Enum

func (x SolutionType) Enum() *SolutionType

func (SolutionType) EnumDescriptor deprecated

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

Deprecated: Use SolutionType.Descriptor instead.

func (SolutionType) Number

func (SolutionType) String

func (x SolutionType) String() string

func (SolutionType) Type

type SuggestionDenyListEntry added in v1.6.0

type SuggestionDenyListEntry struct {

	// Required. Phrase to block from suggestions served. Can be maximum 125
	// characters.
	BlockPhrase string `protobuf:"bytes,1,opt,name=block_phrase,json=blockPhrase,proto3" json:"block_phrase,omitempty"`
	// Required. The match operator to apply for this phrase. Whether to block the
	// exact phrase, or block any suggestions containing this phrase.
	MatchOperator SuggestionDenyListEntry_MatchOperator `` /* 181-byte string literal not displayed */
	// contains filtered or unexported fields
}

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

func (*SuggestionDenyListEntry) Descriptor deprecated added in v1.6.0

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

Deprecated: Use SuggestionDenyListEntry.ProtoReflect.Descriptor instead.

func (*SuggestionDenyListEntry) GetBlockPhrase added in v1.6.0

func (x *SuggestionDenyListEntry) GetBlockPhrase() string

func (*SuggestionDenyListEntry) GetMatchOperator added in v1.6.0

func (*SuggestionDenyListEntry) ProtoMessage added in v1.6.0

func (*SuggestionDenyListEntry) ProtoMessage()

func (*SuggestionDenyListEntry) ProtoReflect added in v1.6.0

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

func (*SuggestionDenyListEntry) Reset added in v1.6.0

func (x *SuggestionDenyListEntry) Reset()

func (*SuggestionDenyListEntry) String added in v1.6.0

func (x *SuggestionDenyListEntry) String() string

type SuggestionDenyListEntry_MatchOperator added in v1.6.0

type SuggestionDenyListEntry_MatchOperator int32

Operator for matching with the generated suggestions.

const (
	// Default value. Should not be used
	SuggestionDenyListEntry_MATCH_OPERATOR_UNSPECIFIED SuggestionDenyListEntry_MatchOperator = 0
	// If the suggestion is an exact match to the block_phrase, then block it.
	SuggestionDenyListEntry_EXACT_MATCH SuggestionDenyListEntry_MatchOperator = 1
	// If the suggestion contains the block_phrase, then block it.
	SuggestionDenyListEntry_CONTAINS SuggestionDenyListEntry_MatchOperator = 2
)

func (SuggestionDenyListEntry_MatchOperator) Descriptor added in v1.6.0

func (SuggestionDenyListEntry_MatchOperator) Enum added in v1.6.0

func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor deprecated added in v1.6.0

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

Deprecated: Use SuggestionDenyListEntry_MatchOperator.Descriptor instead.

func (SuggestionDenyListEntry_MatchOperator) Number added in v1.6.0

func (SuggestionDenyListEntry_MatchOperator) String added in v1.6.0

func (SuggestionDenyListEntry_MatchOperator) Type added in v1.6.0

type TargetSite added in v1.4.0

type TargetSite struct {

	// Output only. The fully qualified resource name of the target site.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
	// The `target_site_id` is system-generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Input only. The user provided URI pattern from which the
	// `generated_uri_pattern` is generated.
	ProvidedUriPattern string `protobuf:"bytes,2,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
	// The type of the target site, e.g., whether the site is to be included or
	// excluded.
	Type TargetSite_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1alpha.TargetSite_Type" json:"type,omitempty"`
	// Input only. If set to false, a uri_pattern is generated to include all
	// pages whose address contains the provided_uri_pattern. If set to true, an
	// uri_pattern is generated to try to be an exact match of the
	// provided_uri_pattern or just the specific page if the provided_uri_pattern
	// is a specific one. provided_uri_pattern is always normalized to
	// generate the URI pattern to be used by the search engine.
	ExactMatch bool `protobuf:"varint,6,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
	// Output only. This is system-generated based on the provided_uri_pattern.
	GeneratedUriPattern string `protobuf:"bytes,4,opt,name=generated_uri_pattern,json=generatedUriPattern,proto3" json:"generated_uri_pattern,omitempty"`
	// Output only. Site ownership and validity verification status.
	SiteVerificationInfo *SiteVerificationInfo `protobuf:"bytes,7,opt,name=site_verification_info,json=siteVerificationInfo,proto3" json:"site_verification_info,omitempty"`
	// Output only. Indexing status.
	IndexingStatus TargetSite_IndexingStatus `` /* 172-byte string literal not displayed */
	// Output only. The target site's last updated time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Failure reason.
	FailureReason *TargetSite_FailureReason `protobuf:"bytes,9,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
	// contains filtered or unexported fields
}

A target site for the SiteSearchEngine.

func (*TargetSite) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TargetSite.ProtoReflect.Descriptor instead.

func (*TargetSite) GetExactMatch added in v1.4.0

func (x *TargetSite) GetExactMatch() bool

func (*TargetSite) GetFailureReason added in v1.4.0

func (x *TargetSite) GetFailureReason() *TargetSite_FailureReason

func (*TargetSite) GetGeneratedUriPattern added in v1.4.0

func (x *TargetSite) GetGeneratedUriPattern() string

func (*TargetSite) GetIndexingStatus added in v1.4.0

func (x *TargetSite) GetIndexingStatus() TargetSite_IndexingStatus

func (*TargetSite) GetName added in v1.4.0

func (x *TargetSite) GetName() string

func (*TargetSite) GetProvidedUriPattern added in v1.4.0

func (x *TargetSite) GetProvidedUriPattern() string

func (*TargetSite) GetSiteVerificationInfo added in v1.4.0

func (x *TargetSite) GetSiteVerificationInfo() *SiteVerificationInfo

func (*TargetSite) GetType added in v1.4.0

func (x *TargetSite) GetType() TargetSite_Type

func (*TargetSite) GetUpdateTime added in v1.4.0

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

func (*TargetSite) ProtoMessage added in v1.4.0

func (*TargetSite) ProtoMessage()

func (*TargetSite) ProtoReflect added in v1.4.0

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

func (*TargetSite) Reset added in v1.4.0

func (x *TargetSite) Reset()

func (*TargetSite) String added in v1.4.0

func (x *TargetSite) String() string

type TargetSite_FailureReason added in v1.4.0

type TargetSite_FailureReason struct {

	// Failure reason.
	//
	// Types that are assignable to Failure:
	//
	//	*TargetSite_FailureReason_QuotaFailure_
	Failure isTargetSite_FailureReason_Failure `protobuf_oneof:"failure"`
	// contains filtered or unexported fields
}

Site search indexing failure reasons.

func (*TargetSite_FailureReason) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TargetSite_FailureReason.ProtoReflect.Descriptor instead.

func (*TargetSite_FailureReason) GetFailure added in v1.4.0

func (m *TargetSite_FailureReason) GetFailure() isTargetSite_FailureReason_Failure

func (*TargetSite_FailureReason) GetQuotaFailure added in v1.4.0

func (*TargetSite_FailureReason) ProtoMessage added in v1.4.0

func (*TargetSite_FailureReason) ProtoMessage()

func (*TargetSite_FailureReason) ProtoReflect added in v1.4.0

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

func (*TargetSite_FailureReason) Reset added in v1.4.0

func (x *TargetSite_FailureReason) Reset()

func (*TargetSite_FailureReason) String added in v1.4.0

func (x *TargetSite_FailureReason) String() string

type TargetSite_FailureReason_QuotaFailure added in v1.4.0

type TargetSite_FailureReason_QuotaFailure struct {

	// This number is an estimation on how much total quota this project needs
	// to successfully complete indexing.
	TotalRequiredQuota int64 `protobuf:"varint,1,opt,name=total_required_quota,json=totalRequiredQuota,proto3" json:"total_required_quota,omitempty"`
	// contains filtered or unexported fields
}

Failed due to insufficient quota.

func (*TargetSite_FailureReason_QuotaFailure) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TargetSite_FailureReason_QuotaFailure.ProtoReflect.Descriptor instead.

func (*TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota added in v1.6.0

func (x *TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota() int64

func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage added in v1.4.0

func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage()

func (*TargetSite_FailureReason_QuotaFailure) ProtoReflect added in v1.4.0

func (*TargetSite_FailureReason_QuotaFailure) Reset added in v1.4.0

func (*TargetSite_FailureReason_QuotaFailure) String added in v1.4.0

type TargetSite_FailureReason_QuotaFailure_ added in v1.4.0

type TargetSite_FailureReason_QuotaFailure_ struct {
	// Failed due to insufficient quota.
	QuotaFailure *TargetSite_FailureReason_QuotaFailure `protobuf:"bytes,1,opt,name=quota_failure,json=quotaFailure,proto3,oneof"`
}

type TargetSite_IndexingStatus added in v1.4.0

type TargetSite_IndexingStatus int32

Target site indexing status enumeration.

const (
	// Defaults to SUCCEEDED.
	TargetSite_INDEXING_STATUS_UNSPECIFIED TargetSite_IndexingStatus = 0
	// The target site is in the update queue and will be picked up by indexing
	// pipeline.
	TargetSite_PENDING TargetSite_IndexingStatus = 1
	// The target site fails to be indexed.
	TargetSite_FAILED TargetSite_IndexingStatus = 2
	// The target site has been indexed.
	TargetSite_SUCCEEDED TargetSite_IndexingStatus = 3
	// The previously indexed target site has been marked to be deleted. This is
	// a transitioning state which will resulted in either:
	// 1. target site deleted if unindexing is successful;
	// 2. state reverts to SUCCEEDED if the unindexing fails.
	TargetSite_DELETING TargetSite_IndexingStatus = 4
)

func (TargetSite_IndexingStatus) Descriptor added in v1.4.0

func (TargetSite_IndexingStatus) Enum added in v1.4.0

func (TargetSite_IndexingStatus) EnumDescriptor deprecated added in v1.4.0

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

Deprecated: Use TargetSite_IndexingStatus.Descriptor instead.

func (TargetSite_IndexingStatus) Number added in v1.4.0

func (TargetSite_IndexingStatus) String added in v1.4.0

func (x TargetSite_IndexingStatus) String() string

func (TargetSite_IndexingStatus) Type added in v1.4.0

type TargetSite_Type added in v1.4.0

type TargetSite_Type int32

Possible target site types.

const (
	// This value is unused. In this case, server behavior defaults to
	// [Type.INCLUDE][google.cloud.discoveryengine.v1alpha.TargetSite.Type.INCLUDE].
	TargetSite_TYPE_UNSPECIFIED TargetSite_Type = 0
	// Include the target site.
	TargetSite_INCLUDE TargetSite_Type = 1
	// Exclude the target site.
	TargetSite_EXCLUDE TargetSite_Type = 2
)

func (TargetSite_Type) Descriptor added in v1.4.0

func (TargetSite_Type) Enum added in v1.4.0

func (x TargetSite_Type) Enum() *TargetSite_Type

func (TargetSite_Type) EnumDescriptor deprecated added in v1.4.0

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

Deprecated: Use TargetSite_Type.Descriptor instead.

func (TargetSite_Type) Number added in v1.4.0

func (TargetSite_Type) String added in v1.4.0

func (x TargetSite_Type) String() string

func (TargetSite_Type) Type added in v1.4.0

type TextInput

type TextInput struct {

	// Text input.
	Input string `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// Conversation context of the input.
	Context *ConversationContext `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

Defines text input.

func (*TextInput) Descriptor deprecated

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

Deprecated: Use TextInput.ProtoReflect.Descriptor instead.

func (*TextInput) GetContext

func (x *TextInput) GetContext() *ConversationContext

func (*TextInput) GetInput

func (x *TextInput) GetInput() string

func (*TextInput) ProtoMessage

func (*TextInput) ProtoMessage()

func (*TextInput) ProtoReflect

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

func (*TextInput) Reset

func (x *TextInput) Reset()

func (*TextInput) String

func (x *TextInput) String() string

type TrainCustomModelMetadata added in v1.4.0

type TrainCustomModelMetadata 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 related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

func (*TrainCustomModelMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TrainCustomModelMetadata.ProtoReflect.Descriptor instead.

func (*TrainCustomModelMetadata) GetCreateTime added in v1.4.0

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

func (*TrainCustomModelMetadata) GetUpdateTime added in v1.4.0

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

func (*TrainCustomModelMetadata) ProtoMessage added in v1.4.0

func (*TrainCustomModelMetadata) ProtoMessage()

func (*TrainCustomModelMetadata) ProtoReflect added in v1.4.0

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

func (*TrainCustomModelMetadata) Reset added in v1.4.0

func (x *TrainCustomModelMetadata) Reset()

func (*TrainCustomModelMetadata) String added in v1.4.0

func (x *TrainCustomModelMetadata) String() string

type TrainCustomModelRequest added in v1.4.0

type TrainCustomModelRequest struct {

	// Model training input.
	//
	// Types that are assignable to TrainingInput:
	//
	//	*TrainCustomModelRequest_GcsTrainingInput_
	TrainingInput isTrainCustomModelRequest_TrainingInput `protobuf_oneof:"training_input"`
	// Required. The resource name of the Data Store, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	// This field is used to identify the data store where to train the models.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Model to be trained. Supported values are:
	//
	//   - **search-tuning**: Fine tuning the search system based on data provided.
	ModelType string `protobuf:"bytes,3,opt,name=model_type,json=modelType,proto3" json:"model_type,omitempty"`
	// The desired location of errors incurred during the data ingestion and
	// training.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,4,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] method.

func (*TrainCustomModelRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TrainCustomModelRequest.ProtoReflect.Descriptor instead.

func (*TrainCustomModelRequest) GetDataStore added in v1.4.0

func (x *TrainCustomModelRequest) GetDataStore() string

func (*TrainCustomModelRequest) GetErrorConfig added in v1.4.0

func (x *TrainCustomModelRequest) GetErrorConfig() *ImportErrorConfig

func (*TrainCustomModelRequest) GetGcsTrainingInput added in v1.4.0

func (*TrainCustomModelRequest) GetModelType added in v1.4.0

func (x *TrainCustomModelRequest) GetModelType() string

func (*TrainCustomModelRequest) GetTrainingInput added in v1.4.0

func (m *TrainCustomModelRequest) GetTrainingInput() isTrainCustomModelRequest_TrainingInput

func (*TrainCustomModelRequest) ProtoMessage added in v1.4.0

func (*TrainCustomModelRequest) ProtoMessage()

func (*TrainCustomModelRequest) ProtoReflect added in v1.4.0

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

func (*TrainCustomModelRequest) Reset added in v1.4.0

func (x *TrainCustomModelRequest) Reset()

func (*TrainCustomModelRequest) String added in v1.4.0

func (x *TrainCustomModelRequest) String() string

type TrainCustomModelRequest_GcsTrainingInput added in v1.4.0

type TrainCustomModelRequest_GcsTrainingInput struct {

	// The Cloud Storage corpus data which could be associated in train data.
	// The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
	// A newline delimited jsonl/ndjson file.
	//
	// For search-tuning model, each line should have the _id, title
	// and text. Example: {"_id": "doc1", title: "relevant doc", "text":
	// "relevant text"}
	CorpusDataPath string `protobuf:"bytes,1,opt,name=corpus_data_path,json=corpusDataPath,proto3" json:"corpus_data_path,omitempty"`
	// The gcs query data which could be associated in train data.
	// The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
	// A newline delimited jsonl/ndjson file.
	//
	// For search-tuning model, each line should have the _id
	// and text. Example: {"_id": "query1",  "text": "example query"}
	QueryDataPath string `protobuf:"bytes,2,opt,name=query_data_path,json=queryDataPath,proto3" json:"query_data_path,omitempty"`
	// Cloud Storage training data path whose format should be
	// `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
	// format. Each line should have the doc_id and query_id and score (number).
	//
	// For search-tuning model, it should have the query-id corpus-id
	// score as tsv file header. The score should be a number in `[0, inf+)`.
	// The larger the number is, the more relevant the pair is. Example:
	//
	// * `query-id\tcorpus-id\tscore`
	// * `query1\tdoc1\t1`
	TrainDataPath string `protobuf:"bytes,3,opt,name=train_data_path,json=trainDataPath,proto3" json:"train_data_path,omitempty"`
	// Cloud Storage test data. Same format as train_data_path. If not provided,
	// a random 80/20 train/test split will be performed on train_data_path.
	TestDataPath string `protobuf:"bytes,4,opt,name=test_data_path,json=testDataPath,proto3" json:"test_data_path,omitempty"`
	// contains filtered or unexported fields
}

Cloud Storage training data input.

func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TrainCustomModelRequest_GcsTrainingInput.ProtoReflect.Descriptor instead.

func (*TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath added in v1.4.0

func (x *TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath added in v1.4.0

func (x *TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath added in v1.4.0

func (x *TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath added in v1.4.0

func (x *TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage added in v1.4.0

func (*TrainCustomModelRequest_GcsTrainingInput) ProtoReflect added in v1.4.0

func (*TrainCustomModelRequest_GcsTrainingInput) Reset added in v1.4.0

func (*TrainCustomModelRequest_GcsTrainingInput) String added in v1.4.0

type TrainCustomModelRequest_GcsTrainingInput_ added in v1.4.0

type TrainCustomModelRequest_GcsTrainingInput_ struct {
	// Cloud Storage training input.
	GcsTrainingInput *TrainCustomModelRequest_GcsTrainingInput `protobuf:"bytes,2,opt,name=gcs_training_input,json=gcsTrainingInput,proto3,oneof"`
}

type TrainCustomModelResponse added in v1.4.0

type TrainCustomModelResponse struct {

	// A sample of errors encountered while processing the data.
	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"`
	// The trained model status. Possible values are:
	//
	//   - **bad-data**: The training data quality is bad.
	//   - **no-improvement**: Tuning didn't improve performance. Won't deploy.
	//   - **in-progress**: Model training is in progress.
	//   - **ready**: The model is ready for serving.
	ModelStatus string `protobuf:"bytes,3,opt,name=model_status,json=modelStatus,proto3" json:"model_status,omitempty"`
	// contains filtered or unexported fields
}

Response of the TrainCustomModelRequest[google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.

func (*TrainCustomModelResponse) Descriptor deprecated added in v1.4.0

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

Deprecated: Use TrainCustomModelResponse.ProtoReflect.Descriptor instead.

func (*TrainCustomModelResponse) GetErrorConfig added in v1.4.0

func (x *TrainCustomModelResponse) GetErrorConfig() *ImportErrorConfig

func (*TrainCustomModelResponse) GetErrorSamples added in v1.4.0

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

func (*TrainCustomModelResponse) GetModelStatus added in v1.4.0

func (x *TrainCustomModelResponse) GetModelStatus() string

func (*TrainCustomModelResponse) ProtoMessage added in v1.4.0

func (*TrainCustomModelResponse) ProtoMessage()

func (*TrainCustomModelResponse) ProtoReflect added in v1.4.0

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

func (*TrainCustomModelResponse) Reset added in v1.4.0

func (x *TrainCustomModelResponse) Reset()

func (*TrainCustomModelResponse) String added in v1.4.0

func (x *TrainCustomModelResponse) String() string

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.v1alpha.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1alpha.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.v1alpha.TransactionInfo.value]
	//
	// For example, if a user paid
	// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]
	// amount, then nominal (pre-discount) value of the transaction is the sum of
	// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]
	// and
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1alpha.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.v1alpha.TransactionInfo.discount_value]
	// can be larger than
	// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]:
	//
	// * Profit =
	// [value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1alpha.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 TuneEngineMetadata

type TuneEngineMetadata struct {

	// Required. The resource name of the engine that this tune applies to.
	// Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
	Engine string `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with a tune operation.

func (*TuneEngineMetadata) Descriptor deprecated

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

Deprecated: Use TuneEngineMetadata.ProtoReflect.Descriptor instead.

func (*TuneEngineMetadata) GetEngine

func (x *TuneEngineMetadata) GetEngine() string

func (*TuneEngineMetadata) ProtoMessage

func (*TuneEngineMetadata) ProtoMessage()

func (*TuneEngineMetadata) ProtoReflect

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

func (*TuneEngineMetadata) Reset

func (x *TuneEngineMetadata) Reset()

func (*TuneEngineMetadata) String

func (x *TuneEngineMetadata) String() string

type TuneEngineRequest

type TuneEngineRequest struct {

	// Required. The resource name of the engine to tune.
	// Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

func (*TuneEngineRequest) Descriptor deprecated

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

Deprecated: Use TuneEngineRequest.ProtoReflect.Descriptor instead.

func (*TuneEngineRequest) GetName

func (x *TuneEngineRequest) GetName() string

func (*TuneEngineRequest) ProtoMessage

func (*TuneEngineRequest) ProtoMessage()

func (*TuneEngineRequest) ProtoReflect

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

func (*TuneEngineRequest) Reset

func (x *TuneEngineRequest) Reset()

func (*TuneEngineRequest) String

func (x *TuneEngineRequest) String() string

type TuneEngineResponse

type TuneEngineResponse struct {
	// contains filtered or unexported fields
}

Response associated with a tune operation.

func (*TuneEngineResponse) Descriptor deprecated

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

Deprecated: Use TuneEngineResponse.ProtoReflect.Descriptor instead.

func (*TuneEngineResponse) ProtoMessage

func (*TuneEngineResponse) ProtoMessage()

func (*TuneEngineResponse) ProtoReflect

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

func (*TuneEngineResponse) Reset

func (x *TuneEngineResponse) Reset()

func (*TuneEngineResponse) String

func (x *TuneEngineResponse) String() string

type UnimplementedAclConfigServiceServer added in v1.6.0

type UnimplementedAclConfigServiceServer struct {
}

UnimplementedAclConfigServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAclConfigServiceServer) GetAclConfig added in v1.6.0

func (*UnimplementedAclConfigServiceServer) UpdateAclConfig added in v1.6.0

type UnimplementedChunkServiceServer added in v1.6.0

type UnimplementedChunkServiceServer struct {
}

UnimplementedChunkServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedChunkServiceServer) GetChunk added in v1.6.0

func (*UnimplementedChunkServiceServer) ListChunks added in v1.6.0

type UnimplementedCompletionServiceServer

type UnimplementedCompletionServiceServer struct {
}

UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCompletionServiceServer) CompleteQuery

func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries added in v1.6.0

func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries added in v1.6.0

type UnimplementedConversationalSearchServiceServer

type UnimplementedConversationalSearchServiceServer struct {
}

UnimplementedConversationalSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedConversationalSearchServiceServer) ConverseConversation

func (*UnimplementedConversationalSearchServiceServer) CreateConversation

func (*UnimplementedConversationalSearchServiceServer) DeleteConversation

func (*UnimplementedConversationalSearchServiceServer) GetConversation

func (*UnimplementedConversationalSearchServiceServer) ListConversations

func (*UnimplementedConversationalSearchServiceServer) UpdateConversation

type UnimplementedDataStoreServiceServer

type UnimplementedDataStoreServiceServer struct {
}

UnimplementedDataStoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataStoreServiceServer) CreateDataStore

func (*UnimplementedDataStoreServiceServer) DeleteDataStore

func (*UnimplementedDataStoreServiceServer) GetDataStore

func (*UnimplementedDataStoreServiceServer) GetDocumentProcessingConfig added in v1.6.0

func (*UnimplementedDataStoreServiceServer) ListDataStores

func (*UnimplementedDataStoreServiceServer) UpdateDataStore

func (*UnimplementedDataStoreServiceServer) UpdateDocumentProcessingConfig added in v1.6.0

type UnimplementedDocumentServiceServer

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentServiceServer) CreateDocument

func (*UnimplementedDocumentServiceServer) DeleteDocument

func (*UnimplementedDocumentServiceServer) GetDocument

func (*UnimplementedDocumentServiceServer) ImportDocuments

func (*UnimplementedDocumentServiceServer) ListDocuments

func (*UnimplementedDocumentServiceServer) PurgeDocuments

func (*UnimplementedDocumentServiceServer) UpdateDocument

type UnimplementedEngineServiceServer

type UnimplementedEngineServiceServer struct {
}

UnimplementedEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEngineServiceServer) CreateEngine

func (*UnimplementedEngineServiceServer) DeleteEngine

func (*UnimplementedEngineServiceServer) GetEngine

func (*UnimplementedEngineServiceServer) ListEngines

func (*UnimplementedEngineServiceServer) PauseEngine

func (*UnimplementedEngineServiceServer) ResumeEngine

func (*UnimplementedEngineServiceServer) TuneEngine

func (*UnimplementedEngineServiceServer) UpdateEngine

type UnimplementedEstimateBillingServiceServer added in v1.6.0

type UnimplementedEstimateBillingServiceServer struct {
}

UnimplementedEstimateBillingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEstimateBillingServiceServer) EstimateDataSize added in v1.6.0

type UnimplementedRecommendationServiceServer

type UnimplementedRecommendationServiceServer struct {
}

UnimplementedRecommendationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecommendationServiceServer) Recommend

type UnimplementedSchemaServiceServer

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSchemaServiceServer) CreateSchema

func (*UnimplementedSchemaServiceServer) DeleteSchema

func (*UnimplementedSchemaServiceServer) GetSchema

func (*UnimplementedSchemaServiceServer) ListSchemas

func (*UnimplementedSchemaServiceServer) UpdateSchema

type UnimplementedSearchServiceServer

type UnimplementedSearchServiceServer struct {
}

UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchServiceServer) Search

type UnimplementedSearchTuningServiceServer added in v1.4.0

type UnimplementedSearchTuningServiceServer struct {
}

UnimplementedSearchTuningServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchTuningServiceServer) TrainCustomModel added in v1.4.0

type UnimplementedServingConfigServiceServer added in v1.6.0

type UnimplementedServingConfigServiceServer struct {
}

UnimplementedServingConfigServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedServingConfigServiceServer) GetServingConfig added in v1.6.0

func (*UnimplementedServingConfigServiceServer) ListServingConfigs added in v1.6.0

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig added in v1.6.0

type UnimplementedSiteSearchEngineServiceServer

type UnimplementedSiteSearchEngineServiceServer struct {
}

UnimplementedSiteSearchEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites added in v1.4.0

func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris

func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite added in v1.4.0

type UnimplementedUserEventServiceServer

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent

func (*UnimplementedUserEventServiceServer) ImportUserEvents

func (*UnimplementedUserEventServiceServer) PurgeUserEvents

func (*UnimplementedUserEventServiceServer) WriteUserEvent

type UpdateAclConfigRequest added in v1.6.0

type UpdateAclConfigRequest struct {
	AclConfig *AclConfig `protobuf:"bytes,1,opt,name=acl_config,json=aclConfig,proto3" json:"acl_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for UpdateAclConfig method.

func (*UpdateAclConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use UpdateAclConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateAclConfigRequest) GetAclConfig added in v1.6.0

func (x *UpdateAclConfigRequest) GetAclConfig() *AclConfig

func (*UpdateAclConfigRequest) ProtoMessage added in v1.6.0

func (*UpdateAclConfigRequest) ProtoMessage()

func (*UpdateAclConfigRequest) ProtoReflect added in v1.6.0

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

func (*UpdateAclConfigRequest) Reset added in v1.6.0

func (x *UpdateAclConfigRequest) Reset()

func (*UpdateAclConfigRequest) String added in v1.6.0

func (x *UpdateAclConfigRequest) String() string

type UpdateConversationRequest

type UpdateConversationRequest struct {

	// Required. The Conversation to update.
	Conversation *Conversation `protobuf:"bytes,1,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// Indicates which fields in the provided
	// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
	// update. The following are NOT supported:
	//
	// * [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name]
	//
	// If not set or empty, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateConversation method.

func (*UpdateConversationRequest) Descriptor deprecated

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

Deprecated: Use UpdateConversationRequest.ProtoReflect.Descriptor instead.

func (*UpdateConversationRequest) GetConversation

func (x *UpdateConversationRequest) GetConversation() *Conversation

func (*UpdateConversationRequest) GetUpdateMask

func (x *UpdateConversationRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateConversationRequest) ProtoMessage

func (*UpdateConversationRequest) ProtoMessage()

func (*UpdateConversationRequest) ProtoReflect

func (*UpdateConversationRequest) Reset

func (x *UpdateConversationRequest) Reset()

func (*UpdateConversationRequest) String

func (x *UpdateConversationRequest) String() string

type UpdateDataStoreRequest

type UpdateDataStoreRequest struct {

	// Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
	// to update.
	//
	// If the caller does not have permission to update the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to
	// update does not exist, a NOT_FOUND error is returned.
	DataStore *DataStore `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Indicates which fields in the provided
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to update.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] method.

func (*UpdateDataStoreRequest) Descriptor deprecated

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

Deprecated: Use UpdateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataStoreRequest) GetDataStore

func (x *UpdateDataStoreRequest) GetDataStore() *DataStore

func (*UpdateDataStoreRequest) GetUpdateMask

func (x *UpdateDataStoreRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDataStoreRequest) ProtoMessage

func (*UpdateDataStoreRequest) ProtoMessage()

func (*UpdateDataStoreRequest) ProtoReflect

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

func (*UpdateDataStoreRequest) Reset

func (x *UpdateDataStoreRequest) Reset()

func (*UpdateDataStoreRequest) String

func (x *UpdateDataStoreRequest) String() string

type UpdateDocumentProcessingConfigRequest added in v1.6.0

type UpdateDocumentProcessingConfigRequest struct {

	// Required. The
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
	// to update.
	//
	// If the caller does not have permission to update the
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig],
	// then a PERMISSION_DENIED error is returned.
	//
	// If the
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
	// to update does not exist, a NOT_FOUND error is returned.
	DocumentProcessingConfig *DocumentProcessingConfig `` /* 135-byte string literal not displayed */
	// Indicates which fields in the provided
	// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
	// to update. The following are the only supported fields:
	//
	// * [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] method.

func (*UpdateDocumentProcessingConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use UpdateDocumentProcessingConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentProcessingConfigRequest) GetDocumentProcessingConfig added in v1.6.0

func (x *UpdateDocumentProcessingConfigRequest) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*UpdateDocumentProcessingConfigRequest) GetUpdateMask added in v1.6.0

func (*UpdateDocumentProcessingConfigRequest) ProtoMessage added in v1.6.0

func (*UpdateDocumentProcessingConfigRequest) ProtoMessage()

func (*UpdateDocumentProcessingConfigRequest) ProtoReflect added in v1.6.0

func (*UpdateDocumentProcessingConfigRequest) Reset added in v1.6.0

func (*UpdateDocumentProcessingConfigRequest) String added in v1.6.0

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.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1alpha.Document] to update
	// does not exist and
	// [allow_missing][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document] is not found, a
	// new [Document][google.cloud.discoveryengine.v1alpha.Document] will be
	// created.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// Indicates which fields in the provided imported 'document' to update. If
	// not set, will by default update all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.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) GetUpdateMask added in v1.6.0

func (x *UpdateDocumentRequest) GetUpdateMask() *fieldmaskpb.FieldMask

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 UpdateEngineRequest

type UpdateEngineRequest struct {

	// Required. The [Engine][google.cloud.discoveryengine.v1alpha.Engine] to
	// update.
	//
	// If the caller does not have permission to update the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] to update does
	// not exist, a NOT_FOUND error is returned.
	Engine *Engine `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
	// Indicates which fields in the provided
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine] to update.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] method.

func (*UpdateEngineRequest) Descriptor deprecated

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

Deprecated: Use UpdateEngineRequest.ProtoReflect.Descriptor instead.

func (*UpdateEngineRequest) GetEngine

func (x *UpdateEngineRequest) GetEngine() *Engine

func (*UpdateEngineRequest) GetUpdateMask

func (x *UpdateEngineRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateEngineRequest) ProtoMessage

func (*UpdateEngineRequest) ProtoMessage()

func (*UpdateEngineRequest) ProtoReflect

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

func (*UpdateEngineRequest) Reset

func (x *UpdateEngineRequest) Reset()

func (*UpdateEngineRequest) String

func (x *UpdateEngineRequest) String() string

type UpdateSchemaMetadata

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

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

Deprecated: Use UpdateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*UpdateSchemaMetadata) GetCreateTime

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

func (*UpdateSchemaMetadata) GetUpdateTime

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

func (*UpdateSchemaMetadata) ProtoMessage

func (*UpdateSchemaMetadata) ProtoMessage()

func (*UpdateSchemaMetadata) ProtoReflect

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

func (*UpdateSchemaMetadata) Reset

func (x *UpdateSchemaMetadata) Reset()

func (*UpdateSchemaMetadata) String

func (x *UpdateSchemaMetadata) String() string

type UpdateSchemaRequest

type UpdateSchemaRequest struct {

	// Required. The [Schema][google.cloud.discoveryengine.v1alpha.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.v1alpha.Schema] is not found, a new
	// [Schema][google.cloud.discoveryengine.v1alpha.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.v1alpha.SchemaService.UpdateSchema] method.

func (*UpdateSchemaRequest) Descriptor deprecated

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

Deprecated: Use UpdateSchemaRequest.ProtoReflect.Descriptor instead.

func (*UpdateSchemaRequest) GetAllowMissing

func (x *UpdateSchemaRequest) GetAllowMissing() bool

func (*UpdateSchemaRequest) GetSchema

func (x *UpdateSchemaRequest) GetSchema() *Schema

func (*UpdateSchemaRequest) ProtoMessage

func (*UpdateSchemaRequest) ProtoMessage()

func (*UpdateSchemaRequest) ProtoReflect

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

func (*UpdateSchemaRequest) Reset

func (x *UpdateSchemaRequest) Reset()

func (*UpdateSchemaRequest) String

func (x *UpdateSchemaRequest) String() string

type UpdateServingConfigRequest added in v1.6.0

type UpdateServingConfigRequest struct {

	// Required. The ServingConfig to update.
	ServingConfig *ServingConfig `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Indicates which fields in the provided
	// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] to
	// update. The following are NOT supported:
	//
	// * [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateServingConfig method.

func (*UpdateServingConfigRequest) Descriptor deprecated added in v1.6.0

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

Deprecated: Use UpdateServingConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateServingConfigRequest) GetServingConfig added in v1.6.0

func (x *UpdateServingConfigRequest) GetServingConfig() *ServingConfig

func (*UpdateServingConfigRequest) GetUpdateMask added in v1.6.0

func (x *UpdateServingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateServingConfigRequest) ProtoMessage added in v1.6.0

func (*UpdateServingConfigRequest) ProtoMessage()

func (*UpdateServingConfigRequest) ProtoReflect added in v1.6.0

func (*UpdateServingConfigRequest) Reset added in v1.6.0

func (x *UpdateServingConfigRequest) Reset()

func (*UpdateServingConfigRequest) String added in v1.6.0

func (x *UpdateServingConfigRequest) String() string

type UpdateTargetSiteMetadata added in v1.4.0

type UpdateTargetSiteMetadata 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 related to the progress of the [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*UpdateTargetSiteMetadata) Descriptor deprecated added in v1.4.0

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

Deprecated: Use UpdateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*UpdateTargetSiteMetadata) GetCreateTime added in v1.4.0

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

func (*UpdateTargetSiteMetadata) GetUpdateTime added in v1.4.0

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

func (*UpdateTargetSiteMetadata) ProtoMessage added in v1.4.0

func (*UpdateTargetSiteMetadata) ProtoMessage()

func (*UpdateTargetSiteMetadata) ProtoReflect added in v1.4.0

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

func (*UpdateTargetSiteMetadata) Reset added in v1.4.0

func (x *UpdateTargetSiteMetadata) Reset()

func (*UpdateTargetSiteMetadata) String added in v1.4.0

func (x *UpdateTargetSiteMetadata) String() string

type UpdateTargetSiteRequest added in v1.4.0

type UpdateTargetSiteRequest struct {

	// Required. The target site to update.
	// If the caller does not have permission to update the
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] to
	// update does not exist, a NOT_FOUND error is returned.
	TargetSite *TargetSite `protobuf:"bytes,1,opt,name=target_site,json=targetSite,proto3" json:"target_site,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] method.

func (*UpdateTargetSiteRequest) Descriptor deprecated added in v1.4.0

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

Deprecated: Use UpdateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*UpdateTargetSiteRequest) GetTargetSite added in v1.4.0

func (x *UpdateTargetSiteRequest) GetTargetSite() *TargetSite

func (*UpdateTargetSiteRequest) ProtoMessage added in v1.4.0

func (*UpdateTargetSiteRequest) ProtoMessage()

func (*UpdateTargetSiteRequest) ProtoReflect added in v1.4.0

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

func (*UpdateTargetSiteRequest) Reset added in v1.4.0

func (x *UpdateTargetSiteRequest) Reset()

func (*UpdateTargetSiteRequest) String added in v1.4.0

func (x *UpdateTargetSiteRequest) 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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.RecommendationService.Recommend].
	// This field enables accurate attribution of recommendation model
	// performance.
	//
	// The value must be one of:
	//
	// * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token] for events that are the result of
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
	// * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token] for events that are the result of
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
	//
	// 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
	// [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token]
	// as a URL parameter to product K's page. When recording events on product
	// K's page, log the
	// [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.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.v1alpha.SearchRequest] may
	// contain a filter expression in
	// [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter]
	// conforming to https://google.aip.dev/160#filtering.
	//
	// Similarly, for `view-item-list` events that are generated from a
	// [RecommendRequest][google.cloud.discoveryengine.v1alpha.RecommendRequest],
	// this field may be populated directly from
	// [RecommendRequest.filter][google.cloud.discoveryengine.v1alpha.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 [Document][google.cloud.discoveryengine.v1alpha.Document]s
	// 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.v1alpha.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"`
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
	// 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"`
	// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]
	// 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 third-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)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(ctx context.Context, in *PurgeUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, 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.

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 third-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)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, 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.
	//
	// 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.v1alpha.UserEventService.CollectUserEvent]
	// or if
	// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1alpha.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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL