discoveryenginepb

package
v1.15.0 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: Apache-2.0 Imports: 18 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Answer_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "IN_PROGRESS",
		2: "FAILED",
		3: "SUCCEEDED",
	}
	Answer_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"IN_PROGRESS":       1,
		"FAILED":            2,
		"SUCCEEDED":         3,
	}
)

Enum value maps for Answer_State.

View Source 
var (
	Answer_AnswerSkippedReason_name = map[int32]string{
		0: "ANSWER_SKIPPED_REASON_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY_IGNORED",
		2: "NON_ANSWER_SEEKING_QUERY_IGNORED",
		3: "OUT_OF_DOMAIN_QUERY_IGNORED",
		4: "POTENTIAL_POLICY_VIOLATION",
		5: "NO_RELEVANT_CONTENT",
		6: "JAIL_BREAKING_QUERY_IGNORED",
		7: "CUSTOMER_POLICY_VIOLATION",
	}
	Answer_AnswerSkippedReason_value = map[string]int32{
		"ANSWER_SKIPPED_REASON_UNSPECIFIED": 0,
		"ADVERSARIAL_QUERY_IGNORED":         1,
		"NON_ANSWER_SEEKING_QUERY_IGNORED":  2,
		"OUT_OF_DOMAIN_QUERY_IGNORED":       3,
		"POTENTIAL_POLICY_VIOLATION":        4,
		"NO_RELEVANT_CONTENT":               5,
		"JAIL_BREAKING_QUERY_IGNORED":       6,
		"CUSTOMER_POLICY_VIOLATION":         7,
	}
)

Enum value maps for Answer_AnswerSkippedReason.

View Source 
var (
	Answer_Step_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "IN_PROGRESS",
		2: "FAILED",
		3: "SUCCEEDED",
	}
	Answer_Step_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"IN_PROGRESS":       1,
		"FAILED":            2,
		"SUCCEEDED":         3,
	}
)

Enum value maps for Answer_Step_State.

View Source 
var (
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY",
		2: "NON_ANSWER_SEEKING_QUERY",
		3: "JAIL_BREAKING_QUERY",
	}
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":         0,
		"ADVERSARIAL_QUERY":        1,
		"NON_ANSWER_SEEKING_QUERY": 2,
		"JAIL_BREAKING_QUERY":      3,
	}
)

Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.

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

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",
		4: "SOLUTION_TYPE_GENERATIVE_CHAT",
	}
	SolutionType_value = map[string]int32{
		"SOLUTION_TYPE_UNSPECIFIED":     0,
		"SOLUTION_TYPE_RECOMMENDATION":  1,
		"SOLUTION_TYPE_SEARCH":          2,
		"SOLUTION_TYPE_CHAT":            3,
		"SOLUTION_TYPE_GENERATIVE_CHAT": 4,
	}
)

Enum value maps for SolutionType.

View Source 
var (
	SearchUseCase_name = map[int32]string{
		0: "SEARCH_USE_CASE_UNSPECIFIED",
		1: "SEARCH_USE_CASE_SEARCH",
		2: "SEARCH_USE_CASE_BROWSE",
	}
	SearchUseCase_value = map[string]int32{
		"SEARCH_USE_CASE_UNSPECIFIED": 0,
		"SEARCH_USE_CASE_SEARCH":      1,
		"SEARCH_USE_CASE_BROWSE":      2,
	}
)

Enum value maps for SearchUseCase.

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 (
	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 (
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY",
		2: "NON_ANSWER_SEEKING_QUERY",
		3: "JAIL_BREAKING_QUERY",
	}
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":         0,
		"ADVERSARIAL_QUERY":        1,
		"NON_ANSWER_SEEKING_QUERY": 2,
		"JAIL_BREAKING_QUERY":      3,
	}
)

Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.

View Source 
var (
	CustomTuningModel_ModelState_name = map[int32]string{
		0: "MODEL_STATE_UNSPECIFIED",
		1: "TRAINING_PAUSED",
		2: "TRAINING",
		3: "TRAINING_COMPLETE",
		4: "READY_FOR_SERVING",
		5: "TRAINING_FAILED",
		6: "NO_IMPROVEMENT",
		7: "INPUT_VALIDATION_FAILED",
	}
	CustomTuningModel_ModelState_value = map[string]int32{
		"MODEL_STATE_UNSPECIFIED": 0,
		"TRAINING_PAUSED":         1,
		"TRAINING":                2,
		"TRAINING_COMPLETE":       3,
		"READY_FOR_SERVING":       4,
		"TRAINING_FAILED":         5,
		"NO_IMPROVEMENT":          6,
		"INPUT_VALIDATION_FAILED": 7,
	}
)

Enum value maps for CustomTuningModel_ModelState.

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 (
	BatchGetDocumentsMetadataResponse_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "INDEXED",
		2: "NOT_IN_TARGET_SITE",
		3: "NOT_IN_INDEX",
	}
	BatchGetDocumentsMetadataResponse_State_value = map[string]int32{
		"STATE_UNSPECIFIED":  0,
		"INDEXED":            1,
		"NOT_IN_TARGET_SITE": 2,
		"NOT_IN_INDEX":       3,
	}
)

Enum value maps for BatchGetDocumentsMetadataResponse_State.

View Source 
var (
	Evaluation_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "RUNNING",
		3: "SUCCEEDED",
		4: "FAILED",
	}
	Evaluation_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"RUNNING":           2,
		"SUCCEEDED":         3,
		"FAILED":            4,
	}
)

Enum value maps for Evaluation_State.

View Source 
var (
	BigtableOptions_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "STRING",
		2: "NUMBER",
		3: "INTEGER",
		4: "VAR_INTEGER",
		5: "BIG_NUMERIC",
		6: "BOOLEAN",
		7: "JSON",
	}
	BigtableOptions_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"STRING":           1,
		"NUMBER":           2,
		"INTEGER":          3,
		"VAR_INTEGER":      4,
		"BIG_NUMERIC":      5,
		"BOOLEAN":          6,
		"JSON":             7,
	}
)

Enum value maps for BigtableOptions_Type.

View Source 
var (
	BigtableOptions_Encoding_name = map[int32]string{
		0: "ENCODING_UNSPECIFIED",
		1: "TEXT",
		2: "BINARY",
	}
	BigtableOptions_Encoding_value = map[string]int32{
		"ENCODING_UNSPECIFIED": 0,
		"TEXT":                 1,
		"BINARY":               2,
	}
)

Enum value maps for BigtableOptions_Encoding.

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 (
	Project_ServiceTerms_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "TERMS_ACCEPTED",
		2: "TERMS_PENDING",
		3: "TERMS_DECLINED",
	}
	Project_ServiceTerms_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"TERMS_ACCEPTED":    1,
		"TERMS_PENDING":     2,
		"TERMS_DECLINED":    3,
	}
)

Enum value maps for Project_ServiceTerms_State.

View Source 
var (
	SearchRequest_RelevanceThreshold_name = map[int32]string{
		0: "RELEVANCE_THRESHOLD_UNSPECIFIED",
		1: "LOWEST",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
	}
	SearchRequest_RelevanceThreshold_value = map[string]int32{
		"RELEVANCE_THRESHOLD_UNSPECIFIED": 0,
		"LOWEST":                          1,
		"LOW":                             2,
		"MEDIUM":                          3,
		"HIGH":                            4,
	}
)

Enum value maps for SearchRequest_RelevanceThreshold.

View Source 
var (
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name = map[int32]string{
		0: "ATTRIBUTE_TYPE_UNSPECIFIED",
		1: "NUMERICAL",
		2: "FRESHNESS",
	}
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value = map[string]int32{
		"ATTRIBUTE_TYPE_UNSPECIFIED": 0,
		"NUMERICAL":                  1,
		"FRESHNESS":                  2,
	}
)

Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.

View Source 
var (
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name = map[int32]string{
		0: "INTERPOLATION_TYPE_UNSPECIFIED",
		1: "LINEAR",
	}
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value = map[string]int32{
		"INTERPOLATION_TYPE_UNSPECIFIED": 0,
		"LINEAR":                         1,
	}
)

Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.

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 (
	SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_name = map[int32]string{
		0: "CONDITION_UNSPECIFIED",
		1: "DISABLED",
		2: "ENABLED",
	}
	SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_value = map[string]int32{
		"CONDITION_UNSPECIFIED": 0,
		"DISABLED":              1,
		"ENABLED":               2,
	}
)

Enum value maps for SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition.

View Source 
var (
	SearchRequest_SearchAsYouTypeSpec_Condition_name = map[int32]string{
		0: "CONDITION_UNSPECIFIED",
		1: "DISABLED",
		2: "ENABLED",
	}
	SearchRequest_SearchAsYouTypeSpec_Condition_value = map[string]int32{
		"CONDITION_UNSPECIFIED": 0,
		"DISABLED":              1,
		"ENABLED":               2,
	}
)

Enum value maps for SearchRequest_SearchAsYouTypeSpec_Condition.

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",
		6: "NO_RELEVANT_CONTENT",
		7: "JAIL_BREAKING_QUERY_IGNORED",
		8: "CUSTOMER_POLICY_VIOLATION",
	}
	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,
		"NO_RELEVANT_CONTENT":                6,
		"JAIL_BREAKING_QUERY_IGNORED":        7,
		"CUSTOMER_POLICY_VIOLATION":          8,
	}
)

Enum value maps for SearchResponse_Summary_SummarySkippedReason.

View Source 
var (
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison_name = map[int32]string{
		0: "COMPARISON_UNSPECIFIED",
		1: "EQUALS",
		2: "LESS_THAN_EQUALS",
		3: "LESS_THAN",
		4: "GREATER_THAN_EQUALS",
		5: "GREATER_THAN",
	}
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison_value = map[string]int32{
		"COMPARISON_UNSPECIFIED": 0,
		"EQUALS":                 1,
		"LESS_THAN_EQUALS":       2,
		"LESS_THAN":              3,
		"GREATER_THAN_EQUALS":    4,
		"GREATER_THAN":           5,
	}
)

Enum value maps for SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison.

View Source 
var (
	SearchResponse_OneBoxResult_OneBoxType_name = map[int32]string{
		0: "ONE_BOX_TYPE_UNSPECIFIED",
		1: "PEOPLE",
		2: "ORGANIZATION",
		3: "SLACK",
	}
	SearchResponse_OneBoxResult_OneBoxType_value = map[string]int32{
		"ONE_BOX_TYPE_UNSPECIFIED": 0,
		"PEOPLE":                   1,
		"ORGANIZATION":             2,
		"SLACK":                    3,
	}
)

Enum value maps for SearchResponse_OneBoxResult_OneBoxType.

View Source 
var (
	Session_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "IN_PROGRESS",
	}
	Session_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"IN_PROGRESS":       1,
	}
)

Enum value maps for Session_State.

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_v1beta_answer_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_chunk_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_common_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_completion_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_completion_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_control_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_control_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_conversation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_conversational_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_custom_tuning_model_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_data_store_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_data_store_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_document_processing_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_document_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_document_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_evaluation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_evaluation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_grounded_generation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_grounding_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_import_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_project_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_project_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_purge_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_rank_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_recommendation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_sample_query_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_sample_query_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_sample_query_set_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_sample_query_set_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_schema_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_schema_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_search_tuning_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_serving_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_serving_config_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_session_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_site_search_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_site_search_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_user_event_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1beta_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterCompletionServiceServer added in v0.3.0 

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

func RegisterControlServiceServer added in v1.8.0 

func RegisterControlServiceServer(s *grpc.Server, srv ControlServiceServer)

func RegisterConversationalSearchServiceServer added in v1.1.0 

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

func RegisterDataStoreServiceServer added in v1.5.0 

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

func RegisterDocumentServiceServer 

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

func RegisterEngineServiceServer added in v1.5.0 

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

func RegisterEvaluationServiceServer added in v1.10.0 

func RegisterEvaluationServiceServer(s *grpc.Server, srv EvaluationServiceServer)

func RegisterGroundedGenerationServiceServer added in v1.7.0 

func RegisterGroundedGenerationServiceServer(s *grpc.Server, srv GroundedGenerationServiceServer)

func RegisterProjectServiceServer added in v1.8.0 

func RegisterProjectServiceServer(s *grpc.Server, srv ProjectServiceServer)

func RegisterRankServiceServer added in v1.7.0 

func RegisterRankServiceServer(s *grpc.Server, srv RankServiceServer)

func RegisterRecommendationServiceServer 

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

func RegisterSampleQueryServiceServer added in v1.10.0 

func RegisterSampleQueryServiceServer(s *grpc.Server, srv SampleQueryServiceServer)

func RegisterSampleQuerySetServiceServer added in v1.10.0 

func RegisterSampleQuerySetServiceServer(s *grpc.Server, srv SampleQuerySetServiceServer)

func RegisterSchemaServiceServer added in v0.3.0 

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

func RegisterSearchServiceServer added in v0.3.0 

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

func RegisterSearchTuningServiceServer added in v1.6.0 

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

func RegisterServingConfigServiceServer added in v1.5.0 

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

func RegisterSiteSearchEngineServiceServer added in v1.5.0 

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

func RegisterUserEventServiceServer 

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

Types

type AlloyDbSource added in v1.11.0 

type AlloyDbSource struct {

	// The project ID that contains the AlloyDB source.
	// Has 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 AlloyDB location to copy the data from with a length limit of
	// 256 characters.
	LocationId string `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// Required. The AlloyDB cluster to copy the data from with a length limit of
	// 256 characters.
	ClusterId string `protobuf:"bytes,3,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
	// Required. The AlloyDB database to copy the data from with a length limit of
	// 256 characters.
	DatabaseId string `protobuf:"bytes,4,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The AlloyDB table to copy the data from with a length limit of
	// 256 characters.
	TableId string `protobuf:"bytes,5,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
	// AlloyDB export to a specific Cloud Storage directory.
	//
	// Ensure that the AlloyDB service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,6,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// contains filtered or unexported fields
}

AlloyDB source import data from.

func (*AlloyDbSource) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.

func (*AlloyDbSource) GetClusterId added in v1.11.0 

func (x *AlloyDbSource) GetClusterId() string

func (*AlloyDbSource) GetDatabaseId added in v1.11.0 

func (x *AlloyDbSource) GetDatabaseId() string

func (*AlloyDbSource) GetGcsStagingDir added in v1.11.0 

func (x *AlloyDbSource) GetGcsStagingDir() string

func (*AlloyDbSource) GetLocationId added in v1.11.0 

func (x *AlloyDbSource) GetLocationId() string

func (*AlloyDbSource) GetProjectId added in v1.11.0 

func (x *AlloyDbSource) GetProjectId() string

func (*AlloyDbSource) GetTableId added in v1.11.0 

func (x *AlloyDbSource) GetTableId() string

func (*AlloyDbSource) ProtoMessage added in v1.11.0 

func (*AlloyDbSource) ProtoMessage()

func (*AlloyDbSource) ProtoReflect added in v1.11.0 

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

func (*AlloyDbSource) Reset added in v1.11.0 

func (x *AlloyDbSource) Reset()

func (*AlloyDbSource) String added in v1.11.0 

func (x *AlloyDbSource) String() string

type Answer added in v1.7.0 

type Answer struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the answer generation.
	State Answer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_State" json:"state,omitempty"`
	// The textual answer.
	AnswerText string `protobuf:"bytes,3,opt,name=answer_text,json=answerText,proto3" json:"answer_text,omitempty"`
	// Citations.
	Citations []*Answer_Citation `protobuf:"bytes,4,rep,name=citations,proto3" json:"citations,omitempty"`
	// References.
	References []*Answer_Reference `protobuf:"bytes,5,rep,name=references,proto3" json:"references,omitempty"`
	// Suggested related questions.
	RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
	// Answer generation steps.
	Steps []*Answer_Step `protobuf:"bytes,7,rep,name=steps,proto3" json:"steps,omitempty"`
	// Query understanding information.
	QueryUnderstandingInfo *Answer_QueryUnderstandingInfo `` /* 130-byte string literal not displayed */
	// Additional answer-skipped reasons. This provides the reason for ignored
	// cases. If nothing is skipped, this field is not set.
	AnswerSkippedReasons []Answer_AnswerSkippedReason `` /* 200-byte string literal not displayed */
	// Output only. Answer creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Answer completed timestamp.
	CompleteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
	// contains filtered or unexported fields
}

Defines an answer.

func (*Answer) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer.ProtoReflect.Descriptor instead.

func (*Answer) GetAnswerSkippedReasons added in v1.7.0 

func (x *Answer) GetAnswerSkippedReasons() []Answer_AnswerSkippedReason

func (*Answer) GetAnswerText added in v1.7.0 

func (x *Answer) GetAnswerText() string

func (*Answer) GetCitations added in v1.7.0 

func (x *Answer) GetCitations() []*Answer_Citation

func (*Answer) GetCompleteTime added in v1.7.0 

func (x *Answer) GetCompleteTime() *timestamppb.Timestamp

func (*Answer) GetCreateTime added in v1.7.0 

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

func (*Answer) GetName added in v1.7.0 

func (x *Answer) GetName() string

func (*Answer) GetQueryUnderstandingInfo added in v1.7.0 

func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfo

func (*Answer) GetReferences added in v1.7.0 

func (x *Answer) GetReferences() []*Answer_Reference

func (*Answer) GetRelatedQuestions added in v1.7.0 

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

func (*Answer) GetState added in v1.7.0 

func (x *Answer) GetState() Answer_State

func (*Answer) GetSteps added in v1.7.0 

func (x *Answer) GetSteps() []*Answer_Step

func (*Answer) ProtoMessage added in v1.7.0 

func (*Answer) ProtoMessage()

func (*Answer) ProtoReflect added in v1.7.0 

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

func (*Answer) Reset added in v1.7.0 

func (x *Answer) Reset()

func (*Answer) String added in v1.7.0 

func (x *Answer) String() string

type AnswerQueryRequest added in v1.7.0 

type AnswerQueryRequest 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/*/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"`
	// Required. Current user query.
	Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The session resource name. Not required.
	//
	// When session field is not set, the API is in sessionless mode.
	//
	// We support auto session mode: users can use the wildcard symbol `-` as
	// session ID.  A new ID will be automatically generated and assigned.
	Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
	// Model specification.
	SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
	// Related questions specification.
	RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
	// Answer generation specification.
	AnswerGenerationSpec *AnswerQueryRequest_AnswerGenerationSpec `protobuf:"bytes,7,opt,name=answer_generation_spec,json=answerGenerationSpec,proto3" json:"answer_generation_spec,omitempty"`
	// Search specification.
	SearchSpec *AnswerQueryRequest_SearchSpec `protobuf:"bytes,8,opt,name=search_spec,json=searchSpec,proto3" json:"search_spec,omitempty"`
	// Query understanding specification.
	QueryUnderstandingSpec *AnswerQueryRequest_QueryUnderstandingSpec `` /* 129-byte string literal not displayed */
	// Asynchronous mode control.
	//
	// If enabled, the response will be returned with answer/session resource
	// name without final answer. The API users need to do the polling to get
	// the latest status of answer/session by calling
	// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
	// or
	// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
	// method.
	AsynchronousMode bool `protobuf:"varint,10,opt,name=asynchronous_mode,json=asynchronousMode,proto3" json:"asynchronous_mode,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`.
	//
	// 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,12,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.

func (*AnswerQueryRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest) GetAnswerGenerationSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetAnswerGenerationSpec() *AnswerQueryRequest_AnswerGenerationSpec

func (*AnswerQueryRequest) GetAsynchronousMode added in v1.7.0 

func (x *AnswerQueryRequest) GetAsynchronousMode() bool

func (*AnswerQueryRequest) GetQuery added in v1.7.0 

func (x *AnswerQueryRequest) GetQuery() *Query

func (*AnswerQueryRequest) GetQueryUnderstandingSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetQueryUnderstandingSpec() *AnswerQueryRequest_QueryUnderstandingSpec

func (*AnswerQueryRequest) GetRelatedQuestionsSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetRelatedQuestionsSpec() *AnswerQueryRequest_RelatedQuestionsSpec

func (*AnswerQueryRequest) GetSafetySpec added in v1.7.0 

func (x *AnswerQueryRequest) GetSafetySpec() *AnswerQueryRequest_SafetySpec

func (*AnswerQueryRequest) GetSearchSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetSearchSpec() *AnswerQueryRequest_SearchSpec

func (*AnswerQueryRequest) GetServingConfig added in v1.7.0 

func (x *AnswerQueryRequest) GetServingConfig() string

func (*AnswerQueryRequest) GetSession added in v1.7.0 

func (x *AnswerQueryRequest) GetSession() string

func (*AnswerQueryRequest) GetUserLabels added in v1.11.0 

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

func (*AnswerQueryRequest) GetUserPseudoId added in v1.7.0 

func (x *AnswerQueryRequest) GetUserPseudoId() string

func (*AnswerQueryRequest) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest) ProtoMessage()

func (*AnswerQueryRequest) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest) Reset added in v1.7.0 

func (x *AnswerQueryRequest) Reset()

func (*AnswerQueryRequest) String added in v1.7.0 

func (x *AnswerQueryRequest) String() string

type AnswerQueryRequest_AnswerGenerationSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec struct {

	// Answer generation model specification.
	ModelSpec *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec `protobuf:"bytes,1,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
	// Answer generation prompt specification.
	PromptSpec *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec `protobuf:"bytes,2,opt,name=prompt_spec,json=promptSpec,proto3" json:"prompt_spec,omitempty"`
	// Specifies whether to include citation metadata in the answer. The default
	// value is `false`.
	IncludeCitations bool `protobuf:"varint,3,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
	// Language code for Answer. Use language tags defined by
	// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
	// Note: This is an experimental feature.
	AnswerLanguageCode string `protobuf:"bytes,4,opt,name=answer_language_code,json=answerLanguageCode,proto3" json:"answer_language_code,omitempty"`
	// Specifies whether to filter out adversarial queries. The default value
	// is `false`.
	//
	// Google employs search-query classification to detect adversarial
	// queries. No answer 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 answers 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 answer-seeking.
	// The default value is `false`.
	//
	// Google employs search-query classification to detect answer-seeking
	// queries. No answer is returned if the search query is classified as a
	// non-answer seeking query. If this field is set to `true`, we skip
	// generating answers for non-answer seeking queries and return
	// fallback messages instead.
	IgnoreNonAnswerSeekingQuery bool `` /* 149-byte string literal not displayed */
	// Specifies whether to filter out queries that have low relevance.
	//
	// If this field is set to `false`, all search results are used regardless
	// of relevance to generate answers. If set to `true` or unset, the behavior
	// will be determined automatically by the service.
	IgnoreLowRelevantContent *bool `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Answer generation specification.

func (*AnswerQueryRequest_AnswerGenerationSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode() string

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec() *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec() *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec struct {

	// Model version. If not set, it will use the default stable model.
	// Allowed values are: stable, preview.
	ModelVersion string `protobuf:"bytes,1,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// contains filtered or unexported fields
}

Answer Generation Model specification.

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion() string

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec struct {

	// Customized preamble.
	Preamble string `protobuf:"bytes,1,opt,name=preamble,proto3" json:"preamble,omitempty"`
	// contains filtered or unexported fields
}

Answer generation prompt specification.

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble() string

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec struct {

	// Query classification specification.
	QueryClassificationSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec `` /* 132-byte string literal not displayed */
	// Query rephraser specification.
	QueryRephraserSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec `protobuf:"bytes,2,opt,name=query_rephraser_spec,json=queryRephraserSpec,proto3" json:"query_rephraser_spec,omitempty"`
	// contains filtered or unexported fields
}

Query understanding specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {

	// Enabled query classification types.
	Types []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type `` /* 183-byte string literal not displayed */
	// contains filtered or unexported fields
}

Query classification specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes() []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type int32

Query classification types. 

const (
	// Unspecified query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 0
	// Adversarial query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 1
	// Non-answer-seeking query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 2
	// Jail-breaking query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 3
)

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor added in v1.7.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String() string

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type added in v1.7.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type() protoreflect.EnumType

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec struct {

	// Disable query rephraser.
	Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
	// Max rephrase steps.
	// The max number is 5 steps.
	// If not set or set to < 1, it will be set to 1 by default.
	MaxRephraseSteps int32 `protobuf:"varint,2,opt,name=max_rephrase_steps,json=maxRephraseSteps,proto3" json:"max_rephrase_steps,omitempty"`
	// contains filtered or unexported fields
}

Query rephraser specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable() bool

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps() int32

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String() string

type AnswerQueryRequest_RelatedQuestionsSpec added in v1.7.0 

type AnswerQueryRequest_RelatedQuestionsSpec struct {

	// Enable related questions feature if true.
	Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
	// contains filtered or unexported fields
}

Related questions specification.

func (*AnswerQueryRequest_RelatedQuestionsSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_RelatedQuestionsSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_RelatedQuestionsSpec) GetEnable added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) GetEnable() bool

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage()

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_RelatedQuestionsSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) Reset()

func (*AnswerQueryRequest_RelatedQuestionsSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) String() string

type AnswerQueryRequest_SafetySpec added in v1.7.0 

type AnswerQueryRequest_SafetySpec struct {

	// Enable the safety filtering on the answer response. It is false by
	// default.
	Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
	// contains filtered or unexported fields
}

Safety specification.

func (*AnswerQueryRequest_SafetySpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SafetySpec) GetEnable added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) GetEnable() bool

func (*AnswerQueryRequest_SafetySpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SafetySpec) ProtoMessage()

func (*AnswerQueryRequest_SafetySpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SafetySpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) Reset()

func (*AnswerQueryRequest_SafetySpec) String added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) String() string

type AnswerQueryRequest_SearchSpec added in v1.7.0 

type AnswerQueryRequest_SearchSpec struct {

	// Search parameters to control the search behavior.
	// Or provide search result list to generate answer.
	//
	// Types that are assignable to Input:
	//
	//	*AnswerQueryRequest_SearchSpec_SearchParams_
	//	*AnswerQueryRequest_SearchSpec_SearchResultList_
	Input isAnswerQueryRequest_SearchSpec_Input `protobuf_oneof:"input"`
	// contains filtered or unexported fields
}

Search specification.

func (*AnswerQueryRequest_SearchSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec) GetInput added in v1.7.0 

func (m *AnswerQueryRequest_SearchSpec) GetInput() isAnswerQueryRequest_SearchSpec_Input

func (*AnswerQueryRequest_SearchSpec) GetSearchParams added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchParams() *AnswerQueryRequest_SearchSpec_SearchParams

func (*AnswerQueryRequest_SearchSpec) GetSearchResultList added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchResultList() *AnswerQueryRequest_SearchSpec_SearchResultList

func (*AnswerQueryRequest_SearchSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) Reset()

func (*AnswerQueryRequest_SearchSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) String() string

type AnswerQueryRequest_SearchSpec_SearchParams added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchParams struct {

	// Number of search results to return.
	// The default value is 10.
	MaxReturnResults int32 `protobuf:"varint,1,opt,name=max_return_results,json=maxReturnResults,proto3" json:"max_return_results,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 Answer 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 customers 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,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Boost specification to boost certain documents in search results which
	// may affect the answer query response. For more information on boosting,
	// see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,3,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// The order in which documents are returned. Documents can be ordered
	// by a field in an
	// [Document][google.cloud.discoveryengine.v1beta.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,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Specifies the search result mode. If unspecified, the
	// search result mode defaults to `DOCUMENTS`.
	// See [parse and chunk
	// documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
	SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `` /* 202-byte string literal not displayed */
	// Specs defining dataStores to filter on in a search call and
	// configurations for those dataStores. This is only considered for
	// engines with multiple dataStores use case. For single dataStore within
	// an engine, they should use the specs at the top level.
	DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,7,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
	// contains filtered or unexported fields
}

Search parameters.

func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec() *SearchRequest_BoostSpec

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetFilter() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode added in v1.10.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultMode

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchParams) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) String() string

type AnswerQueryRequest_SearchSpec_SearchParams_ added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchParams_ struct {
	// Search parameters.
	SearchParams *AnswerQueryRequest_SearchSpec_SearchParams `protobuf:"bytes,1,opt,name=search_params,json=searchParams,proto3,oneof"`
}

type AnswerQueryRequest_SearchSpec_SearchResultList added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList struct {

	// Search results.
	SearchResults []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult `protobuf:"bytes,1,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
	// contains filtered or unexported fields
}

Search result list.

func (*AnswerQueryRequest_SearchSpec_SearchResultList) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_ added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_ struct {
	// Search result list.
	SearchResultList *AnswerQueryRequest_SearchSpec_SearchResultList `protobuf:"bytes,2,opt,name=search_result_list,json=searchResultList,proto3,oneof"`
}

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult struct {

	// Search result content.
	//
	// Types that are assignable to Content:
	//
	//	*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_
	//	*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_
	Content isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Search result.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent added in v1.7.0 

func (m *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent() isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo struct {

	// Chunk resource name.
	Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Chunk textual content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_ added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_ struct {
	// Chunk information.
	ChunkInfo *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo `protobuf:"bytes,2,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// URI for the document.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// List of document contexts.
	DocumentContexts []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext `protobuf:"bytes,4,rep,name=document_contexts,json=documentContexts,proto3" json:"document_contexts,omitempty"`
	// List of extractive segments.
	ExtractiveSegments []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment `protobuf:"bytes,5,rep,name=extractive_segments,json=extractiveSegments,proto3" json:"extractive_segments,omitempty"`
	// List of extractive answers.
	ExtractiveAnswers []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer `protobuf:"bytes,6,rep,name=extractive_answers,json=extractiveAnswers,proto3" json:"extractive_answers,omitempty"`
	// contains filtered or unexported fields
}

Unstructured document information.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ struct {
	// Unstructured document information.
	UnstructuredDocumentInfo *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo `protobuf:"bytes,1,opt,name=unstructured_document_info,json=unstructuredDocumentInfo,proto3,oneof"`
}

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext struct {

	// Page identifier.
	PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// Document content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Document context.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer struct {

	// Page identifier.
	PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// Extractive answer content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment struct {

	// Page identifier.
	PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// Extractive segment content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String() string

type AnswerQueryResponse added in v1.7.0 

type AnswerQueryResponse struct {

	// Answer resource object.
	// If
	// [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
	// is greater than 1, use
	// [Answer.name][google.cloud.discoveryengine.v1beta.Answer.name] to fetch
	// answer information using
	// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
	// API.
	Answer *Answer `protobuf:"bytes,1,opt,name=answer,proto3" json:"answer,omitempty"`
	// Session resource object.
	// It will be only available when session field is set and valid in the
	// [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest]
	// request.
	Session *Session `protobuf:"bytes,2,opt,name=session,proto3" json:"session,omitempty"`
	// A global unique ID used for logging.
	AnswerQueryToken string `protobuf:"bytes,3,opt,name=answer_query_token,json=answerQueryToken,proto3" json:"answer_query_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.

func (*AnswerQueryResponse) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryResponse.ProtoReflect.Descriptor instead.

func (*AnswerQueryResponse) GetAnswer added in v1.7.0 

func (x *AnswerQueryResponse) GetAnswer() *Answer

func (*AnswerQueryResponse) GetAnswerQueryToken added in v1.8.0 

func (x *AnswerQueryResponse) GetAnswerQueryToken() string

func (*AnswerQueryResponse) GetSession added in v1.7.0 

func (x *AnswerQueryResponse) GetSession() *Session

func (*AnswerQueryResponse) ProtoMessage added in v1.7.0 

func (*AnswerQueryResponse) ProtoMessage()

func (*AnswerQueryResponse) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryResponse) Reset added in v1.7.0 

func (x *AnswerQueryResponse) Reset()

func (*AnswerQueryResponse) String added in v1.7.0 

func (x *AnswerQueryResponse) String() string

type Answer_AnswerSkippedReason added in v1.7.0 

type Answer_AnswerSkippedReason int32

An enum for answer skipped reasons. 

const (
	// Default value. The answer skipped reason is not specified.
	Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED Answer_AnswerSkippedReason = 0
	// The adversarial query ignored case.
	Answer_ADVERSARIAL_QUERY_IGNORED Answer_AnswerSkippedReason = 1
	// The non-answer seeking query ignored case.
	Answer_NON_ANSWER_SEEKING_QUERY_IGNORED Answer_AnswerSkippedReason = 2
	// The out-of-domain query ignored case.
	//
	// Google skips the answer if there are no high-relevance search results.
	Answer_OUT_OF_DOMAIN_QUERY_IGNORED Answer_AnswerSkippedReason = 3
	// The potential policy violation case.
	//
	// Google skips the answer if there is a potential policy violation
	// detected. This includes content that may be violent or toxic.
	Answer_POTENTIAL_POLICY_VIOLATION Answer_AnswerSkippedReason = 4
	// The no relevant content case.
	//
	// Google skips the answer if there is no relevant content in the
	// retrieved search results.
	Answer_NO_RELEVANT_CONTENT Answer_AnswerSkippedReason = 5
	// The jail-breaking query ignored case.
	//
	// For example, "Reply in the tone of a competing company's CEO".
	// Google skips the answer if the query is classified as a jail-breaking
	// query.
	Answer_JAIL_BREAKING_QUERY_IGNORED Answer_AnswerSkippedReason = 6
	// The customer policy violation case.
	//
	// Google skips the summary if there is a customer policy violation
	// detected. The policy is defined by the customer.
	Answer_CUSTOMER_POLICY_VIOLATION Answer_AnswerSkippedReason = 7
)

func (Answer_AnswerSkippedReason) Descriptor added in v1.7.0 

func (Answer_AnswerSkippedReason) Descriptor() protoreflect.EnumDescriptor

func (Answer_AnswerSkippedReason) Enum added in v1.7.0 

func (x Answer_AnswerSkippedReason) Enum() *Answer_AnswerSkippedReason

func (Answer_AnswerSkippedReason) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.

func (Answer_AnswerSkippedReason) Number added in v1.7.0 

func (x Answer_AnswerSkippedReason) Number() protoreflect.EnumNumber

func (Answer_AnswerSkippedReason) String added in v1.7.0 

func (x Answer_AnswerSkippedReason) String() string

func (Answer_AnswerSkippedReason) Type added in v1.7.0 

func (Answer_AnswerSkippedReason) Type() protoreflect.EnumType

type Answer_Citation added in v1.7.0 

type Answer_Citation struct {

	// Index indicates the start of the segment, measured in bytes (UTF-8
	// 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 []*Answer_CitationSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
	// contains filtered or unexported fields
}

Citation info for a segment.

func (*Answer_Citation) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.

func (*Answer_Citation) GetEndIndex added in v1.7.0 

func (x *Answer_Citation) GetEndIndex() int64

func (*Answer_Citation) GetSources added in v1.7.0 

func (x *Answer_Citation) GetSources() []*Answer_CitationSource

func (*Answer_Citation) GetStartIndex added in v1.7.0 

func (x *Answer_Citation) GetStartIndex() int64

func (*Answer_Citation) ProtoMessage added in v1.7.0 

func (*Answer_Citation) ProtoMessage()

func (*Answer_Citation) ProtoReflect added in v1.7.0 

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

func (*Answer_Citation) Reset added in v1.7.0 

func (x *Answer_Citation) Reset()

func (*Answer_Citation) String added in v1.7.0 

func (x *Answer_Citation) String() string

type Answer_CitationSource added in v1.7.0 

type Answer_CitationSource struct {

	// ID of the citation source.
	ReferenceId string `protobuf:"bytes,1,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
	// contains filtered or unexported fields
}

Citation source.

func (*Answer_CitationSource) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_CitationSource.ProtoReflect.Descriptor instead.

func (*Answer_CitationSource) GetReferenceId added in v1.7.0 

func (x *Answer_CitationSource) GetReferenceId() string

func (*Answer_CitationSource) ProtoMessage added in v1.7.0 

func (*Answer_CitationSource) ProtoMessage()

func (*Answer_CitationSource) ProtoReflect added in v1.7.0 

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

func (*Answer_CitationSource) Reset added in v1.7.0 

func (x *Answer_CitationSource) Reset()

func (*Answer_CitationSource) String added in v1.7.0 

func (x *Answer_CitationSource) String() string

type Answer_QueryUnderstandingInfo added in v1.7.0 

type Answer_QueryUnderstandingInfo struct {

	// Query classification information.
	QueryClassificationInfo []*Answer_QueryUnderstandingInfo_QueryClassificationInfo `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Query understanding information.

func (*Answer_QueryUnderstandingInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_QueryUnderstandingInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo) GetQueryClassificationInfo added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo) GetQueryClassificationInfo() []*Answer_QueryUnderstandingInfo_QueryClassificationInfo

func (*Answer_QueryUnderstandingInfo) ProtoMessage added in v1.7.0 

func (*Answer_QueryUnderstandingInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_QueryUnderstandingInfo) Reset added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo) Reset()

func (*Answer_QueryUnderstandingInfo) String added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo added in v1.7.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {

	// Query classification type.
	Type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type `` /* 162-byte string literal not displayed */
	// Classification output.
	Positive bool `protobuf:"varint,2,opt,name=positive,proto3" json:"positive,omitempty"`
	// contains filtered or unexported fields
}

Query classification information.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive() bool

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType() Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage added in v1.7.0 

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) String added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type added in v1.7.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type int32

Query classification types. 

const (
	// Unspecified query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 0
	// Adversarial query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 1
	// Non-answer-seeking query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 2
	// Jail-breaking query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 3
)

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor added in v1.7.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor() protoreflect.EnumDescriptor

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum() *Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number() protoreflect.EnumNumber

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String() string

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type added in v1.7.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type() protoreflect.EnumType

type Answer_Reference added in v1.7.0 

type Answer_Reference struct {

	// Search result content.
	//
	// Types that are assignable to Content:
	//
	//	*Answer_Reference_UnstructuredDocumentInfo_
	//	*Answer_Reference_ChunkInfo_
	//	*Answer_Reference_StructuredDocumentInfo_
	Content isAnswer_Reference_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Reference.

func (*Answer_Reference) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Reference.ProtoReflect.Descriptor instead.

func (*Answer_Reference) GetChunkInfo added in v1.7.0 

func (x *Answer_Reference) GetChunkInfo() *Answer_Reference_ChunkInfo

func (*Answer_Reference) GetContent added in v1.7.0 

func (m *Answer_Reference) GetContent() isAnswer_Reference_Content

func (*Answer_Reference) GetStructuredDocumentInfo added in v1.14.0 

func (x *Answer_Reference) GetStructuredDocumentInfo() *Answer_Reference_StructuredDocumentInfo

func (*Answer_Reference) GetUnstructuredDocumentInfo added in v1.7.0 

func (x *Answer_Reference) GetUnstructuredDocumentInfo() *Answer_Reference_UnstructuredDocumentInfo

func (*Answer_Reference) ProtoMessage added in v1.7.0 

func (*Answer_Reference) ProtoMessage()

func (*Answer_Reference) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference) Reset added in v1.7.0 

func (x *Answer_Reference) Reset()

func (*Answer_Reference) String added in v1.7.0 

func (x *Answer_Reference) String() string

type Answer_Reference_ChunkInfo added in v1.7.0 

type Answer_Reference_ChunkInfo struct {

	// Chunk resource name.
	Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Chunk textual content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// The relevance of the chunk for a given query. Values range from 0.0
	// (completely irrelevant) to 1.0 (completely relevant).
	// This value is for informational purpose only. It may change for
	// the same query and chunk at any time due to a model retraining or
	// change in implementation.
	RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// Document metadata.
	DocumentMetadata *Answer_Reference_ChunkInfo_DocumentMetadata `protobuf:"bytes,4,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*Answer_Reference_ChunkInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo) GetChunk added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetChunk() string

func (*Answer_Reference_ChunkInfo) GetContent added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetContent() string

func (*Answer_Reference_ChunkInfo) GetDocumentMetadata added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetDocumentMetadata() *Answer_Reference_ChunkInfo_DocumentMetadata

func (*Answer_Reference_ChunkInfo) GetRelevanceScore added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Reference_ChunkInfo) ProtoMessage added in v1.7.0 

func (*Answer_Reference_ChunkInfo) ProtoMessage()

func (*Answer_Reference_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_ChunkInfo) Reset added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) Reset()

func (*Answer_Reference_ChunkInfo) String added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) String() string

type Answer_Reference_ChunkInfo_ added in v1.7.0 

type Answer_Reference_ChunkInfo_ struct {
	// Chunk information.
	ChunkInfo *Answer_Reference_ChunkInfo `protobuf:"bytes,2,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}

type Answer_Reference_ChunkInfo_DocumentMetadata added in v1.7.0 

type Answer_Reference_ChunkInfo_DocumentMetadata struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// URI for the document.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// Page identifier.
	PageIdentifier string `protobuf:"bytes,4,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// The structured JSON metadata for the document.
	// It is populated from the struct data from the Chunk in search result.
	StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

Document metadata.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData added in v1.8.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetUri() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage added in v1.7.0 

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) Reset()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) String added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) String() string

type Answer_Reference_StructuredDocumentInfo added in v1.14.0 

type Answer_Reference_StructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Structured search data.
	StructData *structpb.Struct `protobuf:"bytes,2,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

Structured search information.

func (*Answer_Reference_StructuredDocumentInfo) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use Answer_Reference_StructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_StructuredDocumentInfo) GetDocument added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_StructuredDocumentInfo) GetStructData added in v1.14.0 

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

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage added in v1.14.0 

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_StructuredDocumentInfo) ProtoReflect added in v1.14.0 

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

func (*Answer_Reference_StructuredDocumentInfo) Reset added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) Reset()

func (*Answer_Reference_StructuredDocumentInfo) String added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) String() string

type Answer_Reference_StructuredDocumentInfo_ added in v1.14.0 

type Answer_Reference_StructuredDocumentInfo_ struct {
	// Structured document information.
	StructuredDocumentInfo *Answer_Reference_StructuredDocumentInfo `protobuf:"bytes,3,opt,name=structured_document_info,json=structuredDocumentInfo,proto3,oneof"`
}

type Answer_Reference_UnstructuredDocumentInfo added in v1.7.0 

type Answer_Reference_UnstructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// URI for the document.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// List of cited chunk contents derived from document content.
	ChunkContents []*Answer_Reference_UnstructuredDocumentInfo_ChunkContent `protobuf:"bytes,4,rep,name=chunk_contents,json=chunkContents,proto3" json:"chunk_contents,omitempty"`
	// The structured JSON metadata for the document.
	// It is populated from the struct data from the Chunk in search result.
	StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

Unstructured document information.

func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetChunkContents() []*Answer_Reference_UnstructuredDocumentInfo_ChunkContent

func (*Answer_Reference_UnstructuredDocumentInfo) GetDocument added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetStructData added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) GetTitle added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetTitle() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetUri added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetUri() string

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage added in v1.7.0 

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) Reset added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo) String added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) String() string

type Answer_Reference_UnstructuredDocumentInfo_ added in v1.7.0 

type Answer_Reference_UnstructuredDocumentInfo_ struct {
	// Unstructured document information.
	UnstructuredDocumentInfo *Answer_Reference_UnstructuredDocumentInfo `protobuf:"bytes,1,opt,name=unstructured_document_info,json=unstructuredDocumentInfo,proto3,oneof"`
}

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent added in v1.7.0 

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent struct {

	// Chunk textual content.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Page identifier.
	PageIdentifier string `protobuf:"bytes,2,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// The relevance of the chunk for a given query. Values range from 0.0
	// (completely irrelevant) to 1.0 (completely relevant).
	// This value is for informational purpose only. It may change for
	// the same query and chunk at any time due to a model retraining or
	// change in implementation.
	RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// contains filtered or unexported fields
}

Chunk content.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore added in v1.14.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore() float32

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage added in v1.7.0 

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String() string

type Answer_State added in v1.7.0 

type Answer_State int32

Enumeration of the state of the answer generation. 

const (
	// Unknown.
	Answer_STATE_UNSPECIFIED Answer_State = 0
	// Answer generation is currently in progress.
	Answer_IN_PROGRESS Answer_State = 1
	// Answer generation currently failed.
	Answer_FAILED Answer_State = 2
	// Answer generation has succeeded.
	Answer_SUCCEEDED Answer_State = 3
)

func (Answer_State) Descriptor added in v1.7.0 

func (Answer_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_State) Enum added in v1.7.0 

func (x Answer_State) Enum() *Answer_State

func (Answer_State) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_State.Descriptor instead.

func (Answer_State) Number added in v1.7.0 

func (x Answer_State) Number() protoreflect.EnumNumber

func (Answer_State) String added in v1.7.0 

func (x Answer_State) String() string

func (Answer_State) Type added in v1.7.0 

func (Answer_State) Type() protoreflect.EnumType

type Answer_Step added in v1.7.0 

type Answer_Step struct {

	// The state of the step.
	State Answer_Step_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_Step_State" json:"state,omitempty"`
	// The description of the step.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// The thought of the step.
	Thought string `protobuf:"bytes,3,opt,name=thought,proto3" json:"thought,omitempty"`
	// Actions.
	Actions []*Answer_Step_Action `protobuf:"bytes,4,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

Step information.

func (*Answer_Step) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step.ProtoReflect.Descriptor instead.

func (*Answer_Step) GetActions added in v1.7.0 

func (x *Answer_Step) GetActions() []*Answer_Step_Action

func (*Answer_Step) GetDescription added in v1.7.0 

func (x *Answer_Step) GetDescription() string

func (*Answer_Step) GetState added in v1.7.0 

func (x *Answer_Step) GetState() Answer_Step_State

func (*Answer_Step) GetThought added in v1.7.0 

func (x *Answer_Step) GetThought() string

func (*Answer_Step) ProtoMessage added in v1.7.0 

func (*Answer_Step) ProtoMessage()

func (*Answer_Step) ProtoReflect added in v1.7.0 

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

func (*Answer_Step) Reset added in v1.7.0 

func (x *Answer_Step) Reset()

func (*Answer_Step) String added in v1.7.0 

func (x *Answer_Step) String() string

type Answer_Step_Action added in v1.7.0 

type Answer_Step_Action struct {

	// The action.
	//
	// Types that are assignable to Action:
	//
	//	*Answer_Step_Action_SearchAction_
	Action isAnswer_Step_Action_Action `protobuf_oneof:"action"`
	// Observation.
	Observation *Answer_Step_Action_Observation `protobuf:"bytes,3,opt,name=observation,proto3" json:"observation,omitempty"`
	// contains filtered or unexported fields
}

Action.

func (*Answer_Step_Action) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action) GetAction added in v1.7.0 

func (m *Answer_Step_Action) GetAction() isAnswer_Step_Action_Action

func (*Answer_Step_Action) GetObservation added in v1.7.0 

func (x *Answer_Step_Action) GetObservation() *Answer_Step_Action_Observation

func (*Answer_Step_Action) GetSearchAction added in v1.7.0 

func (x *Answer_Step_Action) GetSearchAction() *Answer_Step_Action_SearchAction

func (*Answer_Step_Action) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action) ProtoMessage()

func (*Answer_Step_Action) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action) Reset added in v1.7.0 

func (x *Answer_Step_Action) Reset()

func (*Answer_Step_Action) String added in v1.7.0 

func (x *Answer_Step_Action) String() string

type Answer_Step_Action_Observation added in v1.7.0 

type Answer_Step_Action_Observation struct {

	// Search results observed by the search action, it can be snippets info
	// or chunk info, depending on the citation type set by the user.
	SearchResults []*Answer_Step_Action_Observation_SearchResult `protobuf:"bytes,2,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
	// contains filtered or unexported fields
}

Observation.

func (*Answer_Step_Action_Observation) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action_Observation.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation) GetSearchResults added in v1.7.0 

func (x *Answer_Step_Action_Observation) GetSearchResults() []*Answer_Step_Action_Observation_SearchResult

func (*Answer_Step_Action_Observation) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation) ProtoMessage()

func (*Answer_Step_Action_Observation) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation) Reset()

func (*Answer_Step_Action_Observation) String added in v1.7.0 

func (x *Answer_Step_Action_Observation) String() string

type Answer_Step_Action_Observation_SearchResult added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// URI for the document.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// If citation_type is DOCUMENT_LEVEL_CITATION, populate document
	// level snippets.
	SnippetInfo []*Answer_Step_Action_Observation_SearchResult_SnippetInfo `protobuf:"bytes,4,rep,name=snippet_info,json=snippetInfo,proto3" json:"snippet_info,omitempty"`
	// If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
	// populate chunk info.
	ChunkInfo []*Answer_Step_Action_Observation_SearchResult_ChunkInfo `protobuf:"bytes,5,rep,name=chunk_info,json=chunkInfo,proto3" json:"chunk_info,omitempty"`
	// Data representation.
	// The structured JSON data for the document.
	// It's populated from the struct data from the Document
	// , or the Chunk in
	// search result
	// .
	StructData *structpb.Struct `protobuf:"bytes,6,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

func (*Answer_Step_Action_Observation_SearchResult) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult) GetChunkInfo added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetChunkInfo() []*Answer_Step_Action_Observation_SearchResult_ChunkInfo

func (*Answer_Step_Action_Observation_SearchResult) GetDocument added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetDocument() string

func (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetSnippetInfo() []*Answer_Step_Action_Observation_SearchResult_SnippetInfo

func (*Answer_Step_Action_Observation_SearchResult) GetStructData added in v1.11.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetTitle added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetTitle() string

func (*Answer_Step_Action_Observation_SearchResult) GetUri added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetUri() string

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) Reset()

func (*Answer_Step_Action_Observation_SearchResult) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) String() string

type Answer_Step_Action_Observation_SearchResult_ChunkInfo added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult_ChunkInfo struct {

	// Chunk resource name.
	Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Chunk textual content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// The relevance of the chunk for a given query. Values range from
	// 0.0 (completely irrelevant) to 1.0 (completely relevant).
	// This value is for informational purpose only. It may change for
	// the same query and chunk at any time due to a model retraining or
	// change in implementation.
	RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) String() string

type Answer_Step_Action_Observation_SearchResult_SnippetInfo added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult_SnippetInfo struct {

	// Snippet content.
	Snippet string `protobuf:"bytes,1,opt,name=snippet,proto3" json:"snippet,omitempty"`
	// Status of the snippet defined by the search team.
	SnippetStatus string `protobuf:"bytes,2,opt,name=snippet_status,json=snippetStatus,proto3" json:"snippet_status,omitempty"`
	// contains filtered or unexported fields
}

Snippet information.

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_SnippetInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) String() string

type Answer_Step_Action_SearchAction added in v1.7.0 

type Answer_Step_Action_SearchAction struct {

	// The query to search.
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

Search action.

func (*Answer_Step_Action_SearchAction) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_Action_SearchAction.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_SearchAction) GetQuery added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) GetQuery() string

func (*Answer_Step_Action_SearchAction) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_SearchAction) ProtoMessage()

func (*Answer_Step_Action_SearchAction) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_SearchAction) Reset added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) Reset()

func (*Answer_Step_Action_SearchAction) String added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) String() string

type Answer_Step_Action_SearchAction_ added in v1.7.0 

type Answer_Step_Action_SearchAction_ struct {
	// Search action.
	SearchAction *Answer_Step_Action_SearchAction `protobuf:"bytes,2,opt,name=search_action,json=searchAction,proto3,oneof"`
}

type Answer_Step_State added in v1.7.0 

type Answer_Step_State int32

Enumeration of the state of the step. 

const (
	// Unknown.
	Answer_Step_STATE_UNSPECIFIED Answer_Step_State = 0
	// Step is currently in progress.
	Answer_Step_IN_PROGRESS Answer_Step_State = 1
	// Step currently failed.
	Answer_Step_FAILED Answer_Step_State = 2
	// Step has succeeded.
	Answer_Step_SUCCEEDED Answer_Step_State = 3
)

func (Answer_Step_State) Descriptor added in v1.7.0 

func (Answer_Step_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_Step_State) Enum added in v1.7.0 

func (x Answer_Step_State) Enum() *Answer_Step_State

func (Answer_Step_State) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_State.Descriptor instead.

func (Answer_Step_State) Number added in v1.7.0 

func (x Answer_Step_State) Number() protoreflect.EnumNumber

func (Answer_Step_State) String added in v1.7.0 

func (x Answer_Step_State) String() string

func (Answer_Step_State) Type added in v1.7.0 

func (Answer_Step_State) Type() protoreflect.EnumType

type BatchCreateTargetSiteMetadata added in v1.5.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.v1beta.SiteSearchEngineService.BatchCreateTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSiteMetadata) ProtoMessage()

func (*BatchCreateTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) Reset added in v1.5.0 

func (x *BatchCreateTargetSiteMetadata) Reset()

func (*BatchCreateTargetSiteMetadata) String added in v1.5.0 

func (x *BatchCreateTargetSiteMetadata) String() string

type BatchCreateTargetSitesRequest added in v1.5.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.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.

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

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

Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesRequest) GetParent added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) GetParent() string

func (*BatchCreateTargetSitesRequest) GetRequests added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) GetRequests() []*CreateTargetSiteRequest

func (*BatchCreateTargetSitesRequest) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSitesRequest) ProtoMessage()

func (*BatchCreateTargetSitesRequest) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSitesRequest) Reset added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) Reset()

func (*BatchCreateTargetSitesRequest) String added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) String() string

type BatchCreateTargetSitesResponse added in v1.5.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.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.

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

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

Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesResponse) GetTargetSites added in v1.5.0 

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

func (*BatchCreateTargetSitesResponse) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSitesResponse) ProtoMessage()

func (*BatchCreateTargetSitesResponse) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSitesResponse) Reset added in v1.5.0 

func (x *BatchCreateTargetSitesResponse) Reset()

func (*BatchCreateTargetSitesResponse) String added in v1.5.0 

func (x *BatchCreateTargetSitesResponse) String() string

type BatchGetDocumentsMetadataRequest added in v1.14.0 

type BatchGetDocumentsMetadataRequest struct {

	// Required. The parent branch 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. Matcher for the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s.
	Matcher *BatchGetDocumentsMetadataRequest_Matcher `protobuf:"bytes,2,opt,name=matcher,proto3" json:"matcher,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchGetDocumentsMetadataRequest) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataRequest.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest) GetMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetMatcher() *BatchGetDocumentsMetadataRequest_Matcher

func (*BatchGetDocumentsMetadataRequest) GetParent added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetParent() string

func (*BatchGetDocumentsMetadataRequest) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) Reset()

func (*BatchGetDocumentsMetadataRequest) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) String() string

type BatchGetDocumentsMetadataRequest_Matcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_Matcher struct {

	// Matcher for the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s.
	//
	// Types that are assignable to Matcher:
	//
	//	*BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher
	Matcher isBatchGetDocumentsMetadataRequest_Matcher_Matcher `protobuf_oneof:"matcher"`
	// contains filtered or unexported fields
}

Matcher for the Document[google.cloud.discoveryengine.v1beta.Document]s. Currently supports matching by exact URIs.

func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_Matcher) GetMatcher added in v1.14.0 

func (m *BatchGetDocumentsMetadataRequest_Matcher) GetMatcher() isBatchGetDocumentsMetadataRequest_Matcher_Matcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher() *BatchGetDocumentsMetadataRequest_UrisMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_Matcher) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) Reset()

func (*BatchGetDocumentsMetadataRequest_Matcher) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) String() string

type BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher struct {
	// Matcher by exact URIs.
	UrisMatcher *BatchGetDocumentsMetadataRequest_UrisMatcher `protobuf:"bytes,1,opt,name=uris_matcher,json=urisMatcher,proto3,oneof"`
}

type BatchGetDocumentsMetadataRequest_UrisMatcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_UrisMatcher struct {

	// The exact URIs to match by.
	Uris []string `protobuf:"bytes,1,rep,name=uris,proto3" json:"uris,omitempty"`
	// contains filtered or unexported fields
}

Matcher for the Document[google.cloud.discoveryengine.v1beta.Document]s by exact uris.

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataRequest_UrisMatcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) GetUris added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) Reset()

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) String() string

type BatchGetDocumentsMetadataResponse added in v1.14.0 

type BatchGetDocumentsMetadataResponse struct {

	// The metadata of the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s.
	DocumentsMetadata []*BatchGetDocumentsMetadataResponse_DocumentMetadata `protobuf:"bytes,1,rep,name=documents_metadata,json=documentsMetadata,proto3" json:"documents_metadata,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchGetDocumentsMetadataResponse) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse) GetDocumentsMetadata added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse) GetDocumentsMetadata() []*BatchGetDocumentsMetadataResponse_DocumentMetadata

func (*BatchGetDocumentsMetadataResponse) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse) Reset()

func (*BatchGetDocumentsMetadataResponse) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata struct {

	// The value of the matcher that was used to match the
	// [Document][google.cloud.discoveryengine.v1beta.Document].
	MatcherValue *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue `protobuf:"bytes,2,opt,name=matcher_value,json=matcherValue,proto3" json:"matcher_value,omitempty"`
	// The state of the document.
	State BatchGetDocumentsMetadataResponse_State `` /* 145-byte string literal not displayed */
	// The timestamp of the last time the
	// [Document][google.cloud.discoveryengine.v1beta.Document] was last
	// indexed.
	LastRefreshedTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_refreshed_time,json=lastRefreshedTime,proto3" json:"last_refreshed_time,omitempty"`
	// The data ingestion source of the
	// [Document][google.cloud.discoveryengine.v1beta.Document].
	//
	// Allowed values are:
	//
	// * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
	// * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
	DataIngestionSource string `protobuf:"bytes,5,opt,name=data_ingestion_source,json=dataIngestionSource,proto3" json:"data_ingestion_source,omitempty"`
	// contains filtered or unexported fields
}

The metadata of a Document[google.cloud.discoveryengine.v1beta.Document].

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime() *timestamppb.Timestamp

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue() *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState() BatchGetDocumentsMetadataResponse_State

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue struct {

	// The value of the matcher that was used to match the
	// [Document][google.cloud.discoveryengine.v1beta.Document].
	//
	// Types that are assignable to MatcherValue:
	//
	//	*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri
	MatcherValue isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue `protobuf_oneof:"matcher_value"`
	// contains filtered or unexported fields
}

The value of the matcher that was used to match the Document[google.cloud.discoveryengine.v1beta.Document].

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue added in v1.14.0 

func (m *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue() isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri struct {
	// If match by URI, the URI of the
	// [Document][google.cloud.discoveryengine.v1beta.Document].
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3,oneof"`
}

type BatchGetDocumentsMetadataResponse_State added in v1.14.0 

type BatchGetDocumentsMetadataResponse_State int32

The state of the Document[google.cloud.discoveryengine.v1beta.Document]. 

const (
	// Should never be set.
	BatchGetDocumentsMetadataResponse_STATE_UNSPECIFIED BatchGetDocumentsMetadataResponse_State = 0
	// The [Document][google.cloud.discoveryengine.v1beta.Document] is indexed.
	BatchGetDocumentsMetadataResponse_INDEXED BatchGetDocumentsMetadataResponse_State = 1
	// The [Document][google.cloud.discoveryengine.v1beta.Document] is not
	// indexed because its URI is not in the
	// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	BatchGetDocumentsMetadataResponse_NOT_IN_TARGET_SITE BatchGetDocumentsMetadataResponse_State = 2
	// The [Document][google.cloud.discoveryengine.v1beta.Document] is not
	// indexed.
	BatchGetDocumentsMetadataResponse_NOT_IN_INDEX BatchGetDocumentsMetadataResponse_State = 3
)

func (BatchGetDocumentsMetadataResponse_State) Descriptor added in v1.14.0 

func (BatchGetDocumentsMetadataResponse_State) Descriptor() protoreflect.EnumDescriptor

func (BatchGetDocumentsMetadataResponse_State) Enum added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Enum() *BatchGetDocumentsMetadataResponse_State

func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_State.Descriptor instead.

func (BatchGetDocumentsMetadataResponse_State) Number added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Number() protoreflect.EnumNumber

func (BatchGetDocumentsMetadataResponse_State) String added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) String() string

func (BatchGetDocumentsMetadataResponse_State) Type added in v1.14.0 

func (BatchGetDocumentsMetadataResponse_State) Type() protoreflect.EnumType

type BatchVerifyTargetSitesMetadata added in v1.5.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.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesMetadata) GetCreateTime added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) GetUpdateTime added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesMetadata) ProtoMessage()

func (*BatchVerifyTargetSitesMetadata) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesMetadata) Reset()

func (*BatchVerifyTargetSitesMetadata) String added in v1.5.0 

func (x *BatchVerifyTargetSitesMetadata) String() string

type BatchVerifyTargetSitesRequest added in v1.5.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.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.

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

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

Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesRequest) GetParent added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) GetParent() string

func (*BatchVerifyTargetSitesRequest) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesRequest) ProtoMessage()

func (*BatchVerifyTargetSitesRequest) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesRequest) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) Reset()

func (*BatchVerifyTargetSitesRequest) String added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) String() string

type BatchVerifyTargetSitesResponse added in v1.5.0 

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesResponse) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesResponse) ProtoMessage()

func (*BatchVerifyTargetSitesResponse) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesResponse) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesResponse) Reset()

func (*BatchVerifyTargetSitesResponse) String added in v1.5.0 

func (x *BatchVerifyTargetSitesResponse) String() string

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

BigQuery source import data from.

func (*BigQuerySource) Descriptor deprecated 

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

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetDataSchema 

func (x *BigQuerySource) GetDataSchema() string

func (*BigQuerySource) GetDatasetId 

func (x *BigQuerySource) GetDatasetId() string

func (*BigQuerySource) GetGcsStagingDir 

func (x *BigQuerySource) GetGcsStagingDir() string

func (*BigQuerySource) GetPartition 

func (m *BigQuerySource) GetPartition() isBigQuerySource_Partition

func (*BigQuerySource) GetPartitionDate 

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

func (*BigQuerySource) GetProjectId 

func (x *BigQuerySource) GetProjectId() string

func (*BigQuerySource) GetTableId 

func (x *BigQuerySource) GetTableId() string

func (*BigQuerySource) ProtoMessage 

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect 

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

func (*BigQuerySource) Reset 

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String 

func (x *BigQuerySource) String() string

type BigQuerySource_PartitionDate 

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

type BigtableOptions added in v1.7.0 

type BigtableOptions struct {

	// The field name used for saving row key value in the document. The name has
	// to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
	KeyFieldName string `protobuf:"bytes,1,opt,name=key_field_name,json=keyFieldName,proto3" json:"key_field_name,omitempty"`
	// The mapping from family names to an object that contains column families
	// level information for the given column family. If a family is not present
	// in this map it will be ignored.
	Families map[string]*BigtableOptions_BigtableColumnFamily `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Bigtable Options object that contains information to support the import.

func (*BigtableOptions) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions.ProtoReflect.Descriptor instead.

func (*BigtableOptions) GetFamilies added in v1.7.0 

func (x *BigtableOptions) GetFamilies() map[string]*BigtableOptions_BigtableColumnFamily

func (*BigtableOptions) GetKeyFieldName added in v1.7.0 

func (x *BigtableOptions) GetKeyFieldName() string

func (*BigtableOptions) ProtoMessage added in v1.7.0 

func (*BigtableOptions) ProtoMessage()

func (*BigtableOptions) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions) Reset added in v1.7.0 

func (x *BigtableOptions) Reset()

func (*BigtableOptions) String added in v1.7.0 

func (x *BigtableOptions) String() string

type BigtableOptions_BigtableColumn added in v1.7.0 

type BigtableOptions_BigtableColumn struct {

	// Required. Qualifier of the column. If it cannot be decoded with utf-8,
	// use a base-64 encoded string instead.
	Qualifier []byte `protobuf:"bytes,1,opt,name=qualifier,proto3" json:"qualifier,omitempty"`
	// The field name to use for this column in the document. The name has to
	// match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
	// If not set, it is parsed from the qualifier bytes with best effort.
	// However, due to different naming patterns, field name collisions could
	// happen, where parsing behavior is undefined.
	FieldName string `protobuf:"bytes,2,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The encoding mode of the values when the type is not `STRING`.
	// Acceptable encoding values are:
	//
	// * `TEXT`: indicates values are alphanumeric text strings.
	// * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
	// family of functions. This can be overridden for a specific column
	// by listing that column in `columns` and specifying an encoding for it.
	Encoding BigtableOptions_Encoding `` /* 136-byte string literal not displayed */
	// The type of values in this column family.
	// The values are expected to be encoded using `HBase Bytes.toBytes`
	// function when the encoding value is set to `BINARY`.
	Type BigtableOptions_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

The column of the Bigtable.

func (*BigtableOptions_BigtableColumn) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_BigtableColumn.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumn) GetEncoding added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetEncoding() BigtableOptions_Encoding

func (*BigtableOptions_BigtableColumn) GetFieldName added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetFieldName() string

func (*BigtableOptions_BigtableColumn) GetQualifier added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetQualifier() []byte

func (*BigtableOptions_BigtableColumn) GetType added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetType() BigtableOptions_Type

func (*BigtableOptions_BigtableColumn) ProtoMessage added in v1.7.0 

func (*BigtableOptions_BigtableColumn) ProtoMessage()

func (*BigtableOptions_BigtableColumn) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions_BigtableColumn) Reset added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) Reset()

func (*BigtableOptions_BigtableColumn) String added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) String() string

type BigtableOptions_BigtableColumnFamily added in v1.7.0 

type BigtableOptions_BigtableColumnFamily struct {

	// The field name to use for this column family in the document. The
	// name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
	// it is parsed from the family name with best effort. However, due to
	// different naming patterns, field name collisions could happen, where
	// parsing behavior is undefined.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The encoding mode of the values when the type is not STRING.
	// Acceptable encoding values are:
	//
	// * `TEXT`: indicates values are alphanumeric text strings.
	// * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
	// family of functions. This can be overridden for a specific column
	// by listing that column in `columns` and specifying an encoding for it.
	Encoding BigtableOptions_Encoding `` /* 136-byte string literal not displayed */
	// The type of values in this column family.
	// The values are expected to be encoded using `HBase Bytes.toBytes`
	// function when the encoding value is set to `BINARY`.
	Type BigtableOptions_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
	// The list of objects that contains column level information for each
	// column. If a column is not present in this list it will be ignored.
	Columns []*BigtableOptions_BigtableColumn `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
	// contains filtered or unexported fields
}

The column family of the Bigtable.

func (*BigtableOptions_BigtableColumnFamily) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumnFamily) GetColumns added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetColumns() []*BigtableOptions_BigtableColumn

func (*BigtableOptions_BigtableColumnFamily) GetEncoding added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetEncoding() BigtableOptions_Encoding

func (*BigtableOptions_BigtableColumnFamily) GetFieldName added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() string

func (*BigtableOptions_BigtableColumnFamily) GetType added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetType() BigtableOptions_Type

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage added in v1.7.0 

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()

func (*BigtableOptions_BigtableColumnFamily) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions_BigtableColumnFamily) Reset added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) Reset()

func (*BigtableOptions_BigtableColumnFamily) String added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) String() string

type BigtableOptions_Encoding added in v1.7.0 

type BigtableOptions_Encoding int32

The encoding mode of a Bigtable column or column family. 

const (
	// The encoding is unspecified.
	BigtableOptions_ENCODING_UNSPECIFIED BigtableOptions_Encoding = 0
	// Text encoding.
	BigtableOptions_TEXT BigtableOptions_Encoding = 1
	// Binary encoding.
	BigtableOptions_BINARY BigtableOptions_Encoding = 2
)

func (BigtableOptions_Encoding) Descriptor added in v1.7.0 

func (BigtableOptions_Encoding) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Encoding) Enum added in v1.7.0 

func (x BigtableOptions_Encoding) Enum() *BigtableOptions_Encoding

func (BigtableOptions_Encoding) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Encoding.Descriptor instead.

func (BigtableOptions_Encoding) Number added in v1.7.0 

func (x BigtableOptions_Encoding) Number() protoreflect.EnumNumber

func (BigtableOptions_Encoding) String added in v1.7.0 

func (x BigtableOptions_Encoding) String() string

func (BigtableOptions_Encoding) Type added in v1.7.0 

func (BigtableOptions_Encoding) Type() protoreflect.EnumType

type BigtableOptions_Type added in v1.7.0 

type BigtableOptions_Type int32

The type of values in a Bigtable column or column family. The values are expected to be encoded using [HBase Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html) function when the encoding value is set to `BINARY`. 

const (
	// The type is unspecified.
	BigtableOptions_TYPE_UNSPECIFIED BigtableOptions_Type = 0
	// String type.
	BigtableOptions_STRING BigtableOptions_Type = 1
	// Numerical type.
	BigtableOptions_NUMBER BigtableOptions_Type = 2
	// Integer type.
	BigtableOptions_INTEGER BigtableOptions_Type = 3
	// Variable length integer type.
	BigtableOptions_VAR_INTEGER BigtableOptions_Type = 4
	// BigDecimal type.
	BigtableOptions_BIG_NUMERIC BigtableOptions_Type = 5
	// Boolean type.
	BigtableOptions_BOOLEAN BigtableOptions_Type = 6
	// JSON type.
	BigtableOptions_JSON BigtableOptions_Type = 7
)

func (BigtableOptions_Type) Descriptor added in v1.7.0 

func (BigtableOptions_Type) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Type) Enum added in v1.7.0 

func (x BigtableOptions_Type) Enum() *BigtableOptions_Type

func (BigtableOptions_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Type.Descriptor instead.

func (BigtableOptions_Type) Number added in v1.7.0 

func (x BigtableOptions_Type) Number() protoreflect.EnumNumber

func (BigtableOptions_Type) String added in v1.7.0 

func (x BigtableOptions_Type) String() string

func (BigtableOptions_Type) Type added in v1.7.0 

func (BigtableOptions_Type) Type() protoreflect.EnumType

type BigtableSource added in v1.7.0 

type BigtableSource struct {

	// The project ID that contains the Bigtable source. Has 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 instance ID of the Cloud Bigtable that needs to be imported.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The table ID of the Cloud Bigtable that needs to be imported.
	TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Required. Bigtable options that contains information needed when parsing
	// data into typed structures. For example, column type annotations.
	BigtableOptions *BigtableOptions `protobuf:"bytes,4,opt,name=bigtable_options,json=bigtableOptions,proto3" json:"bigtable_options,omitempty"`
	// contains filtered or unexported fields
}

The Cloud Bigtable source for importing data.

func (*BigtableSource) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableSource.ProtoReflect.Descriptor instead.

func (*BigtableSource) GetBigtableOptions added in v1.7.0 

func (x *BigtableSource) GetBigtableOptions() *BigtableOptions

func (*BigtableSource) GetInstanceId added in v1.7.0 

func (x *BigtableSource) GetInstanceId() string

func (*BigtableSource) GetProjectId added in v1.7.0 

func (x *BigtableSource) GetProjectId() string

func (*BigtableSource) GetTableId added in v1.7.0 

func (x *BigtableSource) GetTableId() string

func (*BigtableSource) ProtoMessage added in v1.7.0 

func (*BigtableSource) ProtoMessage()

func (*BigtableSource) ProtoReflect added in v1.7.0 

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

func (*BigtableSource) Reset added in v1.7.0 

func (x *BigtableSource) Reset()

func (*BigtableSource) String added in v1.7.0 

func (x *BigtableSource) String() string

type CheckGroundingRequest added in v1.7.0 

type CheckGroundingRequest struct {

	// Required. The resource name of the grounding config, such as
	// `projects/*/locations/global/groundingConfigs/default_grounding_config`.
	GroundingConfig string `protobuf:"bytes,1,opt,name=grounding_config,json=groundingConfig,proto3" json:"grounding_config,omitempty"`
	// Answer candidate to check. Can have a maximum length of 1024 characters.
	AnswerCandidate string `protobuf:"bytes,2,opt,name=answer_candidate,json=answerCandidate,proto3" json:"answer_candidate,omitempty"`
	// List of facts for the grounding check.
	// We support up to 200 facts.
	Facts []*GroundingFact `protobuf:"bytes,3,rep,name=facts,proto3" json:"facts,omitempty"`
	// Configuration of the grounding check.
	GroundingSpec *CheckGroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,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 */
	// contains filtered or unexported fields
}

Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.

func (*CheckGroundingRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CheckGroundingRequest.ProtoReflect.Descriptor instead.

func (*CheckGroundingRequest) GetAnswerCandidate added in v1.7.0 

func (x *CheckGroundingRequest) GetAnswerCandidate() string

func (*CheckGroundingRequest) GetFacts added in v1.7.0 

func (x *CheckGroundingRequest) GetFacts() []*GroundingFact

func (*CheckGroundingRequest) GetGroundingConfig added in v1.7.0 

func (x *CheckGroundingRequest) GetGroundingConfig() string

func (*CheckGroundingRequest) GetGroundingSpec added in v1.7.0 

func (x *CheckGroundingRequest) GetGroundingSpec() *CheckGroundingSpec

func (*CheckGroundingRequest) GetUserLabels added in v1.8.0 

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

func (*CheckGroundingRequest) ProtoMessage added in v1.7.0 

func (*CheckGroundingRequest) ProtoMessage()

func (*CheckGroundingRequest) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingRequest) Reset added in v1.7.0 

func (x *CheckGroundingRequest) Reset()

func (*CheckGroundingRequest) String added in v1.7.0 

func (x *CheckGroundingRequest) String() string

type CheckGroundingResponse added in v1.7.0 

type CheckGroundingResponse struct {

	// The support score for the input answer candidate.
	// Higher the score, higher is the fraction of claims that are supported by
	// the provided facts. This is always set when a response is returned.
	SupportScore *float32 `protobuf:"fixed32,1,opt,name=support_score,json=supportScore,proto3,oneof" json:"support_score,omitempty"`
	// List of facts cited across all claims in the answer candidate.
	// These are derived from the facts supplied in the request.
	CitedChunks []*FactChunk `protobuf:"bytes,3,rep,name=cited_chunks,json=citedChunks,proto3" json:"cited_chunks,omitempty"`
	// Claim texts and citation info across all claims in the answer candidate.
	Claims []*CheckGroundingResponse_Claim `protobuf:"bytes,4,rep,name=claims,proto3" json:"claims,omitempty"`
	// contains filtered or unexported fields
}

Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.

func (*CheckGroundingResponse) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse) GetCitedChunks added in v1.7.0 

func (x *CheckGroundingResponse) GetCitedChunks() []*FactChunk

func (*CheckGroundingResponse) GetClaims added in v1.7.0 

func (x *CheckGroundingResponse) GetClaims() []*CheckGroundingResponse_Claim

func (*CheckGroundingResponse) GetSupportScore added in v1.7.0 

func (x *CheckGroundingResponse) GetSupportScore() float32

func (*CheckGroundingResponse) ProtoMessage added in v1.7.0 

func (*CheckGroundingResponse) ProtoMessage()

func (*CheckGroundingResponse) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingResponse) Reset added in v1.7.0 

func (x *CheckGroundingResponse) Reset()

func (*CheckGroundingResponse) String added in v1.7.0 

func (x *CheckGroundingResponse) String() string

type CheckGroundingResponse_Claim added in v1.7.0 

type CheckGroundingResponse_Claim struct {

	// Position indicating the start of the claim in the answer candidate,
	// measured in bytes.
	StartPos *int32 `protobuf:"varint,1,opt,name=start_pos,json=startPos,proto3,oneof" json:"start_pos,omitempty"`
	// Position indicating the end of the claim in the answer candidate,
	// exclusive.
	EndPos *int32 `protobuf:"varint,2,opt,name=end_pos,json=endPos,proto3,oneof" json:"end_pos,omitempty"`
	// Text for the claim in the answer candidate. Always provided regardless of
	// whether citations or anti-citations are found.
	ClaimText string `protobuf:"bytes,3,opt,name=claim_text,json=claimText,proto3" json:"claim_text,omitempty"`
	// A list of indices (into 'cited_chunks') specifying the citations
	// associated with the claim. For instance [1,3,4] means that
	// cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
	// supporting for the claim. A citation to a fact indicates that the claim
	// is supported by the fact.
	CitationIndices []int32 `protobuf:"varint,4,rep,packed,name=citation_indices,json=citationIndices,proto3" json:"citation_indices,omitempty"`
	// Indicates that this claim required grounding check. When the system
	// decided this claim doesn't require attribution/grounding check, this
	// field will be set to false. In that case, no grounding check was done for
	// the claim and therefore
	// [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
	// [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
	// and
	// [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
	// should not be returned.
	GroundingCheckRequired *bool `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Text and citation info for a claim in the answer candidate.

func (*CheckGroundingResponse_Claim) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse_Claim) GetCitationIndices added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetCitationIndices() []int32

func (*CheckGroundingResponse_Claim) GetClaimText added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetClaimText() string

func (*CheckGroundingResponse_Claim) GetEndPos added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetEndPos() int32

func (*CheckGroundingResponse_Claim) GetGroundingCheckRequired added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetGroundingCheckRequired() bool

func (*CheckGroundingResponse_Claim) GetStartPos added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetStartPos() int32

func (*CheckGroundingResponse_Claim) ProtoMessage added in v1.7.0 

func (*CheckGroundingResponse_Claim) ProtoMessage()

func (*CheckGroundingResponse_Claim) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingResponse_Claim) Reset added in v1.7.0 

func (x *CheckGroundingResponse_Claim) Reset()

func (*CheckGroundingResponse_Claim) String added in v1.7.0 

func (x *CheckGroundingResponse_Claim) String() string

type CheckGroundingSpec added in v1.7.0 

type CheckGroundingSpec struct {

	// The threshold (in [0,1]) used for determining whether a fact must be
	// cited for a claim in the answer candidate. Choosing a higher threshold
	// will lead to fewer but very strong citations, while choosing a lower
	// threshold may lead to more but somewhat weaker citations. If unset, the
	// threshold will default to 0.6.
	CitationThreshold *float64 `protobuf:"fixed64,1,opt,name=citation_threshold,json=citationThreshold,proto3,oneof" json:"citation_threshold,omitempty"`
	// contains filtered or unexported fields
}

Specification for the grounding check.

func (*CheckGroundingSpec) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CheckGroundingSpec.ProtoReflect.Descriptor instead.

func (*CheckGroundingSpec) GetCitationThreshold added in v1.7.0 

func (x *CheckGroundingSpec) GetCitationThreshold() float64

func (*CheckGroundingSpec) ProtoMessage added in v1.7.0 

func (*CheckGroundingSpec) ProtoMessage()

func (*CheckGroundingSpec) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingSpec) Reset added in v1.7.0 

func (x *CheckGroundingSpec) Reset()

func (*CheckGroundingSpec) String added in v1.7.0 

func (x *CheckGroundingSpec) String() string

type Chunk added in v1.10.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"`
	// Output only. Represents the relevance score based on similarity.
	// Higher score indicates higher chunk relevance.
	// The score is in range [-1.0, 1.0].
	// Only populated on [SearchService.SearchResponse][].
	RelevanceScore *float64 `protobuf:"fixed64,8,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,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"`
	// Page span of the chunk.
	PageSpan *Chunk_PageSpan `protobuf:"bytes,6,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// Output only. Metadata of the current chunk.
	ChunkMetadata *Chunk_ChunkMetadata `protobuf:"bytes,7,opt,name=chunk_metadata,json=chunkMetadata,proto3" json:"chunk_metadata,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.10.0 

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetChunkMetadata added in v1.10.0 

func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadata

func (*Chunk) GetContent added in v1.10.0 

func (x *Chunk) GetContent() string

func (*Chunk) GetDerivedStructData added in v1.10.0 

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

func (*Chunk) GetDocumentMetadata added in v1.10.0 

func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadata

func (*Chunk) GetId added in v1.10.0 

func (x *Chunk) GetId() string

func (*Chunk) GetName added in v1.10.0 

func (x *Chunk) GetName() string

func (*Chunk) GetPageSpan added in v1.10.0 

func (x *Chunk) GetPageSpan() *Chunk_PageSpan

func (*Chunk) GetRelevanceScore added in v1.10.0 

func (x *Chunk) GetRelevanceScore() float64

func (*Chunk) ProtoMessage added in v1.10.0 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect added in v1.10.0 

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

func (*Chunk) Reset added in v1.10.0 

func (x *Chunk) Reset()

func (*Chunk) String added in v1.10.0 

func (x *Chunk) String() string

type Chunk_ChunkMetadata added in v1.10.0 

type Chunk_ChunkMetadata struct {

	// The previous chunks of the current chunk. The number is controlled by
	// [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
	// This field is only populated on
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// API.
	PreviousChunks []*Chunk `protobuf:"bytes,1,rep,name=previous_chunks,json=previousChunks,proto3" json:"previous_chunks,omitempty"`
	// The next chunks of the current chunk. The number is controlled by
	// [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
	// This field is only populated on
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// API.
	NextChunks []*Chunk `protobuf:"bytes,2,rep,name=next_chunks,json=nextChunks,proto3" json:"next_chunks,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the current chunk. This field is only populated on [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] API.

func (*Chunk_ChunkMetadata) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use Chunk_ChunkMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_ChunkMetadata) GetNextChunks added in v1.10.0 

func (x *Chunk_ChunkMetadata) GetNextChunks() []*Chunk

func (*Chunk_ChunkMetadata) GetPreviousChunks added in v1.10.0 

func (x *Chunk_ChunkMetadata) GetPreviousChunks() []*Chunk

func (*Chunk_ChunkMetadata) ProtoMessage added in v1.10.0 

func (*Chunk_ChunkMetadata) ProtoMessage()

func (*Chunk_ChunkMetadata) ProtoReflect added in v1.10.0 

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

func (*Chunk_ChunkMetadata) Reset added in v1.10.0 

func (x *Chunk_ChunkMetadata) Reset()

func (*Chunk_ChunkMetadata) String added in v1.10.0 

func (x *Chunk_ChunkMetadata) String() string

type Chunk_DocumentMetadata added in v1.10.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"`
	// Data representation.
	// The structured JSON data for the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,3,opt,name=struct_data,json=structData,proto3" json:"struct_data,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.10.0 

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

Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_DocumentMetadata) GetStructData added in v1.10.0 

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

func (*Chunk_DocumentMetadata) GetTitle added in v1.10.0 

func (x *Chunk_DocumentMetadata) GetTitle() string

func (*Chunk_DocumentMetadata) GetUri added in v1.10.0 

func (x *Chunk_DocumentMetadata) GetUri() string

func (*Chunk_DocumentMetadata) ProtoMessage added in v1.10.0 

func (*Chunk_DocumentMetadata) ProtoMessage()

func (*Chunk_DocumentMetadata) ProtoReflect added in v1.10.0 

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

func (*Chunk_DocumentMetadata) Reset added in v1.10.0 

func (x *Chunk_DocumentMetadata) Reset()

func (*Chunk_DocumentMetadata) String added in v1.10.0 

func (x *Chunk_DocumentMetadata) String() string

type Chunk_PageSpan added in v1.10.0 

type Chunk_PageSpan struct {

	// The start page of the chunk.
	PageStart int32 `protobuf:"varint,1,opt,name=page_start,json=pageStart,proto3" json:"page_start,omitempty"`
	// The end page of the chunk.
	PageEnd int32 `protobuf:"varint,2,opt,name=page_end,json=pageEnd,proto3" json:"page_end,omitempty"`
	// contains filtered or unexported fields
}

Page span of the chunk.

func (*Chunk_PageSpan) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use Chunk_PageSpan.ProtoReflect.Descriptor instead.

func (*Chunk_PageSpan) GetPageEnd added in v1.10.0 

func (x *Chunk_PageSpan) GetPageEnd() int32

func (*Chunk_PageSpan) GetPageStart added in v1.10.0 

func (x *Chunk_PageSpan) GetPageStart() int32

func (*Chunk_PageSpan) ProtoMessage added in v1.10.0 

func (*Chunk_PageSpan) ProtoMessage()

func (*Chunk_PageSpan) ProtoReflect added in v1.10.0 

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

func (*Chunk_PageSpan) Reset added in v1.10.0 

func (x *Chunk_PageSpan) Reset()

func (*Chunk_PageSpan) String added in v1.10.0 

func (x *Chunk_PageSpan) String() string

type CloudSqlSource added in v1.7.0 

type CloudSqlSource struct {

	// The project ID that contains the Cloud SQL source. Has 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 Cloud SQL instance to copy the data from with a length limit
	// of 256 characters.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The Cloud SQL database to copy the data from with a length limit
	// of 256 characters.
	DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The Cloud SQL table to copy the data from with a length limit of
	// 256 characters.
	TableId string `protobuf:"bytes,4,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
	// Cloud SQL export to a specific Cloud Storage directory.
	//
	// Ensure that the Cloud SQL service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,5,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// Option for serverless export. Enabling this option will incur additional
	// cost. More info can be found
	// [here](https://cloud.google.com/sql/pricing#serverless).
	Offload bool `protobuf:"varint,6,opt,name=offload,proto3" json:"offload,omitempty"`
	// contains filtered or unexported fields
}

Cloud SQL source import data from.

func (*CloudSqlSource) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CloudSqlSource.ProtoReflect.Descriptor instead.

func (*CloudSqlSource) GetDatabaseId added in v1.7.0 

func (x *CloudSqlSource) GetDatabaseId() string

func (*CloudSqlSource) GetGcsStagingDir added in v1.7.0 

func (x *CloudSqlSource) GetGcsStagingDir() string

func (*CloudSqlSource) GetInstanceId added in v1.7.0 

func (x *CloudSqlSource) GetInstanceId() string

func (*CloudSqlSource) GetOffload added in v1.7.0 

func (x *CloudSqlSource) GetOffload() bool

func (*CloudSqlSource) GetProjectId added in v1.7.0 

func (x *CloudSqlSource) GetProjectId() string

func (*CloudSqlSource) GetTableId added in v1.7.0 

func (x *CloudSqlSource) GetTableId() string

func (*CloudSqlSource) ProtoMessage added in v1.7.0 

func (*CloudSqlSource) ProtoMessage()

func (*CloudSqlSource) ProtoReflect added in v1.7.0 

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

func (*CloudSqlSource) Reset added in v1.7.0 

func (x *CloudSqlSource) Reset()

func (*CloudSqlSource) String added in v1.7.0 

func (x *CloudSqlSource) 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 added in v0.3.0 

type CompleteQueryRequest struct {

	// Required. The parent data store resource name for which the completion is
	// performed, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The typeahead input used to fetch suggestions. Maximum length is
	// 128 characters.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// 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.v1beta.SearchService.Search]
	// API calls. Do not use it when there is no traffic for Search API.
	// * `user-event` - Using suggestions generated from user-imported search
	// events.
	// * `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.v1beta.UserEvent.user_pseudo_id]
	// and
	// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
	UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// 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.v1beta.CompletionService.CompleteQuery] method.

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

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

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetDataStore added in v0.3.0 

func (x *CompleteQueryRequest) GetDataStore() string

func (*CompleteQueryRequest) GetIncludeTailSuggestions added in v1.1.0 

func (x *CompleteQueryRequest) GetIncludeTailSuggestions() bool

func (*CompleteQueryRequest) GetQuery added in v0.3.0 

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetQueryModel added in v0.3.0 

func (x *CompleteQueryRequest) GetQueryModel() string

func (*CompleteQueryRequest) GetUserPseudoId added in v0.3.0 

func (x *CompleteQueryRequest) GetUserPseudoId() string

func (*CompleteQueryRequest) ProtoMessage added in v0.3.0 

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect added in v0.3.0 

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

func (*CompleteQueryRequest) Reset added in v0.3.0 

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String added in v0.3.0 

func (x *CompleteQueryRequest) String() string

type CompleteQueryResponse added in v0.3.0 

type CompleteQueryResponse struct {

	// Results of the matched query suggestions. The result list is ordered and
	// the first result is a top suggestion.
	QuerySuggestions []*CompleteQueryResponse_QuerySuggestion `protobuf:"bytes,1,rep,name=query_suggestions,json=querySuggestions,proto3" json:"query_suggestions,omitempty"`
	// 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.v1beta.CompletionService.CompleteQuery] method.

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

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

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions added in v0.3.0 

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

func (*CompleteQueryResponse) GetTailMatchTriggered added in v1.1.0 

func (x *CompleteQueryResponse) GetTailMatchTriggered() bool

func (*CompleteQueryResponse) ProtoMessage added in v0.3.0 

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect added in v0.3.0 

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

func (*CompleteQueryResponse) Reset added in v0.3.0 

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String added in v0.3.0 

func (x *CompleteQueryResponse) String() string

type CompleteQueryResponse_QuerySuggestion added in v0.3.0 

type CompleteQueryResponse_QuerySuggestion struct {

	// The suggestion for the query.
	Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// 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 added in v0.3.0 

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

Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths added in v1.5.0 

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

func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage added in v0.3.0 

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()

func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect added in v0.3.0 

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

func (*CompleteQueryResponse_QuerySuggestion) Reset added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) Reset()

func (*CompleteQueryResponse_QuerySuggestion) String added in v0.3.0 

func (x *CompleteQueryResponse_QuerySuggestion) String() string

type CompletionInfo 

type CompletionInfo struct {

	// End user selected
	// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.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.v1beta.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 added in v0.3.0 

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

func NewCompletionServiceClient added in v0.3.0 

func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient

type CompletionServiceServer added in v0.3.0 

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

CompletionServiceServer is the server API for CompletionService service.

type CompletionSuggestion added in v1.11.0 

type CompletionSuggestion struct {

	// Ranking metrics of this suggestion.
	//
	// Types that are assignable to RankingInfo:
	//
	//	*CompletionSuggestion_GlobalScore
	//	*CompletionSuggestion_Frequency
	RankingInfo isCompletionSuggestion_RankingInfo `protobuf_oneof:"ranking_info"`
	// Required. The suggestion text.
	Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// BCP-47 language code of this suggestion.
	LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// If two suggestions have the same groupId, they will not be
	// returned together. Instead the one ranked higher will be returned. This can
	// be used to deduplicate semantically identical suggestions.
	GroupId string `protobuf:"bytes,5,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// The score of this suggestion within its group.
	GroupScore float64 `protobuf:"fixed64,6,opt,name=group_score,json=groupScore,proto3" json:"group_score,omitempty"`
	// Alternative matching phrases for this suggestion.
	AlternativePhrases []string `protobuf:"bytes,7,rep,name=alternative_phrases,json=alternativePhrases,proto3" json:"alternative_phrases,omitempty"`
	// contains filtered or unexported fields
}

Autocomplete suggestions that are imported from Customer.

func (*CompletionSuggestion) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use CompletionSuggestion.ProtoReflect.Descriptor instead.

func (*CompletionSuggestion) GetAlternativePhrases added in v1.11.0 

func (x *CompletionSuggestion) GetAlternativePhrases() []string

func (*CompletionSuggestion) GetFrequency added in v1.11.0 

func (x *CompletionSuggestion) GetFrequency() int64

func (*CompletionSuggestion) GetGlobalScore added in v1.11.0 

func (x *CompletionSuggestion) GetGlobalScore() float64

func (*CompletionSuggestion) GetGroupId added in v1.11.0 

func (x *CompletionSuggestion) GetGroupId() string

func (*CompletionSuggestion) GetGroupScore added in v1.11.0 

func (x *CompletionSuggestion) GetGroupScore() float64

func (*CompletionSuggestion) GetLanguageCode added in v1.11.0 

func (x *CompletionSuggestion) GetLanguageCode() string

func (*CompletionSuggestion) GetRankingInfo added in v1.11.0 

func (m *CompletionSuggestion) GetRankingInfo() isCompletionSuggestion_RankingInfo

func (*CompletionSuggestion) GetSuggestion added in v1.11.0 

func (x *CompletionSuggestion) GetSuggestion() string

func (*CompletionSuggestion) ProtoMessage added in v1.11.0 

func (*CompletionSuggestion) ProtoMessage()

func (*CompletionSuggestion) ProtoReflect added in v1.11.0 

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

func (*CompletionSuggestion) Reset added in v1.11.0 

func (x *CompletionSuggestion) Reset()

func (*CompletionSuggestion) String added in v1.11.0 

func (x *CompletionSuggestion) String() string

type CompletionSuggestion_Frequency added in v1.11.0 

type CompletionSuggestion_Frequency struct {
	// Frequency of this suggestion. Will be used to rank suggestions when score
	// is not available.
	Frequency int64 `protobuf:"varint,3,opt,name=frequency,proto3,oneof"`
}

type CompletionSuggestion_GlobalScore added in v1.11.0 

type CompletionSuggestion_GlobalScore struct {
	// Global score of this suggestion. Control how this suggestion would be
	// scored / ranked.
	GlobalScore float64 `protobuf:"fixed64,2,opt,name=global_score,json=globalScore,proto3,oneof"`
}

type Condition added in v1.8.0 

type Condition struct {

	// Search only
	// A list of terms to match the query on.
	//
	// Maximum of 10 query terms.
	QueryTerms []*Condition_QueryTerm `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Range of time(s) specifying when condition is active.
	//
	// Maximum of 10 time ranges.
	ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
	// contains filtered or unexported fields
}

Defines circumstances to be checked before allowing a behavior

func (*Condition) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetActiveTimeRange added in v1.8.0 

func (x *Condition) GetActiveTimeRange() []*Condition_TimeRange

func (*Condition) GetQueryTerms added in v1.8.0 

func (x *Condition) GetQueryTerms() []*Condition_QueryTerm

func (*Condition) ProtoMessage added in v1.8.0 

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect added in v1.8.0 

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

func (*Condition) Reset added in v1.8.0 

func (x *Condition) Reset()

func (*Condition) String added in v1.8.0 

func (x *Condition) String() string

type Condition_QueryTerm added in v1.8.0 

type Condition_QueryTerm struct {

	// The specific query value to match against
	//
	// Must be lowercase, must be UTF-8.
	// Can have at most 3 space separated terms if full_match is true.
	// Cannot be an empty string.
	// Maximum length of 5000 characters.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// Whether the search query needs to exactly match the query term.
	FullMatch bool `protobuf:"varint,2,opt,name=full_match,json=fullMatch,proto3" json:"full_match,omitempty"`
	// contains filtered or unexported fields
}

Matcher for search request query

func (*Condition_QueryTerm) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.

func (*Condition_QueryTerm) GetFullMatch added in v1.8.0 

func (x *Condition_QueryTerm) GetFullMatch() bool

func (*Condition_QueryTerm) GetValue added in v1.8.0 

func (x *Condition_QueryTerm) GetValue() string

func (*Condition_QueryTerm) ProtoMessage added in v1.8.0 

func (*Condition_QueryTerm) ProtoMessage()

func (*Condition_QueryTerm) ProtoReflect added in v1.8.0 

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

func (*Condition_QueryTerm) Reset added in v1.8.0 

func (x *Condition_QueryTerm) Reset()

func (*Condition_QueryTerm) String added in v1.8.0 

func (x *Condition_QueryTerm) String() string

type Condition_TimeRange added in v1.8.0 

type Condition_TimeRange struct {

	// Start of time range.
	//
	// Range is inclusive.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End of time range.
	//
	// Range is inclusive.
	// Must be in the future.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Used for time-dependent conditions.

func (*Condition_TimeRange) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.

func (*Condition_TimeRange) GetEndTime added in v1.8.0 

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

func (*Condition_TimeRange) GetStartTime added in v1.8.0 

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

func (*Condition_TimeRange) ProtoMessage added in v1.8.0 

func (*Condition_TimeRange) ProtoMessage()

func (*Condition_TimeRange) ProtoReflect added in v1.8.0 

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

func (*Condition_TimeRange) Reset added in v1.8.0 

func (x *Condition_TimeRange) Reset()

func (*Condition_TimeRange) String added in v1.8.0 

func (x *Condition_TimeRange) String() string

type Control added in v1.8.0 

type Control struct {

	// Actions are restricted by Vertical and Solution
	//
	// Required.
	//
	// Types that are assignable to Action:
	//
	//	*Control_BoostAction_
	//	*Control_FilterAction_
	//	*Control_RedirectAction_
	//	*Control_SynonymsAction_
	Action isControl_Action `protobuf_oneof:"action"`
	// Immutable. Fully qualified name
	// `projects/*/locations/global/dataStore/*/controls/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Human readable name. The identifier used in UI views.
	//
	// Must be UTF-8 encoded string. Length limit is 128 characters.
	// Otherwise an INVALID ARGUMENT error is thrown.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. List of all
	// [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
	// control is attached to. May take up to 10 minutes to update after changes.
	AssociatedServingConfigIds []string `` /* 143-byte string literal not displayed */
	// Required. Immutable. What solution the control belongs to.
	//
	// Must be compatible with vertical of resource.
	// Otherwise an INVALID ARGUMENT error is thrown.
	SolutionType SolutionType `` /* 152-byte string literal not displayed */
	// Specifies the use case for the control.
	// Affects what condition fields can be set.
	// Only applies to
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
	// Currently only allow one use case per control.
	// Must be set when solution_type is
	// [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
	UseCases []SearchUseCase `` /* 148-byte string literal not displayed */
	// Determines when the associated action will trigger.
	//
	// Omit to always apply the action.
	// Currently only a single condition may be specified.
	// Otherwise an INVALID ARGUMENT error is thrown.
	Conditions []*Condition `protobuf:"bytes,5,rep,name=conditions,proto3" json:"conditions,omitempty"`
	// contains filtered or unexported fields
}

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig[google.cloud.discoveryengine.v1beta.ServingConfig] to be considered at serving time. Permitted actions dependent on `SolutionType`.

func (*Control) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetAction added in v1.8.0 

func (m *Control) GetAction() isControl_Action

func (*Control) GetAssociatedServingConfigIds added in v1.8.0 

func (x *Control) GetAssociatedServingConfigIds() []string

func (*Control) GetBoostAction added in v1.8.0 

func (x *Control) GetBoostAction() *Control_BoostAction

func (*Control) GetConditions added in v1.8.0 

func (x *Control) GetConditions() []*Condition

func (*Control) GetDisplayName added in v1.8.0 

func (x *Control) GetDisplayName() string

func (*Control) GetFilterAction added in v1.8.0 

func (x *Control) GetFilterAction() *Control_FilterAction

func (*Control) GetName added in v1.8.0 

func (x *Control) GetName() string

func (*Control) GetRedirectAction added in v1.8.0 

func (x *Control) GetRedirectAction() *Control_RedirectAction

func (*Control) GetSolutionType added in v1.8.0 

func (x *Control) GetSolutionType() SolutionType

func (*Control) GetSynonymsAction added in v1.8.0 

func (x *Control) GetSynonymsAction() *Control_SynonymsAction

func (*Control) GetUseCases added in v1.8.0 

func (x *Control) GetUseCases() []SearchUseCase

func (*Control) ProtoMessage added in v1.8.0 

func (*Control) ProtoMessage()

func (*Control) ProtoReflect added in v1.8.0 

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

func (*Control) Reset added in v1.8.0 

func (x *Control) Reset()

func (*Control) String added in v1.8.0 

func (x *Control) String() string

type ControlServiceClient added in v1.8.0 

type ControlServiceClient interface {
	// Creates a Control.
	//
	// By default 1000 controls are allowed for a data store.
	// A request can be submitted to adjust this limit.
	// If the [Control][google.cloud.discoveryengine.v1beta.Control] to create
	// already exists, an ALREADY_EXISTS error is returned.
	CreateControl(ctx context.Context, in *CreateControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Deletes a Control.
	//
	// If the [Control][google.cloud.discoveryengine.v1beta.Control] to delete
	// does not exist, a NOT_FOUND error is returned.
	DeleteControl(ctx context.Context, in *DeleteControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates a Control.
	//
	// [Control][google.cloud.discoveryengine.v1beta.Control] action type cannot
	// be changed. If the [Control][google.cloud.discoveryengine.v1beta.Control]
	// to update does not exist, a NOT_FOUND error is returned.
	UpdateControl(ctx context.Context, in *UpdateControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Gets a Control.
	GetControl(ctx context.Context, in *GetControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Lists all Controls by their parent
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	ListControls(ctx context.Context, in *ListControlsRequest, opts ...grpc.CallOption) (*ListControlsResponse, error)
}

ControlServiceClient is the client API for ControlService service.

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

func NewControlServiceClient added in v1.8.0 

func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient

type ControlServiceServer added in v1.8.0 

type ControlServiceServer interface {
	// Creates a Control.
	//
	// By default 1000 controls are allowed for a data store.
	// A request can be submitted to adjust this limit.
	// If the [Control][google.cloud.discoveryengine.v1beta.Control] to create
	// already exists, an ALREADY_EXISTS error is returned.
	CreateControl(context.Context, *CreateControlRequest) (*Control, error)
	// Deletes a Control.
	//
	// If the [Control][google.cloud.discoveryengine.v1beta.Control] to delete
	// does not exist, a NOT_FOUND error is returned.
	DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)
	// Updates a Control.
	//
	// [Control][google.cloud.discoveryengine.v1beta.Control] action type cannot
	// be changed. If the [Control][google.cloud.discoveryengine.v1beta.Control]
	// to update does not exist, a NOT_FOUND error is returned.
	UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)
	// Gets a Control.
	GetControl(context.Context, *GetControlRequest) (*Control, error)
	// Lists all Controls by their parent
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)
}

ControlServiceServer is the server API for ControlService service.

type Control_BoostAction added in v1.8.0 

type Control_BoostAction struct {

	// Required. Strength of the boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0 (No-op).
	Boost float32 `protobuf:"fixed32,1,opt,name=boost,proto3" json:"boost,omitempty"`
	// Required. Specifies which products to apply the boost to.
	//
	// If no filter is provided all products will be boosted (No-op).
	// Syntax documentation:
	// https://cloud.google.com/retail/docs/filter-and-order
	// Maximum length is 5000 characters.
	// Otherwise an INVALID ARGUMENT error is thrown.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Required. Specifies which data store's documents can be boosted by this
	// control. Full data store name e.g.
	// projects/123/locations/global/collections/default_collection/dataStores/default_data_store
	DataStore string `protobuf:"bytes,3,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

Adjusts order of products in returned list.

func (*Control_BoostAction) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.

func (*Control_BoostAction) GetBoost added in v1.8.0 

func (x *Control_BoostAction) GetBoost() float32

func (*Control_BoostAction) GetDataStore added in v1.8.0 

func (x *Control_BoostAction) GetDataStore() string

func (*Control_BoostAction) GetFilter added in v1.8.0 

func (x *Control_BoostAction) GetFilter() string

func (*Control_BoostAction) ProtoMessage added in v1.8.0 

func (*Control_BoostAction) ProtoMessage()

func (*Control_BoostAction) ProtoReflect added in v1.8.0 

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

func (*Control_BoostAction) Reset added in v1.8.0 

func (x *Control_BoostAction) Reset()

func (*Control_BoostAction) String added in v1.8.0 

func (x *Control_BoostAction) String() string

type Control_BoostAction_ added in v1.8.0 

type Control_BoostAction_ struct {
	// Defines a boost-type control
	BoostAction *Control_BoostAction `protobuf:"bytes,6,opt,name=boost_action,json=boostAction,proto3,oneof"`
}

type Control_FilterAction added in v1.8.0 

type Control_FilterAction struct {

	// Required. A filter to apply on the matching condition results.
	//
	// Required
	// Syntax documentation:
	// https://cloud.google.com/retail/docs/filter-and-order
	// Maximum length is 5000 characters. Otherwise an INVALID
	// ARGUMENT error is thrown.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Required. Specifies which data store's documents can be filtered by this
	// control. Full data store name e.g.
	// projects/123/locations/global/collections/default_collection/dataStores/default_data_store
	DataStore string `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

Specified which products may be included in results. Uses same filter as boost.

func (*Control_FilterAction) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Control_FilterAction.ProtoReflect.Descriptor instead.

func (*Control_FilterAction) GetDataStore added in v1.8.0 

func (x *Control_FilterAction) GetDataStore() string

func (*Control_FilterAction) GetFilter added in v1.8.0 

func (x *Control_FilterAction) GetFilter() string

func (*Control_FilterAction) ProtoMessage added in v1.8.0 

func (*Control_FilterAction) ProtoMessage()

func (*Control_FilterAction) ProtoReflect added in v1.8.0 

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

func (*Control_FilterAction) Reset added in v1.8.0 

func (x *Control_FilterAction) Reset()

func (*Control_FilterAction) String added in v1.8.0 

func (x *Control_FilterAction) String() string

type Control_FilterAction_ added in v1.8.0 

type Control_FilterAction_ struct {
	// Defines a filter-type control
	// Currently not supported by Recommendation
	FilterAction *Control_FilterAction `protobuf:"bytes,7,opt,name=filter_action,json=filterAction,proto3,oneof"`
}

type Control_RedirectAction added in v1.8.0 

type Control_RedirectAction struct {

	// Required. The URI to which the shopper will be redirected.
	//
	// Required.
	// URI must have length equal or less than 2000 characters.
	// Otherwise an INVALID ARGUMENT error is thrown.
	RedirectUri string `protobuf:"bytes,1,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// contains filtered or unexported fields
}

Redirects a shopper to the provided URI.

func (*Control_RedirectAction) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Control_RedirectAction.ProtoReflect.Descriptor instead.

func (*Control_RedirectAction) GetRedirectUri added in v1.8.0 

func (x *Control_RedirectAction) GetRedirectUri() string

func (*Control_RedirectAction) ProtoMessage added in v1.8.0 

func (*Control_RedirectAction) ProtoMessage()

func (*Control_RedirectAction) ProtoReflect added in v1.8.0 

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

func (*Control_RedirectAction) Reset added in v1.8.0 

func (x *Control_RedirectAction) Reset()

func (*Control_RedirectAction) String added in v1.8.0 

func (x *Control_RedirectAction) String() string

type Control_RedirectAction_ added in v1.8.0 

type Control_RedirectAction_ struct {
	// Defines a redirect-type control.
	RedirectAction *Control_RedirectAction `protobuf:"bytes,9,opt,name=redirect_action,json=redirectAction,proto3,oneof"`
}

type Control_SynonymsAction added in v1.8.0 

type Control_SynonymsAction struct {

	// Defines a set of synonyms.
	// Can specify up to 100 synonyms.
	// Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
	// thrown.
	Synonyms []string `protobuf:"bytes,1,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
	// contains filtered or unexported fields
}

Creates a set of terms that will act as synonyms of one another.

Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

func (*Control_SynonymsAction) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Control_SynonymsAction.ProtoReflect.Descriptor instead.

func (*Control_SynonymsAction) GetSynonyms added in v1.8.0 

func (x *Control_SynonymsAction) GetSynonyms() []string

func (*Control_SynonymsAction) ProtoMessage added in v1.8.0 

func (*Control_SynonymsAction) ProtoMessage()

func (*Control_SynonymsAction) ProtoReflect added in v1.8.0 

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

func (*Control_SynonymsAction) Reset added in v1.8.0 

func (x *Control_SynonymsAction) Reset()

func (*Control_SynonymsAction) String added in v1.8.0 

func (x *Control_SynonymsAction) String() string

type Control_SynonymsAction_ added in v1.8.0 

type Control_SynonymsAction_ struct {
	// Treats a group of terms as synonyms of one another.
	SynonymsAction *Control_SynonymsAction `protobuf:"bytes,10,opt,name=synonyms_action,json=synonymsAction,proto3,oneof"`
}

type Conversation added in v1.1.0 

type Conversation struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
	// or
	// `projects/{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.v1beta.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 added in v1.1.0 

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

Deprecated: Use Conversation.ProtoReflect.Descriptor instead.

func (*Conversation) GetEndTime added in v1.1.0 

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

func (*Conversation) GetMessages added in v1.1.0 

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

func (*Conversation) GetName added in v1.1.0 

func (x *Conversation) GetName() string

func (*Conversation) GetStartTime added in v1.1.0 

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

func (*Conversation) GetState added in v1.1.0 

func (x *Conversation) GetState() Conversation_State

func (*Conversation) GetUserPseudoId added in v1.1.0 

func (x *Conversation) GetUserPseudoId() string

func (*Conversation) ProtoMessage added in v1.1.0 

func (*Conversation) ProtoMessage()

func (*Conversation) ProtoReflect added in v1.1.0 

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

func (*Conversation) Reset added in v1.1.0 

func (x *Conversation) Reset()

func (*Conversation) String added in v1.1.0 

func (x *Conversation) String() string

type ConversationContext added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.

func (*ConversationContext) GetActiveDocument added in v1.1.0 

func (x *ConversationContext) GetActiveDocument() string

func (*ConversationContext) GetContextDocuments added in v1.1.0 

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

func (*ConversationContext) ProtoMessage added in v1.1.0 

func (*ConversationContext) ProtoMessage()

func (*ConversationContext) ProtoReflect added in v1.1.0 

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

func (*ConversationContext) Reset added in v1.1.0 

func (x *ConversationContext) Reset()

func (*ConversationContext) String added in v1.1.0 

func (x *ConversationContext) String() string

type ConversationMessage added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.

func (*ConversationMessage) GetCreateTime added in v1.1.0 

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

func (*ConversationMessage) GetMessage added in v1.1.0 

func (m *ConversationMessage) GetMessage() isConversationMessage_Message

func (*ConversationMessage) GetReply added in v1.1.0 

func (x *ConversationMessage) GetReply() *Reply

func (*ConversationMessage) GetUserInput added in v1.1.0 

func (x *ConversationMessage) GetUserInput() *TextInput

func (*ConversationMessage) ProtoMessage added in v1.1.0 

func (*ConversationMessage) ProtoMessage()

func (*ConversationMessage) ProtoReflect added in v1.1.0 

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

func (*ConversationMessage) Reset added in v1.1.0 

func (x *ConversationMessage) Reset()

func (*ConversationMessage) String added in v1.1.0 

func (x *ConversationMessage) String() string

type ConversationMessage_Reply added in v1.1.0 

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

type ConversationMessage_UserInput added in v1.1.0 

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

type Conversation_State added in v1.1.0 

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 added in v1.1.0 

func (Conversation_State) Descriptor() protoreflect.EnumDescriptor

func (Conversation_State) Enum added in v1.1.0 

func (x Conversation_State) Enum() *Conversation_State

func (Conversation_State) EnumDescriptor deprecated added in v1.1.0 

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

Deprecated: Use Conversation_State.Descriptor instead.

func (Conversation_State) Number added in v1.1.0 

func (x Conversation_State) Number() protoreflect.EnumNumber

func (Conversation_State) String added in v1.1.0 

func (x Conversation_State) String() string

func (Conversation_State) Type added in v1.1.0 

func (Conversation_State) Type() protoreflect.EnumType

type ConversationalSearchServiceClient added in v1.1.0 

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.v1beta.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.v1beta.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.v1beta.Conversation] action
	// type cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore].
	ListConversations(ctx context.Context, in *ListConversationsRequest, opts ...grpc.CallOption) (*ListConversationsResponse, error)
	// Answer query method.
	AnswerQuery(ctx context.Context, in *AnswerQueryRequest, opts ...grpc.CallOption) (*AnswerQueryResponse, error)
	// Gets a Answer.
	GetAnswer(ctx context.Context, in *GetAnswerRequest, opts ...grpc.CallOption) (*Answer, error)
	// Creates a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1beta.Session] to create
	// already exists, an ALREADY_EXISTS error is returned.
	CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*Session, error)
	// Deletes a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete
	// does not exist, a NOT_FOUND error is returned.
	DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates a Session.
	//
	// [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot
	// be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
	// to update does not exist, a NOT_FOUND error is returned.
	UpdateSession(ctx context.Context, in *UpdateSessionRequest, opts ...grpc.CallOption) (*Session, error)
	// Gets a Session.
	GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*Session, error)
	// Lists all Sessions by their parent
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, 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.

func NewConversationalSearchServiceClient added in v1.1.0 

func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClient

type ConversationalSearchServiceServer added in v1.1.0 

type ConversationalSearchServiceServer interface {
	// Converses a conversation.
	ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)
	// Creates a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.Conversation] action
	// type cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore].
	ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
	// Answer query method.
	AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)
	// Gets a Answer.
	GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)
	// Creates a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1beta.Session] to create
	// already exists, an ALREADY_EXISTS error is returned.
	CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
	// Deletes a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete
	// does not exist, a NOT_FOUND error is returned.
	DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)
	// Updates a Session.
	//
	// [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot
	// be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
	// to update does not exist, a NOT_FOUND error is returned.
	UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)
	// Gets a Session.
	GetSession(context.Context, *GetSessionRequest) (*Session, error)
	// Lists all Sessions by their parent
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
}

ConversationalSearchServiceServer is the server API for ConversationalSearchService service.

type ConverseConversationRequest added in v1.1.0 

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.v1beta.ConversationalSearchService.ConverseConversation] method.

func (*ConverseConversationRequest) Descriptor deprecated added in v1.1.0 

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

Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.

func (*ConverseConversationRequest) GetBoostSpec added in v1.6.0 

func (x *ConverseConversationRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*ConverseConversationRequest) GetConversation added in v1.1.0 

func (x *ConverseConversationRequest) GetConversation() *Conversation

func (*ConverseConversationRequest) GetFilter added in v1.5.0 

func (x *ConverseConversationRequest) GetFilter() string

func (*ConverseConversationRequest) GetName added in v1.1.0 

func (x *ConverseConversationRequest) GetName() string

func (*ConverseConversationRequest) GetQuery added in v1.1.0 

func (x *ConverseConversationRequest) GetQuery() *TextInput

func (*ConverseConversationRequest) GetSafeSearch added in v1.1.0 

func (x *ConverseConversationRequest) GetSafeSearch() bool

func (*ConverseConversationRequest) GetServingConfig added in v1.1.0 

func (x *ConverseConversationRequest) GetServingConfig() string

func (*ConverseConversationRequest) GetSummarySpec added in v1.2.0 

func (x *ConverseConversationRequest) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec

func (*ConverseConversationRequest) GetUserLabels added in v1.2.0 

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

func (*ConverseConversationRequest) ProtoMessage added in v1.1.0 

func (*ConverseConversationRequest) ProtoMessage()

func (*ConverseConversationRequest) ProtoReflect added in v1.1.0 

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

func (*ConverseConversationRequest) Reset added in v1.1.0 

func (x *ConverseConversationRequest) Reset()

func (*ConverseConversationRequest) String added in v1.1.0 

func (x *ConverseConversationRequest) String() string

type ConverseConversationResponse added in v1.1.0 

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.v1beta.ConversationalSearchService.ConverseConversation] method.

func (*ConverseConversationResponse) Descriptor deprecated added in v1.1.0 

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

Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.

func (*ConverseConversationResponse) GetConversation added in v1.1.0 

func (x *ConverseConversationResponse) GetConversation() *Conversation

func (*ConverseConversationResponse) GetRelatedQuestions added in v1.2.0 

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

func (*ConverseConversationResponse) GetReply added in v1.1.0 

func (x *ConverseConversationResponse) GetReply() *Reply

func (*ConverseConversationResponse) GetSearchResults added in v1.1.0 

func (x *ConverseConversationResponse) GetSearchResults() []*SearchResponse_SearchResult

func (*ConverseConversationResponse) ProtoMessage added in v1.1.0 

func (*ConverseConversationResponse) ProtoMessage()

func (*ConverseConversationResponse) ProtoReflect added in v1.1.0 

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

func (*ConverseConversationResponse) Reset added in v1.1.0 

func (x *ConverseConversationResponse) Reset()

func (*ConverseConversationResponse) String added in v1.1.0 

func (x *ConverseConversationResponse) String() string

type CreateControlRequest added in v1.8.0 

type CreateControlRequest struct {

	// Required. Full resource name of parent data store. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
	// or
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Control to create.
	Control *Control `protobuf:"bytes,2,opt,name=control,proto3" json:"control,omitempty"`
	// Required. The ID to use for the Control, which will become the final
	// component of the Control's resource name.
	//
	// This value must be within 1-63 characters.
	// Valid characters are /[a-z][0-9]-_/.
	ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateControl method.

func (*CreateControlRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.

func (*CreateControlRequest) GetControl added in v1.8.0 

func (x *CreateControlRequest) GetControl() *Control

func (*CreateControlRequest) GetControlId added in v1.8.0 

func (x *CreateControlRequest) GetControlId() string

func (*CreateControlRequest) GetParent added in v1.8.0 

func (x *CreateControlRequest) GetParent() string

func (*CreateControlRequest) ProtoMessage added in v1.8.0 

func (*CreateControlRequest) ProtoMessage()

func (*CreateControlRequest) ProtoReflect added in v1.8.0 

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

func (*CreateControlRequest) Reset added in v1.8.0 

func (x *CreateControlRequest) Reset()

func (*CreateControlRequest) String added in v1.8.0 

func (x *CreateControlRequest) String() string

type CreateConversationRequest added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.

func (*CreateConversationRequest) GetConversation added in v1.1.0 

func (x *CreateConversationRequest) GetConversation() *Conversation

func (*CreateConversationRequest) GetParent added in v1.1.0 

func (x *CreateConversationRequest) GetParent() string

func (*CreateConversationRequest) ProtoMessage added in v1.1.0 

func (*CreateConversationRequest) ProtoMessage()

func (*CreateConversationRequest) ProtoReflect added in v1.1.0 

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

func (*CreateConversationRequest) Reset added in v1.1.0 

func (x *CreateConversationRequest) Reset()

func (*CreateConversationRequest) String added in v1.1.0 

func (x *CreateConversationRequest) String() string

type CreateDataStoreMetadata added in v1.5.0 

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.v1beta.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateDataStoreMetadata) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*CreateDataStoreMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateDataStoreMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateDataStoreMetadata) ProtoMessage added in v1.5.0 

func (*CreateDataStoreMetadata) ProtoMessage()

func (*CreateDataStoreMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateDataStoreMetadata) Reset added in v1.5.0 

func (x *CreateDataStoreMetadata) Reset()

func (*CreateDataStoreMetadata) String added in v1.5.0 

func (x *CreateDataStoreMetadata) String() string

type CreateDataStoreRequest added in v1.5.0 

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.v1beta.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.v1beta.DataStore], which will
	// become the final component of the
	// [DataStore][google.cloud.discoveryengine.v1beta.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 */
	// A boolean flag indicating whether to skip the default schema creation for
	// the data store. Only enable this flag if you are certain that the default
	// schema is incompatible with your use case.
	//
	// If set to true, you must manually create a schema for the data store before
	// any documents can be ingested.
	//
	// This flag cannot be specified if `data_store.starting_schema` is specified.
	SkipDefaultSchemaCreation bool `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*CreateDataStoreRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch added in v1.5.0 

func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() bool

func (*CreateDataStoreRequest) GetDataStore added in v1.5.0 

func (x *CreateDataStoreRequest) GetDataStore() *DataStore

func (*CreateDataStoreRequest) GetDataStoreId added in v1.5.0 

func (x *CreateDataStoreRequest) GetDataStoreId() string

func (*CreateDataStoreRequest) GetParent added in v1.5.0 

func (x *CreateDataStoreRequest) GetParent() string

func (*CreateDataStoreRequest) GetSkipDefaultSchemaCreation added in v1.11.0 

func (x *CreateDataStoreRequest) GetSkipDefaultSchemaCreation() bool

func (*CreateDataStoreRequest) ProtoMessage added in v1.5.0 

func (*CreateDataStoreRequest) ProtoMessage()

func (*CreateDataStoreRequest) ProtoReflect added in v1.5.0 

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

func (*CreateDataStoreRequest) Reset added in v1.5.0 

func (x *CreateDataStoreRequest) Reset()

func (*CreateDataStoreRequest) String added in v1.5.0 

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.v1beta.Document] to
	// create.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Required. The ID to use for the
	// [Document][google.cloud.discoveryengine.v1beta.Document], which becomes the
	// final component of the
	// [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
	//
	// If the caller does not have permission to create the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// This field must be unique among all
	// [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
	// [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
	// Otherwise, an `ALREADY_EXISTS` error is returned.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateDocumentRequest) Descriptor deprecated 

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

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocument 

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId 

func (x *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetParent 

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect 

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

func (*CreateDocumentRequest) Reset 

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (x *CreateDocumentRequest) String() string

type CreateEngineMetadata added in v1.5.0 

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.v1beta.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateEngineMetadata) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.

func (*CreateEngineMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateEngineMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateEngineMetadata) ProtoMessage added in v1.5.0 

func (*CreateEngineMetadata) ProtoMessage()

func (*CreateEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateEngineMetadata) Reset added in v1.5.0 

func (x *CreateEngineMetadata) Reset()

func (*CreateEngineMetadata) String added in v1.5.0 

func (x *CreateEngineMetadata) String() string

type CreateEngineRequest added in v1.5.0 

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.v1beta.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.v1beta.Engine], which will become the
	// final component of the
	// [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.EngineService.CreateEngine] method.

func (*CreateEngineRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.

func (*CreateEngineRequest) GetEngine added in v1.5.0 

func (x *CreateEngineRequest) GetEngine() *Engine

func (*CreateEngineRequest) GetEngineId added in v1.5.0 

func (x *CreateEngineRequest) GetEngineId() string

func (*CreateEngineRequest) GetParent added in v1.5.0 

func (x *CreateEngineRequest) GetParent() string

func (*CreateEngineRequest) ProtoMessage added in v1.5.0 

func (*CreateEngineRequest) ProtoMessage()

func (*CreateEngineRequest) ProtoReflect added in v1.5.0 

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

func (*CreateEngineRequest) Reset added in v1.5.0 

func (x *CreateEngineRequest) Reset()

func (*CreateEngineRequest) String added in v1.5.0 

func (x *CreateEngineRequest) String() string

type CreateEvaluationMetadata added in v1.10.0 

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

Metadata for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.

func (*CreateEvaluationMetadata) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use CreateEvaluationMetadata.ProtoReflect.Descriptor instead.

func (*CreateEvaluationMetadata) ProtoMessage added in v1.10.0 

func (*CreateEvaluationMetadata) ProtoMessage()

func (*CreateEvaluationMetadata) ProtoReflect added in v1.10.0 

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

func (*CreateEvaluationMetadata) Reset added in v1.10.0 

func (x *CreateEvaluationMetadata) Reset()

func (*CreateEvaluationMetadata) String added in v1.10.0 

func (x *CreateEvaluationMetadata) String() string

type CreateEvaluationRequest added in v1.10.0 

type CreateEvaluationRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]
	// to create.
	Evaluation *Evaluation `protobuf:"bytes,2,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.

func (*CreateEvaluationRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use CreateEvaluationRequest.ProtoReflect.Descriptor instead.

func (*CreateEvaluationRequest) GetEvaluation added in v1.10.0 

func (x *CreateEvaluationRequest) GetEvaluation() *Evaluation

func (*CreateEvaluationRequest) GetParent added in v1.10.0 

func (x *CreateEvaluationRequest) GetParent() string

func (*CreateEvaluationRequest) ProtoMessage added in v1.10.0 

func (*CreateEvaluationRequest) ProtoMessage()

func (*CreateEvaluationRequest) ProtoReflect added in v1.10.0 

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

func (*CreateEvaluationRequest) Reset added in v1.10.0 

func (x *CreateEvaluationRequest) Reset()

func (*CreateEvaluationRequest) String added in v1.10.0 

func (x *CreateEvaluationRequest) String() string

type CreateSampleQueryRequest added in v1.10.0 

type CreateSampleQueryRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to create.
	SampleQuery *SampleQuery `protobuf:"bytes,2,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
	// Required. The ID to use for the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], which will
	// become the final component of the
	// [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name].
	//
	// If the caller does not have permission to create the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
	// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// This field must be unique among all
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s with the
	// same
	// [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.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.
	SampleQueryId string `protobuf:"bytes,3,opt,name=sample_query_id,json=sampleQueryId,proto3" json:"sample_query_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] method.

func (*CreateSampleQueryRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use CreateSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*CreateSampleQueryRequest) GetParent added in v1.10.0 

func (x *CreateSampleQueryRequest) GetParent() string

func (*CreateSampleQueryRequest) GetSampleQuery added in v1.10.0 

func (x *CreateSampleQueryRequest) GetSampleQuery() *SampleQuery

func (*CreateSampleQueryRequest) GetSampleQueryId added in v1.10.0 

func (x *CreateSampleQueryRequest) GetSampleQueryId() string

func (*CreateSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*CreateSampleQueryRequest) ProtoMessage()

func (*CreateSampleQueryRequest) ProtoReflect added in v1.10.0 

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

func (*CreateSampleQueryRequest) Reset added in v1.10.0 

func (x *CreateSampleQueryRequest) Reset()

func (*CreateSampleQueryRequest) String added in v1.10.0 

func (x *CreateSampleQueryRequest) String() string

type CreateSampleQuerySetRequest added in v1.10.0 

type CreateSampleQuerySetRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to
	// create.
	SampleQuerySet *SampleQuerySet `protobuf:"bytes,2,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
	// Required. The ID to use for the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which
	// will become the final component of the
	// [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].
	//
	// If the caller does not have permission to create the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
	// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
	// returned.
	//
	// This field must be unique among all
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with
	// the same
	// [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.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.
	SampleQuerySetId string `protobuf:"bytes,3,opt,name=sample_query_set_id,json=sampleQuerySetId,proto3" json:"sample_query_set_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] method.

func (*CreateSampleQuerySetRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use CreateSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*CreateSampleQuerySetRequest) GetParent added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetParent() string

func (*CreateSampleQuerySetRequest) GetSampleQuerySet added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetSampleQuerySet() *SampleQuerySet

func (*CreateSampleQuerySetRequest) GetSampleQuerySetId added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetSampleQuerySetId() string

func (*CreateSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*CreateSampleQuerySetRequest) ProtoMessage()

func (*CreateSampleQuerySetRequest) ProtoReflect added in v1.10.0 

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

func (*CreateSampleQuerySetRequest) Reset added in v1.10.0 

func (x *CreateSampleQuerySetRequest) Reset()

func (*CreateSampleQuerySetRequest) String added in v1.10.0 

func (x *CreateSampleQuerySetRequest) String() string

type CreateSchemaMetadata added in v0.3.0 

type CreateSchemaMetadata struct {

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

Metadata for Create Schema LRO.

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

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

Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*CreateSchemaMetadata) GetCreateTime added in v0.3.0 

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

func (*CreateSchemaMetadata) GetUpdateTime added in v0.3.0 

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

func (*CreateSchemaMetadata) ProtoMessage added in v0.3.0 

func (*CreateSchemaMetadata) ProtoMessage()

func (*CreateSchemaMetadata) ProtoReflect added in v0.3.0 

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

func (*CreateSchemaMetadata) Reset added in v0.3.0 

func (x *CreateSchemaMetadata) Reset()

func (*CreateSchemaMetadata) String added in v0.3.0 

func (x *CreateSchemaMetadata) String() string

type CreateSchemaRequest added in v0.3.0 

type CreateSchemaRequest struct {

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

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

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

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

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent added in v0.3.0 

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema added in v0.3.0 

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId added in v0.3.0 

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage added in v0.3.0 

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect added in v0.3.0 

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

func (*CreateSchemaRequest) Reset added in v0.3.0 

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String added in v0.3.0 

func (x *CreateSchemaRequest) String() string

type CreateSessionRequest added in v1.7.0 

type CreateSessionRequest 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 session to create.
	Session *Session `protobuf:"bytes,2,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateSession method.

func (*CreateSessionRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.

func (*CreateSessionRequest) GetParent added in v1.7.0 

func (x *CreateSessionRequest) GetParent() string

func (*CreateSessionRequest) GetSession added in v1.7.0 

func (x *CreateSessionRequest) GetSession() *Session

func (*CreateSessionRequest) ProtoMessage added in v1.7.0 

func (*CreateSessionRequest) ProtoMessage()

func (*CreateSessionRequest) ProtoReflect added in v1.7.0 

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

func (*CreateSessionRequest) Reset added in v1.7.0 

func (x *CreateSessionRequest) Reset()

func (*CreateSessionRequest) String added in v1.7.0 

func (x *CreateSessionRequest) String() string

type CreateTargetSiteMetadata added in v1.5.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.v1beta.SiteSearchEngineService.CreateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*CreateTargetSiteMetadata) ProtoMessage()

func (*CreateTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateTargetSiteMetadata) Reset added in v1.5.0 

func (x *CreateTargetSiteMetadata) Reset()

func (*CreateTargetSiteMetadata) String added in v1.5.0 

func (x *CreateTargetSiteMetadata) String() string

type CreateTargetSiteRequest added in v1.5.0 

type CreateTargetSiteRequest struct {

	// Required. Parent resource name of
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.SiteSearchEngineService.CreateTargetSite] method.

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

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

Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteRequest) GetParent added in v1.5.0 

func (x *CreateTargetSiteRequest) GetParent() string

func (*CreateTargetSiteRequest) GetTargetSite added in v1.5.0 

func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSite

func (*CreateTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*CreateTargetSiteRequest) ProtoMessage()

func (*CreateTargetSiteRequest) ProtoReflect added in v1.5.0 

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

func (*CreateTargetSiteRequest) Reset added in v1.5.0 

func (x *CreateTargetSiteRequest) Reset()

func (*CreateTargetSiteRequest) String added in v1.5.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.v1beta.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
	// when the key is "lengths_cm".
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CustomAttribute) Descriptor deprecated 

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

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetNumbers 

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

func (*CustomAttribute) GetText 

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

func (*CustomAttribute) ProtoMessage 

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect 

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

func (*CustomAttribute) Reset 

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String 

func (x *CustomAttribute) String() string

type CustomTuningModel added in v1.8.0 

type CustomTuningModel struct {

	// Required. The fully qualified resource name of the model.
	//
	// Format:
	// `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
	// model must be an alpha-numerical string with limit of 40 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The display name of the model.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The version of the model.
	ModelVersion int64 `protobuf:"varint,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
	ModelState CustomTuningModel_ModelState `` /* 162-byte string literal not displayed */
	// Timestamp the Model was created at.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/custom_tuning_model.proto.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Timestamp the model training was initiated.
	TrainingStartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=training_start_time,json=trainingStartTime,proto3" json:"training_start_time,omitempty"`
	// The metrics of the trained model.
	Metrics map[string]float64 `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata that describes a custom tuned model.

func (*CustomTuningModel) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use CustomTuningModel.ProtoReflect.Descriptor instead.

func (*CustomTuningModel) GetCreateTime deprecated added in v1.8.0 

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

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/custom_tuning_model.proto.

func (*CustomTuningModel) GetDisplayName added in v1.8.0 

func (x *CustomTuningModel) GetDisplayName() string

func (*CustomTuningModel) GetMetrics added in v1.11.0 

func (x *CustomTuningModel) GetMetrics() map[string]float64

func (*CustomTuningModel) GetModelState added in v1.8.0 

func (x *CustomTuningModel) GetModelState() CustomTuningModel_ModelState

func (*CustomTuningModel) GetModelVersion added in v1.8.0 

func (x *CustomTuningModel) GetModelVersion() int64

func (*CustomTuningModel) GetName added in v1.8.0 

func (x *CustomTuningModel) GetName() string

func (*CustomTuningModel) GetTrainingStartTime added in v1.8.0 

func (x *CustomTuningModel) GetTrainingStartTime() *timestamppb.Timestamp

func (*CustomTuningModel) ProtoMessage added in v1.8.0 

func (*CustomTuningModel) ProtoMessage()

func (*CustomTuningModel) ProtoReflect added in v1.8.0 

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

func (*CustomTuningModel) Reset added in v1.8.0 

func (x *CustomTuningModel) Reset()

func (*CustomTuningModel) String added in v1.8.0 

func (x *CustomTuningModel) String() string

type CustomTuningModel_ModelState added in v1.8.0 

type CustomTuningModel_ModelState int32

The state of the model. 

const (
	// Default value.
	CustomTuningModel_MODEL_STATE_UNSPECIFIED CustomTuningModel_ModelState = 0
	// The model is in a paused training state.
	CustomTuningModel_TRAINING_PAUSED CustomTuningModel_ModelState = 1
	// The model is currently training.
	CustomTuningModel_TRAINING CustomTuningModel_ModelState = 2
	// The model has successfully completed training.
	CustomTuningModel_TRAINING_COMPLETE CustomTuningModel_ModelState = 3
	// The model is ready for serving.
	CustomTuningModel_READY_FOR_SERVING CustomTuningModel_ModelState = 4
	// The model training failed.
	CustomTuningModel_TRAINING_FAILED CustomTuningModel_ModelState = 5
	// The model training finished successfully but metrics did not improve.
	CustomTuningModel_NO_IMPROVEMENT CustomTuningModel_ModelState = 6
	// Input data validation failed. Model training didn't start.
	CustomTuningModel_INPUT_VALIDATION_FAILED CustomTuningModel_ModelState = 7
)

func (CustomTuningModel_ModelState) Descriptor added in v1.8.0 

func (CustomTuningModel_ModelState) Descriptor() protoreflect.EnumDescriptor

func (CustomTuningModel_ModelState) Enum added in v1.8.0 

func (x CustomTuningModel_ModelState) Enum() *CustomTuningModel_ModelState

func (CustomTuningModel_ModelState) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use CustomTuningModel_ModelState.Descriptor instead.

func (CustomTuningModel_ModelState) Number added in v1.8.0 

func (x CustomTuningModel_ModelState) Number() protoreflect.EnumNumber

func (CustomTuningModel_ModelState) String added in v1.8.0 

func (x CustomTuningModel_ModelState) String() string

func (CustomTuningModel_ModelState) Type added in v1.8.0 

func (CustomTuningModel_ModelState) Type() protoreflect.EnumType

type DataStore added in v1.5.0 

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 `` /* 168-byte string literal not displayed */
	// The solutions that the data store enrolls. Available solutions for each
	// [industry_vertical][google.cloud.discoveryengine.v1beta.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 `` /* 162-byte string literal not displayed */
	// Output only. The id of the default
	// [Schema][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore.ContentConfig.NO_CONTENT].
	ContentConfig DataStore_ContentConfig `` /* 166-byte string literal not displayed */
	// Output only. Timestamp the
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Language info for DataStore.
	LanguageInfo *LanguageInfo `protobuf:"bytes,14,opt,name=language_info,json=languageInfo,proto3" json:"language_info,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.v1beta.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.v1beta.DataStore], use
	// [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.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 added in v1.5.0 

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

Deprecated: Use DataStore.ProtoReflect.Descriptor instead.

func (*DataStore) GetContentConfig added in v1.5.0 

func (x *DataStore) GetContentConfig() DataStore_ContentConfig

func (*DataStore) GetCreateTime added in v1.5.0 

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

func (*DataStore) GetDefaultSchemaId added in v1.5.0 

func (x *DataStore) GetDefaultSchemaId() string

func (*DataStore) GetDisplayName added in v1.5.0 

func (x *DataStore) GetDisplayName() string

func (*DataStore) GetDocumentProcessingConfig added in v1.6.0 

func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*DataStore) GetIndustryVertical added in v1.5.0 

func (x *DataStore) GetIndustryVertical() IndustryVertical

func (*DataStore) GetLanguageInfo added in v1.11.0 

func (x *DataStore) GetLanguageInfo() *LanguageInfo

func (*DataStore) GetName added in v1.5.0 

func (x *DataStore) GetName() string

func (*DataStore) GetSolutionTypes added in v1.5.0 

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

func (*DataStore) GetStartingSchema added in v1.6.0 

func (x *DataStore) GetStartingSchema() *Schema

func (*DataStore) ProtoMessage added in v1.5.0 

func (*DataStore) ProtoMessage()

func (*DataStore) ProtoReflect added in v1.5.0 

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

func (*DataStore) Reset added in v1.5.0 

func (x *DataStore) Reset()

func (*DataStore) String added in v1.5.0 

func (x *DataStore) String() string

type DataStoreServiceClient added in v1.5.0 

type DataStoreServiceClient interface {
	// Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	//
	// DataStore is for storing
	// [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
	// documents for Search, or Recommendation use case, an
	// [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
	// separately.
	CreateDataStore(ctx context.Context, in *CreateDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	GetDataStore(ctx context.Context, in *GetDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
	// Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
	// associated with the project.
	ListDataStores(ctx context.Context, in *ListDataStoresRequest, opts ...grpc.CallOption) (*ListDataStoresResponse, error)
	// Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	DeleteDataStore(ctx context.Context, in *DeleteDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
	UpdateDataStore(ctx context.Context, in *UpdateDataStoreRequest, opts ...grpc.CallOption) (*DataStore, 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.

func NewDataStoreServiceClient added in v1.5.0 

func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClient

type DataStoreServiceServer added in v1.5.0 

type DataStoreServiceServer interface {
	// Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	//
	// DataStore is for storing
	// [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
	// documents for Search, or Recommendation use case, an
	// [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
	// separately.
	CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)
	// Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)
	// Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
	// associated with the project.
	ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)
	// Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
	DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)
	// Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
	UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)
}

DataStoreServiceServer is the server API for DataStoreService service.

type DataStore_ContentConfig added in v1.5.0 

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.v1beta.Document.content].
	DataStore_NO_CONTENT DataStore_ContentConfig = 1
	// Only contains documents with
	// [Document.content][google.cloud.discoveryengine.v1beta.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 added in v1.5.0 

func (DataStore_ContentConfig) Descriptor() protoreflect.EnumDescriptor

func (DataStore_ContentConfig) Enum added in v1.5.0 

func (x DataStore_ContentConfig) Enum() *DataStore_ContentConfig

func (DataStore_ContentConfig) EnumDescriptor deprecated added in v1.5.0 

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

Deprecated: Use DataStore_ContentConfig.Descriptor instead.

func (DataStore_ContentConfig) Number added in v1.5.0 

func (x DataStore_ContentConfig) Number() protoreflect.EnumNumber

func (DataStore_ContentConfig) String added in v1.5.0 

func (x DataStore_ContentConfig) String() string

func (DataStore_ContentConfig) Type added in v1.5.0 

func (DataStore_ContentConfig) Type() protoreflect.EnumType

type DeleteControlRequest added in v1.8.0 

type DeleteControlRequest struct {

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

Request for DeleteControl method.

func (*DeleteControlRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.

func (*DeleteControlRequest) GetName added in v1.8.0 

func (x *DeleteControlRequest) GetName() string

func (*DeleteControlRequest) ProtoMessage added in v1.8.0 

func (*DeleteControlRequest) ProtoMessage()

func (*DeleteControlRequest) ProtoReflect added in v1.8.0 

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

func (*DeleteControlRequest) Reset added in v1.8.0 

func (x *DeleteControlRequest) Reset()

func (*DeleteControlRequest) String added in v1.8.0 

func (x *DeleteControlRequest) String() string

type DeleteConversationRequest added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.

func (*DeleteConversationRequest) GetName added in v1.1.0 

func (x *DeleteConversationRequest) GetName() string

func (*DeleteConversationRequest) ProtoMessage added in v1.1.0 

func (*DeleteConversationRequest) ProtoMessage()

func (*DeleteConversationRequest) ProtoReflect added in v1.1.0 

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

func (*DeleteConversationRequest) Reset added in v1.1.0 

func (x *DeleteConversationRequest) Reset()

func (*DeleteConversationRequest) String added in v1.1.0 

func (x *DeleteConversationRequest) String() string

type DeleteDataStoreMetadata added in v1.5.0 

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.v1beta.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteDataStoreMetadata) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteDataStoreMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteDataStoreMetadata) ProtoMessage added in v1.5.0 

func (*DeleteDataStoreMetadata) ProtoMessage()

func (*DeleteDataStoreMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteDataStoreMetadata) Reset added in v1.5.0 

func (x *DeleteDataStoreMetadata) Reset()

func (*DeleteDataStoreMetadata) String added in v1.5.0 

func (x *DeleteDataStoreMetadata) String() string

type DeleteDataStoreRequest added in v1.5.0 

type DeleteDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.DataStoreService.DeleteDataStore] method.

func (*DeleteDataStoreRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreRequest) GetName added in v1.5.0 

func (x *DeleteDataStoreRequest) GetName() string

func (*DeleteDataStoreRequest) ProtoMessage added in v1.5.0 

func (*DeleteDataStoreRequest) ProtoMessage()

func (*DeleteDataStoreRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteDataStoreRequest) Reset added in v1.5.0 

func (x *DeleteDataStoreRequest) Reset()

func (*DeleteDataStoreRequest) String added in v1.5.0 

func (x *DeleteDataStoreRequest) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

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

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

func (*DeleteDocumentRequest) Descriptor deprecated 

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

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetName 

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

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

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteEngineMetadata added in v1.5.0 

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.v1beta.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteEngineMetadata) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.

func (*DeleteEngineMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteEngineMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteEngineMetadata) ProtoMessage added in v1.5.0 

func (*DeleteEngineMetadata) ProtoMessage()

func (*DeleteEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteEngineMetadata) Reset added in v1.5.0 

func (x *DeleteEngineMetadata) Reset()

func (*DeleteEngineMetadata) String added in v1.5.0 

func (x *DeleteEngineMetadata) String() string

type DeleteEngineRequest added in v1.5.0 

type DeleteEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.Engine], regardless of whether
	// or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.EngineService.DeleteEngine] method.

func (*DeleteEngineRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.

func (*DeleteEngineRequest) GetName added in v1.5.0 

func (x *DeleteEngineRequest) GetName() string

func (*DeleteEngineRequest) ProtoMessage added in v1.5.0 

func (*DeleteEngineRequest) ProtoMessage()

func (*DeleteEngineRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteEngineRequest) Reset added in v1.5.0 

func (x *DeleteEngineRequest) Reset()

func (*DeleteEngineRequest) String added in v1.5.0 

func (x *DeleteEngineRequest) String() string

type DeleteSampleQueryRequest added in v1.10.0 

type DeleteSampleQueryRequest struct {

	// Required. Full resource name of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
	//
	// If the caller does not have permission to delete the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
	// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] 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 [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] method.

func (*DeleteSampleQueryRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use DeleteSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*DeleteSampleQueryRequest) GetName added in v1.10.0 

func (x *DeleteSampleQueryRequest) GetName() string

func (*DeleteSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*DeleteSampleQueryRequest) ProtoMessage()

func (*DeleteSampleQueryRequest) ProtoReflect added in v1.10.0 

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

func (*DeleteSampleQueryRequest) Reset added in v1.10.0 

func (x *DeleteSampleQueryRequest) Reset()

func (*DeleteSampleQueryRequest) String added in v1.10.0 

func (x *DeleteSampleQueryRequest) String() string

type DeleteSampleQuerySetRequest added in v1.10.0 

type DeleteSampleQuerySetRequest struct {

	// Required. Full resource name of
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such
	// as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
	//
	// If the caller does not have permission to delete the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
	// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
	// returned.
	//
	// If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
	// 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 [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] method.

func (*DeleteSampleQuerySetRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use DeleteSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*DeleteSampleQuerySetRequest) GetName added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) GetName() string

func (*DeleteSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*DeleteSampleQuerySetRequest) ProtoMessage()

func (*DeleteSampleQuerySetRequest) ProtoReflect added in v1.10.0 

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

func (*DeleteSampleQuerySetRequest) Reset added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) Reset()

func (*DeleteSampleQuerySetRequest) String added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) String() string

type DeleteSchemaMetadata added in v0.3.0 

type DeleteSchemaMetadata struct {

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

Metadata for DeleteSchema LRO.

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

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

Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSchemaMetadata) GetCreateTime added in v0.3.0 

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

func (*DeleteSchemaMetadata) GetUpdateTime added in v0.3.0 

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

func (*DeleteSchemaMetadata) ProtoMessage added in v0.3.0 

func (*DeleteSchemaMetadata) ProtoMessage()

func (*DeleteSchemaMetadata) ProtoReflect added in v0.3.0 

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

func (*DeleteSchemaMetadata) Reset added in v0.3.0 

func (x *DeleteSchemaMetadata) Reset()

func (*DeleteSchemaMetadata) String added in v0.3.0 

func (x *DeleteSchemaMetadata) String() string

type DeleteSchemaRequest added in v0.3.0 

type DeleteSchemaRequest struct {

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

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

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

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

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName added in v0.3.0 

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage added in v0.3.0 

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect added in v0.3.0 

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

func (*DeleteSchemaRequest) Reset added in v0.3.0 

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String added in v0.3.0 

func (x *DeleteSchemaRequest) String() string

type DeleteSessionRequest added in v1.7.0 

type DeleteSessionRequest struct {

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

Request for DeleteSession method.

func (*DeleteSessionRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use DeleteSessionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSessionRequest) GetName added in v1.7.0 

func (x *DeleteSessionRequest) GetName() string

func (*DeleteSessionRequest) ProtoMessage added in v1.7.0 

func (*DeleteSessionRequest) ProtoMessage()

func (*DeleteSessionRequest) ProtoReflect added in v1.7.0 

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

func (*DeleteSessionRequest) Reset added in v1.7.0 

func (x *DeleteSessionRequest) Reset()

func (*DeleteSessionRequest) String added in v1.7.0 

func (x *DeleteSessionRequest) String() string

type DeleteTargetSiteMetadata added in v1.5.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.v1beta.SiteSearchEngineService.DeleteTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*DeleteTargetSiteMetadata) ProtoMessage()

func (*DeleteTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) Reset added in v1.5.0 

func (x *DeleteTargetSiteMetadata) Reset()

func (*DeleteTargetSiteMetadata) String added in v1.5.0 

func (x *DeleteTargetSiteMetadata) String() string

type DeleteTargetSiteRequest added in v1.5.0 

type DeleteTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.DeleteTargetSite] method.

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

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

Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteRequest) GetName added in v1.5.0 

func (x *DeleteTargetSiteRequest) GetName() string

func (*DeleteTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*DeleteTargetSiteRequest) ProtoMessage()

func (*DeleteTargetSiteRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteTargetSiteRequest) Reset added in v1.5.0 

func (x *DeleteTargetSiteRequest) Reset()

func (*DeleteTargetSiteRequest) String added in v1.5.0 

func (x *DeleteTargetSiteRequest) String() string

type DisableAdvancedSiteSearchMetadata added in v1.5.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.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchMetadata) GetCreateTime added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()

func (*DisableAdvancedSiteSearchMetadata) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchMetadata) Reset()

func (*DisableAdvancedSiteSearchMetadata) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchMetadata) String() string

type DisableAdvancedSiteSearchRequest added in v1.5.0 

type DisableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.

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

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

Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*DisableAdvancedSiteSearchRequest) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchRequest) ProtoMessage()

func (*DisableAdvancedSiteSearchRequest) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchRequest) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) Reset()

func (*DisableAdvancedSiteSearchRequest) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) String() string

type DisableAdvancedSiteSearchResponse added in v1.5.0 

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchResponse) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchResponse) ProtoMessage()

func (*DisableAdvancedSiteSearchResponse) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchResponse) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchResponse) Reset()

func (*DisableAdvancedSiteSearchResponse) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchResponse) String() string

type Document 

type Document struct {

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

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

func (*Document) Descriptor deprecated 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent added in v0.3.0 

func (x *Document) GetContent() *Document_Content

func (*Document) GetData 

func (m *Document) GetData() isDocument_Data

func (*Document) GetDerivedStructData added in v0.3.0 

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

func (*Document) GetId 

func (x *Document) GetId() string

func (*Document) GetIndexStatus added in v1.14.0 

func (x *Document) GetIndexStatus() *Document_IndexStatus

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.v1beta.Document].
	//
	// * If [id][google.cloud.discoveryengine.v1beta.DocumentInfo.id] is
	// specified, then the default values for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are
	// used when annotating with the stored Document.
	//
	// * If [name][google.cloud.discoveryengine.v1beta.DocumentInfo.name] is
	// specified, then the provided values (default values allowed) for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and
	// `{branch_id}` are used when annotating with the stored Document.
	//
	// Types that are assignable to DocumentDescriptor:
	//
	//	*DocumentInfo_Id
	//	*DocumentInfo_Name
	//	*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 is 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"`
	// Output only. Whether the referenced Document can be found in the data
	// store.
	Joined bool `protobuf:"varint,5,opt,name=joined,proto3" json:"joined,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) GetJoined added in v1.14.0 

func (x *DocumentInfo) GetJoined() bool

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 added in v1.2.0 

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.v1beta.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.v1beta.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 added in v1.2.0 

type DocumentInfo_Uri struct {
	// The [Document][google.cloud.discoveryengine.v1beta.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
	// layout parsing are supported.
	// * `docx`: Override parsing config for DOCX files, only digital parsing and
	// layout parsing are supported.
	// * `pptx`: Override parsing config for PPTX files, only digital parsing and
	// layout parsing are supported.
	// * `xlsx`: Override parsing config for XLSX files, only digital parsing and
	// 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.v1beta.DataStore]. It's empty when DataStore[google.cloud.discoveryengine.v1beta.DataStore] is created, which defaults to digital parser. The first call to [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.10.0 

func (x *DocumentProcessingConfig) GetChunkingConfig() *DocumentProcessingConfig_ChunkingConfig

func (*DocumentProcessingConfig) GetDefaultParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig) GetDefaultParsingConfig() *DocumentProcessingConfig_ParsingConfig

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.10.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.10.0 

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode added in v1.10.0 

func (m *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkMode

func (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig() *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage added in v1.10.0 

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect added in v1.10.0 

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

func (*DocumentProcessingConfig_ChunkingConfig) Reset added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig) String added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig added in v1.10.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.10.0 

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize() int32

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings() bool

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage added in v1.10.0 

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect added in v1.10.0 

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String added in v1.10.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ added in v1.10.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 (x *DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig added in v1.10.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig() *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

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) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) String() string

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 

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String() string

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.10.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.10.0 

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage added in v1.10.0 

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect added in v1.10.0 

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

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset added in v1.10.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String added in v1.10.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ added in v1.10.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 {

	// [DEPRECATED] This field is deprecated. To use the additional enhanced
	// document elements processing, please switch to `layout_parsing_config`.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/document_processing_config.proto.
	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 

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.

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

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

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/document_processing_config.proto.

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText() bool

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String() string

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

DocumentServiceClient is the client API for DocumentService service.

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

func NewDocumentServiceClient 

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

type DocumentServiceServer 

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

DocumentServiceServer is the server API for DocumentService service.

type Document_Content added in v0.3.0 

type Document_Content struct {

	// Types that are assignable to Content:
	//
	//	*Document_Content_RawBytes
	//	*Document_Content_Uri
	Content isDocument_Content_Content `protobuf_oneof:"content"`
	// The MIME type of the content. Supported types:
	//
	// * `application/pdf` (PDF, 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 added in v0.3.0 

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

Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.

func (*Document_Content) GetContent added in v0.3.0 

func (m *Document_Content) GetContent() isDocument_Content_Content

func (*Document_Content) GetMimeType added in v0.3.0 

func (x *Document_Content) GetMimeType() string

func (*Document_Content) GetRawBytes added in v0.3.0 

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

func (*Document_Content) GetUri added in v0.3.0 

func (x *Document_Content) GetUri() string

func (*Document_Content) ProtoMessage added in v0.3.0 

func (*Document_Content) ProtoMessage()

func (*Document_Content) ProtoReflect added in v0.3.0 

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

func (*Document_Content) Reset added in v0.3.0 

func (x *Document_Content) Reset()

func (*Document_Content) String added in v0.3.0 

func (x *Document_Content) String() string

type Document_Content_RawBytes added in v0.3.0 

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

type Document_Content_Uri added in v0.3.0 

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

type Document_IndexStatus added in v1.14.0 

type Document_IndexStatus struct {

	// The time when the document was indexed.
	// If this field is populated, it means the document has been indexed.
	IndexTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
	// A sample of errors encountered while indexing the document.
	// If this field is populated, the document is not indexed due to errors.
	ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

Index status of the document.

func (*Document_IndexStatus) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use Document_IndexStatus.ProtoReflect.Descriptor instead.

func (*Document_IndexStatus) GetErrorSamples added in v1.14.0 

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

func (*Document_IndexStatus) GetIndexTime added in v1.14.0 

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

func (*Document_IndexStatus) ProtoMessage added in v1.14.0 

func (*Document_IndexStatus) ProtoMessage()

func (*Document_IndexStatus) ProtoReflect added in v1.14.0 

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

func (*Document_IndexStatus) Reset added in v1.14.0 

func (x *Document_IndexStatus) Reset()

func (*Document_IndexStatus) String added in v1.14.0 

func (x *Document_IndexStatus) String() string

type Document_JsonData 

type Document_JsonData struct {
	// The JSON string representation of the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1beta.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.v1beta.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,4,opt,name=struct_data,json=structData,proto3,oneof"`
}

type DoubleList added in v1.2.0 

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 added in v1.2.0 

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

Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.

func (*DoubleList) GetValues added in v1.2.0 

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

func (*DoubleList) ProtoMessage added in v1.2.0 

func (*DoubleList) ProtoMessage()

func (*DoubleList) ProtoReflect added in v1.2.0 

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

func (*DoubleList) Reset added in v1.2.0 

func (x *DoubleList) Reset()

func (*DoubleList) String added in v1.2.0 

func (x *DoubleList) String() string

type EmbeddingConfig added in v1.5.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.5.0 

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

Deprecated: Use EmbeddingConfig.ProtoReflect.Descriptor instead.

func (*EmbeddingConfig) GetFieldPath added in v1.5.0 

func (x *EmbeddingConfig) GetFieldPath() string

func (*EmbeddingConfig) ProtoMessage added in v1.5.0 

func (*EmbeddingConfig) ProtoMessage()

func (*EmbeddingConfig) ProtoReflect added in v1.5.0 

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

func (*EmbeddingConfig) Reset added in v1.5.0 

func (x *EmbeddingConfig) Reset()

func (*EmbeddingConfig) String added in v1.5.0 

func (x *EmbeddingConfig) String() string

type EnableAdvancedSiteSearchMetadata added in v1.5.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.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchMetadata) GetCreateTime added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()

func (*EnableAdvancedSiteSearchMetadata) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchMetadata) Reset()

func (*EnableAdvancedSiteSearchMetadata) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchMetadata) String() string

type EnableAdvancedSiteSearchRequest added in v1.5.0 

type EnableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.

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

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

Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*EnableAdvancedSiteSearchRequest) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchRequest) ProtoMessage()

func (*EnableAdvancedSiteSearchRequest) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchRequest) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) Reset()

func (*EnableAdvancedSiteSearchRequest) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) String() string

type EnableAdvancedSiteSearchResponse added in v1.5.0 

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchResponse) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchResponse) ProtoMessage()

func (*EnableAdvancedSiteSearchResponse) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchResponse) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchResponse) Reset()

func (*EnableAdvancedSiteSearchResponse) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchResponse) String() string

type Engine added in v1.5.0 

type Engine struct {

	// Additional config specs that defines the behavior of the engine.
	//
	// Types that are assignable to EngineConfig:
	//
	//	*Engine_ChatEngineConfig_
	//	*Engine_SearchEngineConfig_
	EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
	// Engine metadata to monitor the status of the engine.
	//
	// Types that are assignable to EngineMetadata:
	//
	//	*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.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
	// and
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
	// type of engines, they can only associate with at most one data store.
	//
	// If
	// [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
	// multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
	// same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
	// associated here.
	//
	// Note that when used in
	// [CreateEngineRequest][google.cloud.discoveryengine.v1beta.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 `` /* 152-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.v1beta.DataStore]: If unspecified,
	// default to `GENERIC`. Vertical on Engine has to match vertical of the
	// DataStore linked to the engine.
	IndustryVertical IndustryVertical `` /* 169-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.v1beta.Engine].

func (*Engine) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use Engine.ProtoReflect.Descriptor instead.

func (*Engine) GetChatEngineConfig added in v1.5.0 

func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig

func (*Engine) GetChatEngineMetadata added in v1.5.0 

func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata

func (*Engine) GetCommonConfig added in v1.5.0 

func (x *Engine) GetCommonConfig() *Engine_CommonConfig

func (*Engine) GetCreateTime added in v1.5.0 

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

func (*Engine) GetDataStoreIds added in v1.5.0 

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

func (*Engine) GetDisplayName added in v1.5.0 

func (x *Engine) GetDisplayName() string

func (*Engine) GetEngineConfig added in v1.5.0 

func (m *Engine) GetEngineConfig() isEngine_EngineConfig

func (*Engine) GetEngineMetadata added in v1.5.0 

func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata

func (*Engine) GetIndustryVertical added in v1.5.0 

func (x *Engine) GetIndustryVertical() IndustryVertical

func (*Engine) GetName added in v1.5.0 

func (x *Engine) GetName() string

func (*Engine) GetSearchEngineConfig added in v1.5.0 

func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfig

func (*Engine) GetSolutionType added in v1.5.0 

func (x *Engine) GetSolutionType() SolutionType

func (*Engine) GetUpdateTime added in v1.5.0 

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

func (*Engine) ProtoMessage added in v1.5.0 

func (*Engine) ProtoMessage()

func (*Engine) ProtoReflect added in v1.5.0 

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

func (*Engine) Reset added in v1.5.0 

func (x *Engine) Reset()

func (*Engine) String added in v1.5.0 

func (x *Engine) String() string

type EngineServiceClient added in v1.5.0 

type EngineServiceClient interface {
	// Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	CreateEngine(ctx context.Context, in *CreateEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	DeleteEngine(ctx context.Context, in *DeleteEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine]
	UpdateEngine(ctx context.Context, in *UpdateEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	GetEngine(ctx context.Context, in *GetEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.

func NewEngineServiceClient added in v1.5.0 

func NewEngineServiceClient(cc grpc.ClientConnInterface) EngineServiceClient

type EngineServiceServer added in v1.5.0 

type EngineServiceServer interface {
	// Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine]
	UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine].
	GetEngine(context.Context, *GetEngineRequest) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)
	// Resumes the training of an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)
	// Tunes an existing engine. Only applicable if
	// [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
	TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)
}

EngineServiceServer is the server API for EngineService service.

type Engine_ChatEngineConfig added in v1.5.0 

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.v1beta.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.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.v1beta.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
	// API after engine creation. Use
	// [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1beta.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 added in v1.5.0 

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

Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig) GetAgentCreationConfig added in v1.5.0 

func (x *Engine_ChatEngineConfig) GetAgentCreationConfig() *Engine_ChatEngineConfig_AgentCreationConfig
func (x *Engine_ChatEngineConfig) GetDialogflowAgentToLink() string

func (*Engine_ChatEngineConfig) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineConfig) ProtoMessage()

func (*Engine_ChatEngineConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineConfig) Reset added in v1.5.0 

func (x *Engine_ChatEngineConfig) Reset()

func (*Engine_ChatEngineConfig) String added in v1.5.0 

func (x *Engine_ChatEngineConfig) String() string

type Engine_ChatEngineConfig_ added in v1.5.0 

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

type Engine_ChatEngineConfig_AgentCreationConfig added in v1.5.0 

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.v1beta.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] API after engine creation.

func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetLocation() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage()

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) Reset()

func (*Engine_ChatEngineConfig_AgentCreationConfig) String added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) String() string

type Engine_ChatEngineMetadata added in v1.5.0 

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 added in v1.5.0 

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

Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineMetadata) GetDialogflowAgent added in v1.5.0 

func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() string

func (*Engine_ChatEngineMetadata) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineMetadata) ProtoMessage()

func (*Engine_ChatEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineMetadata) Reset added in v1.5.0 

func (x *Engine_ChatEngineMetadata) Reset()

func (*Engine_ChatEngineMetadata) String added in v1.5.0 

func (x *Engine_ChatEngineMetadata) String() string

type Engine_ChatEngineMetadata_ added in v1.5.0 

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

type Engine_CommonConfig added in v1.5.0 

type Engine_CommonConfig struct {

	// 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 added in v1.5.0 

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

Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.

func (*Engine_CommonConfig) GetCompanyName added in v1.5.0 

func (x *Engine_CommonConfig) GetCompanyName() string

func (*Engine_CommonConfig) ProtoMessage added in v1.5.0 

func (*Engine_CommonConfig) ProtoMessage()

func (*Engine_CommonConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_CommonConfig) Reset added in v1.5.0 

func (x *Engine_CommonConfig) Reset()

func (*Engine_CommonConfig) String added in v1.5.0 

func (x *Engine_CommonConfig) String() string

type Engine_SearchEngineConfig added in v1.5.0 

type Engine_SearchEngineConfig struct {

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

Configurations for a Search Engine.

func (*Engine_SearchEngineConfig) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SearchEngineConfig) GetSearchAddOns added in v1.5.0 

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

func (*Engine_SearchEngineConfig) GetSearchTier added in v1.5.0 

func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTier

func (*Engine_SearchEngineConfig) ProtoMessage added in v1.5.0 

func (*Engine_SearchEngineConfig) ProtoMessage()

func (*Engine_SearchEngineConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_SearchEngineConfig) Reset added in v1.5.0 

func (x *Engine_SearchEngineConfig) Reset()

func (*Engine_SearchEngineConfig) String added in v1.5.0 

func (x *Engine_SearchEngineConfig) String() string

type Engine_SearchEngineConfig_ added in v1.5.0 

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

type Evaluation added in v1.10.0 

type Evaluation struct {

	// Identifier. The full resource name of the
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], in the format
	// of `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// 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 specification of the evaluation.
	EvaluationSpec *Evaluation_EvaluationSpec `protobuf:"bytes,2,opt,name=evaluation_spec,json=evaluationSpec,proto3" json:"evaluation_spec,omitempty"`
	// Output only. The metrics produced by the evaluation, averaged across all
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s in the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	//
	// Only populated when the evaluation's state is SUCCEEDED.
	QualityMetrics *QualityMetrics `protobuf:"bytes,3,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
	// Output only. The state of the evaluation.
	State Evaluation_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Evaluation_State" json:"state,omitempty"`
	// Output only. The error that occurred during evaluation. Only populated when
	// the evaluation's state is FAILED.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. Timestamp the
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was created
	// at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp the
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was completed
	// at.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,8,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

func (*Evaluation) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use Evaluation.ProtoReflect.Descriptor instead.

func (*Evaluation) GetCreateTime added in v1.10.0 

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

func (*Evaluation) GetEndTime added in v1.10.0 

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

func (*Evaluation) GetError added in v1.10.0 

func (x *Evaluation) GetError() *status.Status

func (*Evaluation) GetErrorSamples added in v1.10.0 

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

func (*Evaluation) GetEvaluationSpec added in v1.10.0 

func (x *Evaluation) GetEvaluationSpec() *Evaluation_EvaluationSpec

func (*Evaluation) GetName added in v1.10.0 

func (x *Evaluation) GetName() string

func (*Evaluation) GetQualityMetrics added in v1.10.0 

func (x *Evaluation) GetQualityMetrics() *QualityMetrics

func (*Evaluation) GetState added in v1.10.0 

func (x *Evaluation) GetState() Evaluation_State

func (*Evaluation) ProtoMessage added in v1.10.0 

func (*Evaluation) ProtoMessage()

func (*Evaluation) ProtoReflect added in v1.10.0 

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

func (*Evaluation) Reset added in v1.10.0 

func (x *Evaluation) Reset()

func (*Evaluation) String added in v1.10.0 

func (x *Evaluation) String() string

type EvaluationServiceClient added in v1.10.0 

type EvaluationServiceClient interface {
	// Gets a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
	// Gets a list of
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.
	ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
	// Creates a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	//
	// Upon creation, the evaluation will be automatically triggered and begin
	// execution.
	CreateEvaluation(ctx context.Context, in *CreateEvaluationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of results for a given a
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	ListEvaluationResults(ctx context.Context, in *ListEvaluationResultsRequest, opts ...grpc.CallOption) (*ListEvaluationResultsResponse, error)
}

EvaluationServiceClient is the client API for EvaluationService service.

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

func NewEvaluationServiceClient added in v1.10.0 

func NewEvaluationServiceClient(cc grpc.ClientConnInterface) EvaluationServiceClient

type EvaluationServiceServer added in v1.10.0 

type EvaluationServiceServer interface {
	// Gets a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)
	// Gets a list of
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.
	ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)
	// Creates a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	//
	// Upon creation, the evaluation will be automatically triggered and begin
	// execution.
	CreateEvaluation(context.Context, *CreateEvaluationRequest) (*longrunningpb.Operation, error)
	// Gets a list of results for a given a
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
	ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)
}

EvaluationServiceServer is the server API for EvaluationService service.

type Evaluation_EvaluationSpec added in v1.10.0 

type Evaluation_EvaluationSpec struct {

	// The search specification.
	//
	// Types that are assignable to SearchSpec:
	//
	//	*Evaluation_EvaluationSpec_SearchRequest
	SearchSpec isEvaluation_EvaluationSpec_SearchSpec `protobuf_oneof:"search_spec"`
	// Required. The specification of the query set.
	QuerySetSpec *Evaluation_EvaluationSpec_QuerySetSpec `protobuf:"bytes,1,opt,name=query_set_spec,json=querySetSpec,proto3" json:"query_set_spec,omitempty"`
	// contains filtered or unexported fields
}

Describes the specification of the evaluation.

func (*Evaluation_EvaluationSpec) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use Evaluation_EvaluationSpec.ProtoReflect.Descriptor instead.

func (*Evaluation_EvaluationSpec) GetQuerySetSpec added in v1.10.0 

func (x *Evaluation_EvaluationSpec) GetQuerySetSpec() *Evaluation_EvaluationSpec_QuerySetSpec

func (*Evaluation_EvaluationSpec) GetSearchRequest added in v1.10.0 

func (x *Evaluation_EvaluationSpec) GetSearchRequest() *SearchRequest

func (*Evaluation_EvaluationSpec) GetSearchSpec added in v1.10.0 

func (m *Evaluation_EvaluationSpec) GetSearchSpec() isEvaluation_EvaluationSpec_SearchSpec

func (*Evaluation_EvaluationSpec) ProtoMessage added in v1.10.0 

func (*Evaluation_EvaluationSpec) ProtoMessage()

func (*Evaluation_EvaluationSpec) ProtoReflect added in v1.10.0 

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

func (*Evaluation_EvaluationSpec) Reset added in v1.10.0 

func (x *Evaluation_EvaluationSpec) Reset()

func (*Evaluation_EvaluationSpec) String added in v1.10.0 

func (x *Evaluation_EvaluationSpec) String() string

type Evaluation_EvaluationSpec_QuerySetSpec added in v1.10.0 

type Evaluation_EvaluationSpec_QuerySetSpec struct {

	// Required. The full resource name of the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
	// used for the evaluation, in the format of
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	SampleQuerySet string `protobuf:"bytes,1,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
	// contains filtered or unexported fields
}

Describes the specification of the query set.

func (*Evaluation_EvaluationSpec_QuerySetSpec) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use Evaluation_EvaluationSpec_QuerySetSpec.ProtoReflect.Descriptor instead.

func (*Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet() string

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage added in v1.10.0 

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage()

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoReflect added in v1.10.0 

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

func (*Evaluation_EvaluationSpec_QuerySetSpec) Reset added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) Reset()

func (*Evaluation_EvaluationSpec_QuerySetSpec) String added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) String() string

type Evaluation_EvaluationSpec_SearchRequest added in v1.10.0 

type Evaluation_EvaluationSpec_SearchRequest struct {
	// Required. The search request that is used to perform the evaluation.
	//
	// Only the following fields within SearchRequest are supported; if any
	// other fields are provided, an UNSUPPORTED error will be returned:
	//
	// * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
	// * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
	// * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
	// * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
	// * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
	// * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
	// * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
	SearchRequest *SearchRequest `protobuf:"bytes,2,opt,name=search_request,json=searchRequest,proto3,oneof"`
}

type Evaluation_State added in v1.10.0 

type Evaluation_State int32

Describes the state of an evaluation. 

const (
	// The evaluation is unspecified.
	Evaluation_STATE_UNSPECIFIED Evaluation_State = 0
	// The service is preparing to run the evaluation.
	Evaluation_PENDING Evaluation_State = 1
	// The evaluation is in progress.
	Evaluation_RUNNING Evaluation_State = 2
	// The evaluation completed successfully.
	Evaluation_SUCCEEDED Evaluation_State = 3
	// The evaluation failed.
	Evaluation_FAILED Evaluation_State = 4
)

func (Evaluation_State) Descriptor added in v1.10.0 

func (Evaluation_State) Descriptor() protoreflect.EnumDescriptor

func (Evaluation_State) Enum added in v1.10.0 

func (x Evaluation_State) Enum() *Evaluation_State

func (Evaluation_State) EnumDescriptor deprecated added in v1.10.0 

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

Deprecated: Use Evaluation_State.Descriptor instead.

func (Evaluation_State) Number added in v1.10.0 

func (x Evaluation_State) Number() protoreflect.EnumNumber

func (Evaluation_State) String added in v1.10.0 

func (x Evaluation_State) String() string

func (Evaluation_State) Type added in v1.10.0 

func (Evaluation_State) Type() protoreflect.EnumType

type FactChunk added in v1.7.0 

type FactChunk struct {

	// Text content of the fact chunk. Can be at most 10K characters long.
	ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
	// Source from which this fact chunk was retrieved. If it was retrieved
	// from the GroundingFacts provided in the request then this field will
	// contain the index of the specific fact from which this chunk was
	// retrieved.
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The index of this chunk. Currently, only used for the streaming mode.
	Index int32 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
	// More fine-grained information for the source reference.
	SourceMetadata map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

Fact Chunk.

func (*FactChunk) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.

func (*FactChunk) GetChunkText added in v1.7.0 

func (x *FactChunk) GetChunkText() string

func (*FactChunk) GetIndex added in v1.8.0 

func (x *FactChunk) GetIndex() int32

func (*FactChunk) GetSource added in v1.7.0 

func (x *FactChunk) GetSource() string

func (*FactChunk) GetSourceMetadata added in v1.7.0 

func (x *FactChunk) GetSourceMetadata() map[string]string

func (*FactChunk) ProtoMessage added in v1.7.0 

func (*FactChunk) ProtoMessage()

func (*FactChunk) ProtoReflect added in v1.7.0 

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

func (*FactChunk) Reset added in v1.7.0 

func (x *FactChunk) Reset()

func (*FactChunk) String added in v1.7.0 

func (x *FactChunk) String() string

type FetchDomainVerificationStatusRequest added in v1.5.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.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] method.

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

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

Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusRequest) GetPageSize added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetPageSize() int32

func (*FetchDomainVerificationStatusRequest) GetPageToken added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetPageToken() string

func (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() string

func (*FetchDomainVerificationStatusRequest) ProtoMessage added in v1.5.0 

func (*FetchDomainVerificationStatusRequest) ProtoMessage()

func (*FetchDomainVerificationStatusRequest) ProtoReflect added in v1.5.0 

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

func (*FetchDomainVerificationStatusRequest) Reset added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) Reset()

func (*FetchDomainVerificationStatusRequest) String added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) String() string

type FetchDomainVerificationStatusResponse added in v1.5.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.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] method.

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

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

Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusResponse) GetNextPageToken added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() string

func (*FetchDomainVerificationStatusResponse) GetTargetSites added in v1.5.0 

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

func (*FetchDomainVerificationStatusResponse) GetTotalSize added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32

func (*FetchDomainVerificationStatusResponse) ProtoMessage added in v1.5.0 

func (*FetchDomainVerificationStatusResponse) ProtoMessage()

func (*FetchDomainVerificationStatusResponse) ProtoReflect added in v1.5.0 

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

func (*FetchDomainVerificationStatusResponse) Reset added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) Reset()

func (*FetchDomainVerificationStatusResponse) String added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) String() string

type FhirStoreSource added in v1.7.0 

type FhirStoreSource struct {

	// Required. The full resource name of the FHIR store to import data from, in
	// the format of
	// `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
	FhirStore string `protobuf:"bytes,1,opt,name=fhir_store,json=fhirStore,proto3" json:"fhir_store,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
	// FhirStore export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,2,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The FHIR resource types to import. The resource types should be a subset of
	// all [supported FHIR resource
	// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
	// Default to all supported FHIR resource types if empty.
	ResourceTypes []string `protobuf:"bytes,3,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
	// contains filtered or unexported fields
}

Cloud FhirStore source import data from.

func (*FhirStoreSource) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use FhirStoreSource.ProtoReflect.Descriptor instead.

func (*FhirStoreSource) GetFhirStore added in v1.7.0 

func (x *FhirStoreSource) GetFhirStore() string

func (*FhirStoreSource) GetGcsStagingDir added in v1.7.0 

func (x *FhirStoreSource) GetGcsStagingDir() string

func (*FhirStoreSource) GetResourceTypes added in v1.14.0 

func (x *FhirStoreSource) GetResourceTypes() []string

func (*FhirStoreSource) ProtoMessage added in v1.7.0 

func (*FhirStoreSource) ProtoMessage()

func (*FhirStoreSource) ProtoReflect added in v1.7.0 

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

func (*FhirStoreSource) Reset added in v1.7.0 

func (x *FhirStoreSource) Reset()

func (*FhirStoreSource) String added in v1.7.0 

func (x *FhirStoreSource) String() string

type FirestoreSource added in v1.7.0 

type FirestoreSource struct {

	// The project ID that the Cloud SQL 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 Firestore database to copy the data from with a length limit
	// of 256 characters.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The Firestore collection (or entity) to copy the data from with a
	// length limit of 1,500 characters.
	CollectionId string `protobuf:"bytes,3,opt,name=collection_id,json=collectionId,proto3" json:"collection_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
	// Firestore export to a specific Cloud Storage directory.
	//
	// Ensure that the Firestore service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// contains filtered or unexported fields
}

Firestore source import data from.

func (*FirestoreSource) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use FirestoreSource.ProtoReflect.Descriptor instead.

func (*FirestoreSource) GetCollectionId added in v1.7.0 

func (x *FirestoreSource) GetCollectionId() string

func (*FirestoreSource) GetDatabaseId added in v1.7.0 

func (x *FirestoreSource) GetDatabaseId() string

func (*FirestoreSource) GetGcsStagingDir added in v1.7.0 

func (x *FirestoreSource) GetGcsStagingDir() string

func (*FirestoreSource) GetProjectId added in v1.7.0 

func (x *FirestoreSource) GetProjectId() string

func (*FirestoreSource) ProtoMessage added in v1.7.0 

func (*FirestoreSource) ProtoMessage()

func (*FirestoreSource) ProtoReflect added in v1.7.0 

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

func (*FirestoreSource) Reset added in v1.7.0 

func (x *FirestoreSource) Reset()

func (*FirestoreSource) String added in v1.7.0 

func (x *FirestoreSource) String() string

type GcsSource 

type GcsSource struct {

	// Required. Cloud Storage URIs to input files. Each URI can be up to
	// 2000 characters long. URIs can match the full object path (for example,
	// `gs://bucket/directory/object.json`) or a pattern matching one or more
	// files, such as `gs://bucket/directory/*.json`.
	//
	// A request can contain at most 100 files (or 100,000 files if `data_schema`
	// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
	// `content`).
	InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One JSON
	// [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
	// document must
	//
	//	have a valid
	//	[Document.id][google.cloud.discoveryengine.v1beta.Document.id].
	//   - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
	//     `input_uris` 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.v1beta.Schema] of
	//     the data store. This can only be used by the GENERIC Data Store vertical.
	//   - `csv`: A CSV file with header conforming to the defined
	//
	// [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
	//
	//	data store. Each entry after the header is imported as a Document.
	//	This can only be used by the GENERIC Data Store vertical.
	//
	// Supported values for user event imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
	DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

Cloud Storage location for input content.

func (*GcsSource) Descriptor deprecated 

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

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema 

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris 

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

func (*GcsSource) ProtoMessage 

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect 

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

func (*GcsSource) Reset 

func (x *GcsSource) Reset()

func (*GcsSource) String 

func (x *GcsSource) String() string

type GetAnswerRequest added in v1.7.0 

type GetAnswerRequest struct {

	// Required. The resource name of the Answer to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetAnswer method.

func (*GetAnswerRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use GetAnswerRequest.ProtoReflect.Descriptor instead.

func (*GetAnswerRequest) GetName added in v1.7.0 

func (x *GetAnswerRequest) GetName() string

func (*GetAnswerRequest) ProtoMessage added in v1.7.0 

func (*GetAnswerRequest) ProtoMessage()

func (*GetAnswerRequest) ProtoReflect added in v1.7.0 

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

func (*GetAnswerRequest) Reset added in v1.7.0 

func (x *GetAnswerRequest) Reset()

func (*GetAnswerRequest) String added in v1.7.0 

func (x *GetAnswerRequest) String() string

type GetControlRequest added in v1.8.0 

type GetControlRequest struct {

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

Request for GetControl method.

func (*GetControlRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use GetControlRequest.ProtoReflect.Descriptor instead.

func (*GetControlRequest) GetName added in v1.8.0 

func (x *GetControlRequest) GetName() string

func (*GetControlRequest) ProtoMessage added in v1.8.0 

func (*GetControlRequest) ProtoMessage()

func (*GetControlRequest) ProtoReflect added in v1.8.0 

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

func (*GetControlRequest) Reset added in v1.8.0 

func (x *GetControlRequest) Reset()

func (*GetControlRequest) String added in v1.8.0 

func (x *GetControlRequest) String() string

type GetConversationRequest added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.

func (*GetConversationRequest) GetName added in v1.1.0 

func (x *GetConversationRequest) GetName() string

func (*GetConversationRequest) ProtoMessage added in v1.1.0 

func (*GetConversationRequest) ProtoMessage()

func (*GetConversationRequest) ProtoReflect added in v1.1.0 

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

func (*GetConversationRequest) Reset added in v1.1.0 

func (x *GetConversationRequest) Reset()

func (*GetConversationRequest) String added in v1.1.0 

func (x *GetConversationRequest) String() string

type GetDataStoreRequest added in v1.5.0 

type GetDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.DataStoreService.GetDataStore] method.

func (*GetDataStoreRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use GetDataStoreRequest.ProtoReflect.Descriptor instead.

func (*GetDataStoreRequest) GetName added in v1.5.0 

func (x *GetDataStoreRequest) GetName() string

func (*GetDataStoreRequest) ProtoMessage added in v1.5.0 

func (*GetDataStoreRequest) ProtoMessage()

func (*GetDataStoreRequest) ProtoReflect added in v1.5.0 

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

func (*GetDataStoreRequest) Reset added in v1.5.0 

func (x *GetDataStoreRequest) Reset()

func (*GetDataStoreRequest) String added in v1.5.0 

func (x *GetDataStoreRequest) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {

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

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

func (*GetDocumentRequest) Descriptor deprecated 

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

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetName 

func (x *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect 

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

func (*GetDocumentRequest) Reset 

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (x *GetDocumentRequest) String() string

type GetEngineRequest added in v1.5.0 

type GetEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.EngineService.GetEngine] method.

func (*GetEngineRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use GetEngineRequest.ProtoReflect.Descriptor instead.

func (*GetEngineRequest) GetName added in v1.5.0 

func (x *GetEngineRequest) GetName() string

func (*GetEngineRequest) ProtoMessage added in v1.5.0 

func (*GetEngineRequest) ProtoMessage()

func (*GetEngineRequest) ProtoReflect added in v1.5.0 

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

func (*GetEngineRequest) Reset added in v1.5.0 

func (x *GetEngineRequest) Reset()

func (*GetEngineRequest) String added in v1.5.0 

func (x *GetEngineRequest) String() string

type GetEvaluationRequest added in v1.10.0 

type GetEvaluationRequest struct {

	// Required. Full resource name of
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], such as
	// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// If the caller does not have permission to access the
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] 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 [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] method.

func (*GetEvaluationRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use GetEvaluationRequest.ProtoReflect.Descriptor instead.

func (*GetEvaluationRequest) GetName added in v1.10.0 

func (x *GetEvaluationRequest) GetName() string

func (*GetEvaluationRequest) ProtoMessage added in v1.10.0 

func (*GetEvaluationRequest) ProtoMessage()

func (*GetEvaluationRequest) ProtoReflect added in v1.10.0 

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

func (*GetEvaluationRequest) Reset added in v1.10.0 

func (x *GetEvaluationRequest) Reset()

func (*GetEvaluationRequest) String added in v1.10.0 

func (x *GetEvaluationRequest) String() string

type GetSampleQueryRequest added in v1.10.0 

type GetSampleQueryRequest struct {

	// Required. Full resource name of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
	//
	// If the caller does not have permission to access the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] 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 [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] method.

func (*GetSampleQueryRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use GetSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*GetSampleQueryRequest) GetName added in v1.10.0 

func (x *GetSampleQueryRequest) GetName() string

func (*GetSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*GetSampleQueryRequest) ProtoMessage()

func (*GetSampleQueryRequest) ProtoReflect added in v1.10.0 

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

func (*GetSampleQueryRequest) Reset added in v1.10.0 

func (x *GetSampleQueryRequest) Reset()

func (*GetSampleQueryRequest) String added in v1.10.0 

func (x *GetSampleQueryRequest) String() string

type GetSampleQuerySetRequest added in v1.10.0 

type GetSampleQuerySetRequest struct {

	// Required. Full resource name of
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such
	// as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
	//
	// If the caller does not have permission to access the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
	// regardless of whether or not it exists, a PERMISSION_DENIED error is
	// returned.
	//
	// If the requested
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] 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 [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] method.

func (*GetSampleQuerySetRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use GetSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*GetSampleQuerySetRequest) GetName added in v1.10.0 

func (x *GetSampleQuerySetRequest) GetName() string

func (*GetSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*GetSampleQuerySetRequest) ProtoMessage()

func (*GetSampleQuerySetRequest) ProtoReflect added in v1.10.0 

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

func (*GetSampleQuerySetRequest) Reset added in v1.10.0 

func (x *GetSampleQuerySetRequest) Reset()

func (*GetSampleQuerySetRequest) String added in v1.10.0 

func (x *GetSampleQuerySetRequest) String() string

type GetSchemaRequest added in v0.3.0 

type GetSchemaRequest struct {

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

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

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

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

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName added in v0.3.0 

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) ProtoMessage added in v0.3.0 

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect added in v0.3.0 

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

func (*GetSchemaRequest) Reset added in v0.3.0 

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String added in v0.3.0 

func (x *GetSchemaRequest) String() string

type GetServingConfigRequest added in v1.5.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.5.0 

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

Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetServingConfigRequest) GetName added in v1.5.0 

func (x *GetServingConfigRequest) GetName() string

func (*GetServingConfigRequest) ProtoMessage added in v1.5.0 

func (*GetServingConfigRequest) ProtoMessage()

func (*GetServingConfigRequest) ProtoReflect added in v1.5.0 

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

func (*GetServingConfigRequest) Reset added in v1.5.0 

func (x *GetServingConfigRequest) Reset()

func (*GetServingConfigRequest) String added in v1.5.0 

func (x *GetServingConfigRequest) String() string

type GetSessionRequest added in v1.7.0 

type GetSessionRequest struct {

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

Request for GetSession method.

func (*GetSessionRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.

func (*GetSessionRequest) GetName added in v1.7.0 

func (x *GetSessionRequest) GetName() string

func (*GetSessionRequest) ProtoMessage added in v1.7.0 

func (*GetSessionRequest) ProtoMessage()

func (*GetSessionRequest) ProtoReflect added in v1.7.0 

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

func (*GetSessionRequest) Reset added in v1.7.0 

func (x *GetSessionRequest) Reset()

func (*GetSessionRequest) String added in v1.7.0 

func (x *GetSessionRequest) String() string

type GetSiteSearchEngineRequest added in v1.5.0 

type GetSiteSearchEngineRequest struct {

	// Required. Resource name of
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.GetSiteSearchEngine] method.

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

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

Deprecated: Use GetSiteSearchEngineRequest.ProtoReflect.Descriptor instead.

func (*GetSiteSearchEngineRequest) GetName added in v1.5.0 

func (x *GetSiteSearchEngineRequest) GetName() string

func (*GetSiteSearchEngineRequest) ProtoMessage added in v1.5.0 

func (*GetSiteSearchEngineRequest) ProtoMessage()

func (*GetSiteSearchEngineRequest) ProtoReflect added in v1.5.0 

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

func (*GetSiteSearchEngineRequest) Reset added in v1.5.0 

func (x *GetSiteSearchEngineRequest) Reset()

func (*GetSiteSearchEngineRequest) String added in v1.5.0 

func (x *GetSiteSearchEngineRequest) String() string

type GetTargetSiteRequest added in v1.5.0 

type GetTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.GetTargetSite] method.

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

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

Deprecated: Use GetTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*GetTargetSiteRequest) GetName added in v1.5.0 

func (x *GetTargetSiteRequest) GetName() string

func (*GetTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*GetTargetSiteRequest) ProtoMessage()

func (*GetTargetSiteRequest) ProtoReflect added in v1.5.0 

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

func (*GetTargetSiteRequest) Reset added in v1.5.0 

func (x *GetTargetSiteRequest) Reset()

func (*GetTargetSiteRequest) String added in v1.5.0 

func (x *GetTargetSiteRequest) String() string

type GroundedGenerationServiceClient added in v1.7.0 

type GroundedGenerationServiceClient interface {
	// Performs a grounding check.
	CheckGrounding(ctx context.Context, in *CheckGroundingRequest, opts ...grpc.CallOption) (*CheckGroundingResponse, error)
}

GroundedGenerationServiceClient is the client API for GroundedGenerationService service.

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

func NewGroundedGenerationServiceClient added in v1.7.0 

func NewGroundedGenerationServiceClient(cc grpc.ClientConnInterface) GroundedGenerationServiceClient

type GroundedGenerationServiceServer added in v1.7.0 

type GroundedGenerationServiceServer interface {
	// Performs a grounding check.
	CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
}

GroundedGenerationServiceServer is the server API for GroundedGenerationService service.

type GroundingFact added in v1.7.0 

type GroundingFact struct {

	// Text content of the fact. Can be at most 10K characters long.
	FactText string `protobuf:"bytes,1,opt,name=fact_text,json=factText,proto3" json:"fact_text,omitempty"`
	// Attributes associated with the fact.
	// Common attributes include `source` (indicating where the fact was sourced
	// from), `author` (indicating the author of the fact), and so on.
	Attributes map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Grounding Fact.

func (*GroundingFact) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use GroundingFact.ProtoReflect.Descriptor instead.

func (*GroundingFact) GetAttributes added in v1.7.0 

func (x *GroundingFact) GetAttributes() map[string]string

func (*GroundingFact) GetFactText added in v1.7.0 

func (x *GroundingFact) GetFactText() string

func (*GroundingFact) ProtoMessage added in v1.7.0 

func (*GroundingFact) ProtoMessage()

func (*GroundingFact) ProtoReflect added in v1.7.0 

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

func (*GroundingFact) Reset added in v1.7.0 

func (x *GroundingFact) Reset()

func (*GroundingFact) String added in v1.7.0 

func (x *GroundingFact) String() string

type ImportCompletionSuggestionsMetadata added in v1.11.0 

type ImportCompletionSuggestionsMetadata 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
	// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
	// successfully imported.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of
	// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
	// that failed to be imported.
	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 ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportCompletionSuggestionsMetadata) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ImportCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsMetadata) GetCreateTime added in v1.11.0 

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

func (*ImportCompletionSuggestionsMetadata) GetFailureCount added in v1.11.0 

func (x *ImportCompletionSuggestionsMetadata) GetFailureCount() int64

func (*ImportCompletionSuggestionsMetadata) GetSuccessCount added in v1.11.0 

func (x *ImportCompletionSuggestionsMetadata) GetSuccessCount() int64

func (*ImportCompletionSuggestionsMetadata) GetUpdateTime added in v1.11.0 

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

func (*ImportCompletionSuggestionsMetadata) ProtoMessage added in v1.11.0 

func (*ImportCompletionSuggestionsMetadata) ProtoMessage()

func (*ImportCompletionSuggestionsMetadata) ProtoReflect added in v1.11.0 

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

func (*ImportCompletionSuggestionsMetadata) Reset added in v1.11.0 

func (x *ImportCompletionSuggestionsMetadata) Reset()

func (*ImportCompletionSuggestionsMetadata) String added in v1.11.0 

func (x *ImportCompletionSuggestionsMetadata) String() string

type ImportCompletionSuggestionsRequest added in v1.11.0 

type ImportCompletionSuggestionsRequest struct {

	// The source of the autocomplete suggestions.
	//
	// Types that are assignable to Source:
	//
	//	*ImportCompletionSuggestionsRequest_InlineSource_
	//	*ImportCompletionSuggestionsRequest_GcsSource
	//	*ImportCompletionSuggestionsRequest_BigquerySource
	Source isImportCompletionSuggestionsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent data store resource name for which to import customer
	// autocomplete suggestions.
	//
	// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
	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"`
	// contains filtered or unexported fields
}

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

func (*ImportCompletionSuggestionsRequest) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ImportCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest) GetBigquerySource added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) GetBigquerySource() *BigQuerySource

func (*ImportCompletionSuggestionsRequest) GetErrorConfig added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportCompletionSuggestionsRequest) GetGcsSource added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) GetGcsSource() *GcsSource

func (*ImportCompletionSuggestionsRequest) GetInlineSource added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) GetInlineSource() *ImportCompletionSuggestionsRequest_InlineSource

func (*ImportCompletionSuggestionsRequest) GetParent added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) GetParent() string

func (*ImportCompletionSuggestionsRequest) GetSource added in v1.11.0 

func (m *ImportCompletionSuggestionsRequest) GetSource() isImportCompletionSuggestionsRequest_Source

func (*ImportCompletionSuggestionsRequest) ProtoMessage added in v1.11.0 

func (*ImportCompletionSuggestionsRequest) ProtoMessage()

func (*ImportCompletionSuggestionsRequest) ProtoReflect added in v1.11.0 

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

func (*ImportCompletionSuggestionsRequest) Reset added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) Reset()

func (*ImportCompletionSuggestionsRequest) String added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest) String() string

type ImportCompletionSuggestionsRequest_BigquerySource added in v1.11.0 

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

type ImportCompletionSuggestionsRequest_GcsSource added in v1.11.0 

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

type ImportCompletionSuggestionsRequest_InlineSource added in v1.11.0 

type ImportCompletionSuggestionsRequest_InlineSource struct {

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

The inline source for CompletionSuggestions.

func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ImportCompletionSuggestionsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions() []*CompletionSuggestion

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage added in v1.11.0 

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage()

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect added in v1.11.0 

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

func (*ImportCompletionSuggestionsRequest_InlineSource) Reset added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) Reset()

func (*ImportCompletionSuggestionsRequest_InlineSource) String added in v1.11.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) String() string

type ImportCompletionSuggestionsRequest_InlineSource_ added in v1.11.0 

type ImportCompletionSuggestionsRequest_InlineSource_ struct {
	// The Inline source for suggestion entries.
	InlineSource *ImportCompletionSuggestionsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportCompletionSuggestionsResponse added in v1.11.0 

type ImportCompletionSuggestionsResponse 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"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ImportCompletionSuggestionsResponse) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ImportCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsResponse) GetErrorConfig added in v1.11.0 

func (x *ImportCompletionSuggestionsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportCompletionSuggestionsResponse) GetErrorSamples added in v1.11.0 

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

func (*ImportCompletionSuggestionsResponse) ProtoMessage added in v1.11.0 

func (*ImportCompletionSuggestionsResponse) ProtoMessage()

func (*ImportCompletionSuggestionsResponse) ProtoReflect added in v1.11.0 

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

func (*ImportCompletionSuggestionsResponse) Reset added in v1.11.0 

func (x *ImportCompletionSuggestionsResponse) Reset()

func (*ImportCompletionSuggestionsResponse) String added in v1.11.0 

func (x *ImportCompletionSuggestionsResponse) String() string

type ImportDocumentsMetadata 

type ImportDocumentsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Total count of entries that were processed.
	TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_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) GetTotalCount added in v1.7.0 

func (x *ImportDocumentsMetadata) GetTotalCount() 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
	//	*ImportDocumentsRequest_FhirStoreSource
	//	*ImportDocumentsRequest_SpannerSource
	//	*ImportDocumentsRequest_CloudSqlSource
	//	*ImportDocumentsRequest_FirestoreSource
	//	*ImportDocumentsRequest_AlloyDbSource
	//	*ImportDocumentsRequest_BigtableSource
	Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Requires create/update permission.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// The mode of reconciliation between existing documents and the documents to
	// be imported. Defaults to
	// [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
	ReconciliationMode ImportDocumentsRequest_ReconciliationMode `` /* 199-byte string literal not displayed */
	// Indicates which fields in the provided imported documents to update. If
	// not set, the default is to update all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Whether to automatically generate IDs for the documents if absent.
	//
	// If set to `true`,
	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s are
	// automatically generated based on the hash of the payload, where IDs may not
	// be consistent during multiple imports. In which case
	// [ReconciliationMode.FULL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL]
	// is highly recommended to avoid duplicate contents. If unset or set to
	// `false`, [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s
	// have to be specified using
	// [id_field][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field],
	// otherwise, documents without IDs fail to be imported.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource].
	AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
	// The field indicates the ID field or column to be used as unique IDs of
	// the documents.
	//
	// For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the
	// key of the JSON field. For instance, `my_id` for JSON `{"my_id":
	// "some_uuid"}`. For others, it may be the column name of the table where the
	// unique ids are stored.
	//
	// The values of the JSON field or the table column are used as the
	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON
	// field or the table 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
	// [auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids]
	// is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
	//
	// If it is unset, a default value `_id` is used when importing from the
	// allowed data sources.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource].
	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) GetAlloyDbSource added in v1.11.0 

func (x *ImportDocumentsRequest) GetAlloyDbSource() *AlloyDbSource

func (*ImportDocumentsRequest) GetAutoGenerateIds added in v0.4.0 

func (x *ImportDocumentsRequest) GetAutoGenerateIds() bool

func (*ImportDocumentsRequest) GetBigquerySource 

func (x *ImportDocumentsRequest) GetBigquerySource() *BigQuerySource

func (*ImportDocumentsRequest) GetBigtableSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetBigtableSource() *BigtableSource

func (*ImportDocumentsRequest) GetCloudSqlSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetCloudSqlSource() *CloudSqlSource

func (*ImportDocumentsRequest) GetErrorConfig 

func (x *ImportDocumentsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsRequest) GetFhirStoreSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetFhirStoreSource() *FhirStoreSource

func (*ImportDocumentsRequest) GetFirestoreSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetFirestoreSource() *FirestoreSource

func (*ImportDocumentsRequest) GetGcsSource 

func (x *ImportDocumentsRequest) GetGcsSource() *GcsSource

func (*ImportDocumentsRequest) GetIdField added in v0.4.0 

func (x *ImportDocumentsRequest) GetIdField() string

func (*ImportDocumentsRequest) GetInlineSource 

func (x *ImportDocumentsRequest) GetInlineSource() *ImportDocumentsRequest_InlineSource

func (*ImportDocumentsRequest) GetParent 

func (x *ImportDocumentsRequest) GetParent() string

func (*ImportDocumentsRequest) GetReconciliationMode 

func (x *ImportDocumentsRequest) GetReconciliationMode() ImportDocumentsRequest_ReconciliationMode

func (*ImportDocumentsRequest) GetSource 

func (m *ImportDocumentsRequest) GetSource() isImportDocumentsRequest_Source

func (*ImportDocumentsRequest) GetSpannerSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetSpannerSource() *SpannerSource

func (*ImportDocumentsRequest) GetUpdateMask added in v1.7.0 

func (x *ImportDocumentsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

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_AlloyDbSource added in v1.11.0 

type ImportDocumentsRequest_AlloyDbSource struct {
	// AlloyDB input source.
	AlloyDbSource *AlloyDbSource `protobuf:"bytes,14,opt,name=alloy_db_source,json=alloyDbSource,proto3,oneof"`
}

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_BigtableSource added in v1.7.0 

type ImportDocumentsRequest_BigtableSource struct {
	// Cloud Bigtable input source.
	BigtableSource *BigtableSource `protobuf:"bytes,15,opt,name=bigtable_source,json=bigtableSource,proto3,oneof"`
}

type ImportDocumentsRequest_CloudSqlSource added in v1.7.0 

type ImportDocumentsRequest_CloudSqlSource struct {
	// Cloud SQL input source.
	CloudSqlSource *CloudSqlSource `protobuf:"bytes,12,opt,name=cloud_sql_source,json=cloudSqlSource,proto3,oneof"`
}

type ImportDocumentsRequest_FhirStoreSource added in v1.7.0 

type ImportDocumentsRequest_FhirStoreSource struct {
	// FhirStore input source.
	FhirStoreSource *FhirStoreSource `protobuf:"bytes,10,opt,name=fhir_store_source,json=fhirStoreSource,proto3,oneof"`
}

type ImportDocumentsRequest_FirestoreSource added in v1.7.0 

type ImportDocumentsRequest_FirestoreSource struct {
	// Firestore input source.
	FirestoreSource *FirestoreSource `protobuf:"bytes,13,opt,name=firestore_source,json=firestoreSource,proto3,oneof"`
}

type ImportDocumentsRequest_GcsSource 

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

type ImportDocumentsRequest_InlineSource 

type ImportDocumentsRequest_InlineSource struct {

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

The inline source for the input config for ImportDocuments method.

func (*ImportDocumentsRequest_InlineSource) Descriptor deprecated 

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

Deprecated: Use ImportDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest_InlineSource) GetDocuments 

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

func (*ImportDocumentsRequest_InlineSource) ProtoMessage 

func (*ImportDocumentsRequest_InlineSource) ProtoMessage()

func (*ImportDocumentsRequest_InlineSource) ProtoReflect 

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

func (*ImportDocumentsRequest_InlineSource) Reset 

func (x *ImportDocumentsRequest_InlineSource) Reset()

func (*ImportDocumentsRequest_InlineSource) String 

func (x *ImportDocumentsRequest_InlineSource) String() string

type ImportDocumentsRequest_InlineSource_ 

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

type ImportDocumentsRequest_ReconciliationMode 

type ImportDocumentsRequest_ReconciliationMode int32

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

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

func (ImportDocumentsRequest_ReconciliationMode) Descriptor 

func (ImportDocumentsRequest_ReconciliationMode) Descriptor() protoreflect.EnumDescriptor

func (ImportDocumentsRequest_ReconciliationMode) Enum 

func (x ImportDocumentsRequest_ReconciliationMode) Enum() *ImportDocumentsRequest_ReconciliationMode

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor deprecated 

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

Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.

func (ImportDocumentsRequest_ReconciliationMode) Number 

func (x ImportDocumentsRequest_ReconciliationMode) Number() protoreflect.EnumNumber

func (ImportDocumentsRequest_ReconciliationMode) String 

func (x ImportDocumentsRequest_ReconciliationMode) String() string

func (ImportDocumentsRequest_ReconciliationMode) Type 

func (ImportDocumentsRequest_ReconciliationMode) Type() protoreflect.EnumType

type ImportDocumentsRequest_SpannerSource added in v1.7.0 

type ImportDocumentsRequest_SpannerSource struct {
	// Spanner input source.
	SpannerSource *SpannerSource `protobuf:"bytes,11,opt,name=spanner_source,json=spannerSource,proto3,oneof"`
}

type ImportDocumentsResponse 

type ImportDocumentsResponse struct {

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

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

func (*ImportDocumentsResponse) Descriptor deprecated 

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

Deprecated: Use ImportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ImportDocumentsResponse) GetErrorConfig 

func (x *ImportDocumentsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsResponse) GetErrorSamples 

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

func (*ImportDocumentsResponse) ProtoMessage 

func (*ImportDocumentsResponse) ProtoMessage()

func (*ImportDocumentsResponse) ProtoReflect 

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

func (*ImportDocumentsResponse) Reset 

func (x *ImportDocumentsResponse) Reset()

func (*ImportDocumentsResponse) String 

func (x *ImportDocumentsResponse) String() string

type ImportErrorConfig 

type ImportErrorConfig struct {

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

Configuration of destination for Import related errors.

func (*ImportErrorConfig) Descriptor deprecated 

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

Deprecated: Use ImportErrorConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorConfig) GetDestination 

func (m *ImportErrorConfig) GetDestination() isImportErrorConfig_Destination

func (*ImportErrorConfig) GetGcsPrefix 

func (x *ImportErrorConfig) GetGcsPrefix() string

func (*ImportErrorConfig) ProtoMessage 

func (*ImportErrorConfig) ProtoMessage()

func (*ImportErrorConfig) ProtoReflect 

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

func (*ImportErrorConfig) Reset 

func (x *ImportErrorConfig) Reset()

func (*ImportErrorConfig) String 

func (x *ImportErrorConfig) String() string

type ImportErrorConfig_GcsPrefix 

type ImportErrorConfig_GcsPrefix struct {
	// Cloud Storage prefix for import errors. This must be an empty,
	// existing Cloud Storage directory. Import errors 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 ImportSampleQueriesMetadata added in v1.10.0 

type ImportSampleQueriesMetadata struct {

	// ImportSampleQueries operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// ImportSampleQueries 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 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s
	// successfully imported.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s
	// that failed to be imported.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Total count of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s that were
	// processed.
	TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ImportSampleQueriesMetadata) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ImportSampleQueriesMetadata.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesMetadata) GetCreateTime added in v1.10.0 

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

func (*ImportSampleQueriesMetadata) GetFailureCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetFailureCount() int64

func (*ImportSampleQueriesMetadata) GetSuccessCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetSuccessCount() int64

func (*ImportSampleQueriesMetadata) GetTotalCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetTotalCount() int64

func (*ImportSampleQueriesMetadata) GetUpdateTime added in v1.10.0 

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

func (*ImportSampleQueriesMetadata) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesMetadata) ProtoMessage()

func (*ImportSampleQueriesMetadata) ProtoReflect added in v1.10.0 

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

func (*ImportSampleQueriesMetadata) Reset added in v1.10.0 

func (x *ImportSampleQueriesMetadata) Reset()

func (*ImportSampleQueriesMetadata) String added in v1.10.0 

func (x *ImportSampleQueriesMetadata) String() string

type ImportSampleQueriesRequest added in v1.10.0 

type ImportSampleQueriesRequest struct {

	// The source of the sample queries.
	//
	// Types that are assignable to Source:
	//
	//	*ImportSampleQueriesRequest_InlineSource_
	//	*ImportSampleQueriesRequest_GcsSource
	//	*ImportSampleQueriesRequest_BigquerySource
	Source isImportSampleQueriesRequest_Source `protobuf_oneof:"source"`
	// Required. The parent sample query set resource name, such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	//
	// If the caller does not have permission to list
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s under this
	// sample query set, regardless of whether or not this sample query set
	// exists, a `PERMISSION_DENIED` error is returned.
	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"`
	// contains filtered or unexported fields
}

Request message for [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] method.

func (*ImportSampleQueriesRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ImportSampleQueriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesRequest) GetBigquerySource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetBigquerySource() *BigQuerySource

func (*ImportSampleQueriesRequest) GetErrorConfig added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportSampleQueriesRequest) GetGcsSource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetGcsSource() *GcsSource

func (*ImportSampleQueriesRequest) GetInlineSource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetInlineSource() *ImportSampleQueriesRequest_InlineSource

func (*ImportSampleQueriesRequest) GetParent added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetParent() string

func (*ImportSampleQueriesRequest) GetSource added in v1.10.0 

func (m *ImportSampleQueriesRequest) GetSource() isImportSampleQueriesRequest_Source

func (*ImportSampleQueriesRequest) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesRequest) ProtoMessage()

func (*ImportSampleQueriesRequest) ProtoReflect added in v1.10.0 

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

func (*ImportSampleQueriesRequest) Reset added in v1.10.0 

func (x *ImportSampleQueriesRequest) Reset()

func (*ImportSampleQueriesRequest) String added in v1.10.0 

func (x *ImportSampleQueriesRequest) String() string

type ImportSampleQueriesRequest_BigquerySource added in v1.10.0 

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

type ImportSampleQueriesRequest_GcsSource added in v1.10.0 

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

type ImportSampleQueriesRequest_InlineSource added in v1.10.0 

type ImportSampleQueriesRequest_InlineSource struct {

	// Required. A list of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to
	// import. Max of 1000 items.
	SampleQueries []*SampleQuery `protobuf:"bytes,1,rep,name=sample_queries,json=sampleQueries,proto3" json:"sample_queries,omitempty"`
	// contains filtered or unexported fields
}

The inline source for SampleQuery[google.cloud.discoveryengine.v1beta.SampleQuery]s.

func (*ImportSampleQueriesRequest_InlineSource) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ImportSampleQueriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesRequest_InlineSource) GetSampleQueries added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) GetSampleQueries() []*SampleQuery

func (*ImportSampleQueriesRequest_InlineSource) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesRequest_InlineSource) ProtoMessage()

func (*ImportSampleQueriesRequest_InlineSource) ProtoReflect added in v1.10.0 

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

func (*ImportSampleQueriesRequest_InlineSource) Reset added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) Reset()

func (*ImportSampleQueriesRequest_InlineSource) String added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) String() string

type ImportSampleQueriesRequest_InlineSource_ added in v1.10.0 

type ImportSampleQueriesRequest_InlineSource_ struct {
	// The Inline source for sample query entries.
	InlineSource *ImportSampleQueriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportSampleQueriesResponse added in v1.10.0 

type ImportSampleQueriesResponse 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"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ImportSampleQueriesResponse) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ImportSampleQueriesResponse.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesResponse) GetErrorConfig added in v1.10.0 

func (x *ImportSampleQueriesResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportSampleQueriesResponse) GetErrorSamples added in v1.10.0 

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

func (*ImportSampleQueriesResponse) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesResponse) ProtoMessage()

func (*ImportSampleQueriesResponse) ProtoReflect added in v1.10.0 

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

func (*ImportSampleQueriesResponse) Reset added in v1.10.0 

func (x *ImportSampleQueriesResponse) Reset()

func (*ImportSampleQueriesResponse) String added in v1.10.0 

func (x *ImportSampleQueriesResponse) String() string

type ImportSuggestionDenyListEntriesMetadata added in v1.5.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.5.0 

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

Deprecated: Use ImportSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesMetadata) GetCreateTime added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage added in v1.5.0 

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage()

func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesMetadata) Reset added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesMetadata) Reset()

func (*ImportSuggestionDenyListEntriesMetadata) String added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesMetadata) String() string

type ImportSuggestionDenyListEntriesRequest added in v1.5.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.v1beta.CompletionService.ImportSuggestionDenyListEntries] method.

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

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

Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetGcsSource() *GcsSource

func (*ImportSuggestionDenyListEntriesRequest) GetInlineSource added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetInlineSource() *ImportSuggestionDenyListEntriesRequest_InlineSource

func (*ImportSuggestionDenyListEntriesRequest) GetParent added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetParent() string

func (*ImportSuggestionDenyListEntriesRequest) GetSource added in v1.5.0 

func (m *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Source

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage added in v1.5.0 

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage()

func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesRequest) Reset added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest) Reset()

func (*ImportSuggestionDenyListEntriesRequest) String added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest) String() string

type ImportSuggestionDenyListEntriesRequest_GcsSource added in v1.5.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.5.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.5.0 

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

Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries() []*SuggestionDenyListEntry

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage added in v1.5.0 

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage()

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) Reset()

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) String added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) String() string

type ImportSuggestionDenyListEntriesRequest_InlineSource_ added in v1.5.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.5.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.v1beta.CompletionService.ImportSuggestionDenyListEntries] method.

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

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

Deprecated: Use ImportSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesResponse) GetErrorSamples added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage added in v1.5.0 

func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage()

func (*ImportSuggestionDenyListEntriesResponse) ProtoReflect added in v1.5.0 

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

func (*ImportSuggestionDenyListEntriesResponse) Reset added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesResponse) Reset()

func (*ImportSuggestionDenyListEntriesResponse) String added in v1.5.0 

func (x *ImportSuggestionDenyListEntriesResponse) String() string

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 (x *ImportUserEventsRequest) GetInlineSource() *ImportUserEventsRequest_InlineSource

func (*ImportUserEventsRequest) GetParent 

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) GetSource 

func (m *ImportUserEventsRequest) GetSource() isImportUserEventsRequest_Source

func (*ImportUserEventsRequest) ProtoMessage 

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect 

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

func (*ImportUserEventsRequest) Reset 

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String 

func (x *ImportUserEventsRequest) String() string

type ImportUserEventsRequest_BigquerySource 

type ImportUserEventsRequest_BigquerySource struct {
	// 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 (x *ImportUserEventsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest_InlineSource) Reset 

func (x *ImportUserEventsRequest_InlineSource) Reset()

func (*ImportUserEventsRequest_InlineSource) String 

func (x *ImportUserEventsRequest_InlineSource) String() string

type ImportUserEventsRequest_InlineSource_ 

type ImportUserEventsRequest_InlineSource_ struct {
	// 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 added in v1.5.0 

type IndustryVertical int32

The industry vertical associated with the DataStore[google.cloud.discoveryengine.v1beta.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
	// The healthcare FHIR vertical.
	IndustryVertical_HEALTHCARE_FHIR IndustryVertical = 7
)

func (IndustryVertical) Descriptor added in v1.5.0 

func (IndustryVertical) Descriptor() protoreflect.EnumDescriptor

func (IndustryVertical) Enum added in v1.5.0 

func (x IndustryVertical) Enum() *IndustryVertical

func (IndustryVertical) EnumDescriptor deprecated added in v1.5.0 

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

Deprecated: Use IndustryVertical.Descriptor instead.

func (IndustryVertical) Number added in v1.5.0 

func (x IndustryVertical) Number() protoreflect.EnumNumber

func (IndustryVertical) String added in v1.5.0 

func (x IndustryVertical) String() string

func (IndustryVertical) Type added in v1.5.0 

func (IndustryVertical) Type() protoreflect.EnumType

type Interval added in v0.3.0 

type Interval struct {

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

A floating point interval.

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

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

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum added in v0.3.0 

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum added in v0.3.0 

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax added in v0.3.0 

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum added in v0.3.0 

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin added in v0.3.0 

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum added in v0.3.0 

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage added in v0.3.0 

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect added in v0.3.0 

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

func (*Interval) Reset added in v0.3.0 

func (x *Interval) Reset()

func (*Interval) String added in v0.3.0 

func (x *Interval) String() string

type Interval_ExclusiveMaximum added in v0.3.0 

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

type Interval_ExclusiveMinimum added in v0.3.0 

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

type Interval_Maximum added in v0.3.0 

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

type Interval_Minimum added in v0.3.0 

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

type LanguageInfo added in v1.11.0 

type LanguageInfo struct {

	// The language code for the DataStore.
	LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Output only. This is the normalized form of language_code.
	// E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb`
	// will have normalized_language_code of `en-GB`.
	NormalizedLanguageCode string `` /* 129-byte string literal not displayed */
	// Output only. Language part of normalized_language_code.
	// E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
	Language string `protobuf:"bytes,3,opt,name=language,proto3" json:"language,omitempty"`
	// Output only. Region part of normalized_language_code, if present.
	// E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> “.
	Region string `protobuf:"bytes,4,opt,name=region,proto3" json:"region,omitempty"`
	// contains filtered or unexported fields
}

Language info for DataStore.

func (*LanguageInfo) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use LanguageInfo.ProtoReflect.Descriptor instead.

func (*LanguageInfo) GetLanguage added in v1.11.0 

func (x *LanguageInfo) GetLanguage() string

func (*LanguageInfo) GetLanguageCode added in v1.11.0 

func (x *LanguageInfo) GetLanguageCode() string

func (*LanguageInfo) GetNormalizedLanguageCode added in v1.11.0 

func (x *LanguageInfo) GetNormalizedLanguageCode() string

func (*LanguageInfo) GetRegion added in v1.11.0 

func (x *LanguageInfo) GetRegion() string

func (*LanguageInfo) ProtoMessage added in v1.11.0 

func (*LanguageInfo) ProtoMessage()

func (*LanguageInfo) ProtoReflect added in v1.11.0 

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

func (*LanguageInfo) Reset added in v1.11.0 

func (x *LanguageInfo) Reset()

func (*LanguageInfo) String added in v1.11.0 

func (x *LanguageInfo) String() string

type ListControlsRequest added in v1.8.0 

type ListControlsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
	// or
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. 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"`
	// Optional. A page token, received from a previous `ListControls` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter to apply on the list results. Supported features:
	//
	// * List all the products under the parent branch if
	// [filter][google.cloud.discoveryengine.v1beta.ListControlsRequest.filter] is
	// unset. Currently this field is unsupported.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request for ListControls method.

func (*ListControlsRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ListControlsRequest.ProtoReflect.Descriptor instead.

func (*ListControlsRequest) GetFilter added in v1.8.0 

func (x *ListControlsRequest) GetFilter() string

func (*ListControlsRequest) GetPageSize added in v1.8.0 

func (x *ListControlsRequest) GetPageSize() int32

func (*ListControlsRequest) GetPageToken added in v1.8.0 

func (x *ListControlsRequest) GetPageToken() string

func (*ListControlsRequest) GetParent added in v1.8.0 

func (x *ListControlsRequest) GetParent() string

func (*ListControlsRequest) ProtoMessage added in v1.8.0 

func (*ListControlsRequest) ProtoMessage()

func (*ListControlsRequest) ProtoReflect added in v1.8.0 

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

func (*ListControlsRequest) Reset added in v1.8.0 

func (x *ListControlsRequest) Reset()

func (*ListControlsRequest) String added in v1.8.0 

func (x *ListControlsRequest) String() string

type ListControlsResponse added in v1.8.0 

type ListControlsResponse struct {

	// All the Controls for a given data store.
	Controls []*Control `protobuf:"bytes,1,rep,name=controls,proto3" json:"controls,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 ListControls method.

func (*ListControlsResponse) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ListControlsResponse.ProtoReflect.Descriptor instead.

func (*ListControlsResponse) GetControls added in v1.8.0 

func (x *ListControlsResponse) GetControls() []*Control

func (*ListControlsResponse) GetNextPageToken added in v1.8.0 

func (x *ListControlsResponse) GetNextPageToken() string

func (*ListControlsResponse) ProtoMessage added in v1.8.0 

func (*ListControlsResponse) ProtoMessage()

func (*ListControlsResponse) ProtoReflect added in v1.8.0 

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

func (*ListControlsResponse) Reset added in v1.8.0 

func (x *ListControlsResponse) Reset()

func (*ListControlsResponse) String added in v1.8.0 

func (x *ListControlsResponse) String() string

type ListConversationsRequest added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.

func (*ListConversationsRequest) GetFilter added in v1.1.0 

func (x *ListConversationsRequest) GetFilter() string

func (*ListConversationsRequest) GetOrderBy added in v1.1.0 

func (x *ListConversationsRequest) GetOrderBy() string

func (*ListConversationsRequest) GetPageSize added in v1.1.0 

func (x *ListConversationsRequest) GetPageSize() int32

func (*ListConversationsRequest) GetPageToken added in v1.1.0 

func (x *ListConversationsRequest) GetPageToken() string

func (*ListConversationsRequest) GetParent added in v1.1.0 

func (x *ListConversationsRequest) GetParent() string

func (*ListConversationsRequest) ProtoMessage added in v1.1.0 

func (*ListConversationsRequest) ProtoMessage()

func (*ListConversationsRequest) ProtoReflect added in v1.1.0 

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

func (*ListConversationsRequest) Reset added in v1.1.0 

func (x *ListConversationsRequest) Reset()

func (*ListConversationsRequest) String added in v1.1.0 

func (x *ListConversationsRequest) String() string

type ListConversationsResponse added in v1.1.0 

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 added in v1.1.0 

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

Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.

func (*ListConversationsResponse) GetConversations added in v1.1.0 

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

func (*ListConversationsResponse) GetNextPageToken added in v1.1.0 

func (x *ListConversationsResponse) GetNextPageToken() string

func (*ListConversationsResponse) ProtoMessage added in v1.1.0 

func (*ListConversationsResponse) ProtoMessage()

func (*ListConversationsResponse) ProtoReflect added in v1.1.0 

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

func (*ListConversationsResponse) Reset added in v1.1.0 

func (x *ListConversationsResponse) Reset()

func (*ListConversationsResponse) String added in v1.1.0 

func (x *ListConversationsResponse) String() string

type ListCustomModelsRequest added in v1.8.0 

type ListCustomModelsRequest struct {

	// Required. The resource name of the parent 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 fetch the models
	// from.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ListCustomModelsRequest.ProtoReflect.Descriptor instead.

func (*ListCustomModelsRequest) GetDataStore added in v1.8.0 

func (x *ListCustomModelsRequest) GetDataStore() string

func (*ListCustomModelsRequest) ProtoMessage added in v1.8.0 

func (*ListCustomModelsRequest) ProtoMessage()

func (*ListCustomModelsRequest) ProtoReflect added in v1.8.0 

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

func (*ListCustomModelsRequest) Reset added in v1.8.0 

func (x *ListCustomModelsRequest) Reset()

func (*ListCustomModelsRequest) String added in v1.8.0 

func (x *ListCustomModelsRequest) String() string

type ListCustomModelsResponse added in v1.8.0 

type ListCustomModelsResponse struct {

	// List of custom tuning models.
	Models []*CustomTuningModel `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsResponse) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ListCustomModelsResponse.ProtoReflect.Descriptor instead.

func (*ListCustomModelsResponse) GetModels added in v1.8.0 

func (x *ListCustomModelsResponse) GetModels() []*CustomTuningModel

func (*ListCustomModelsResponse) ProtoMessage added in v1.8.0 

func (*ListCustomModelsResponse) ProtoMessage()

func (*ListCustomModelsResponse) ProtoReflect added in v1.8.0 

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

func (*ListCustomModelsResponse) Reset added in v1.8.0 

func (x *ListCustomModelsResponse) Reset()

func (*ListCustomModelsResponse) String added in v1.8.0 

func (x *ListCustomModelsResponse) String() string

type ListDataStoresRequest added in v1.5.0 

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.v1beta.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.v1beta.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.v1beta.ListDataStoresResponse.next_page_token],
	// received from a previous
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.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.v1beta.DataStoreService.ListDataStores] method.

func (*ListDataStoresRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use ListDataStoresRequest.ProtoReflect.Descriptor instead.

func (*ListDataStoresRequest) GetFilter added in v1.5.0 

func (x *ListDataStoresRequest) GetFilter() string

func (*ListDataStoresRequest) GetPageSize added in v1.5.0 

func (x *ListDataStoresRequest) GetPageSize() int32

func (*ListDataStoresRequest) GetPageToken added in v1.5.0 

func (x *ListDataStoresRequest) GetPageToken() string

func (*ListDataStoresRequest) GetParent added in v1.5.0 

func (x *ListDataStoresRequest) GetParent() string

func (*ListDataStoresRequest) ProtoMessage added in v1.5.0 

func (*ListDataStoresRequest) ProtoMessage()

func (*ListDataStoresRequest) ProtoReflect added in v1.5.0 

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

func (*ListDataStoresRequest) Reset added in v1.5.0 

func (x *ListDataStoresRequest) Reset()

func (*ListDataStoresRequest) String added in v1.5.0 

func (x *ListDataStoresRequest) String() string

type ListDataStoresResponse added in v1.5.0 

type ListDataStoresResponse struct {

	// All the customer's
	// [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.DataStoreService.ListDataStores] method.

func (*ListDataStoresResponse) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use ListDataStoresResponse.ProtoReflect.Descriptor instead.

func (*ListDataStoresResponse) GetDataStores added in v1.5.0 

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

func (*ListDataStoresResponse) GetNextPageToken added in v1.5.0 

func (x *ListDataStoresResponse) GetNextPageToken() string

func (*ListDataStoresResponse) ProtoMessage added in v1.5.0 

func (*ListDataStoresResponse) ProtoMessage()

func (*ListDataStoresResponse) ProtoReflect added in v1.5.0 

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

func (*ListDataStoresResponse) Reset added in v1.5.0 

func (x *ListDataStoresResponse) Reset()

func (*ListDataStoresResponse) String added in v1.5.0 

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.v1beta.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.v1beta.Document]s
	// to return. If unspecified, defaults to 100. The maximum allowed value is
	// 1000. Values above 1000 are set to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
	// received from a previous
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListDocumentsRequest) Descriptor deprecated 

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

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetPageSize 

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken 

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent 

func (x *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect 

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

func (*ListDocumentsRequest) Reset 

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (x *ListDocumentsRequest) String() string

type ListDocumentsResponse 

type ListDocumentsResponse struct {

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

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

func (*ListDocumentsResponse) Descriptor deprecated 

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

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocuments 

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

func (*ListDocumentsResponse) GetNextPageToken 

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect 

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

func (*ListDocumentsResponse) Reset 

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (x *ListDocumentsResponse) String() string

type ListEnginesRequest added in v1.5.0 

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.v1beta.EngineService.ListEngines] method.

func (*ListEnginesRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.

func (*ListEnginesRequest) GetFilter added in v1.5.0 

func (x *ListEnginesRequest) GetFilter() string

func (*ListEnginesRequest) GetPageSize added in v1.5.0 

func (x *ListEnginesRequest) GetPageSize() int32

func (*ListEnginesRequest) GetPageToken added in v1.5.0 

func (x *ListEnginesRequest) GetPageToken() string

func (*ListEnginesRequest) GetParent added in v1.5.0 

func (x *ListEnginesRequest) GetParent() string

func (*ListEnginesRequest) ProtoMessage added in v1.5.0 

func (*ListEnginesRequest) ProtoMessage()

func (*ListEnginesRequest) ProtoReflect added in v1.5.0 

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

func (*ListEnginesRequest) Reset added in v1.5.0 

func (x *ListEnginesRequest) Reset()

func (*ListEnginesRequest) String added in v1.5.0 

func (x *ListEnginesRequest) String() string

type ListEnginesResponse added in v1.5.0 

type ListEnginesResponse struct {

	// All the customer's [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.EngineService.ListEngines] method.

func (*ListEnginesResponse) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.

func (*ListEnginesResponse) GetEngines added in v1.5.0 

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

func (*ListEnginesResponse) GetNextPageToken added in v1.5.0 

func (x *ListEnginesResponse) GetNextPageToken() string

func (*ListEnginesResponse) ProtoMessage added in v1.5.0 

func (*ListEnginesResponse) ProtoMessage()

func (*ListEnginesResponse) ProtoReflect added in v1.5.0 

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

func (*ListEnginesResponse) Reset added in v1.5.0 

func (x *ListEnginesResponse) Reset()

func (*ListEnginesResponse) String added in v1.5.0 

func (x *ListEnginesResponse) String() string

type ListEvaluationResultsRequest added in v1.10.0 

type ListEvaluationResultsRequest struct {

	// Required. The evaluation resource name, such as
	// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// If the caller does not have permission to list [EvaluationResult][]
	// under this evaluation, regardless of whether or not this evaluation
	// set exists, a `PERMISSION_DENIED` error is returned.
	Evaluation string `protobuf:"bytes,1,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
	// Maximum number of [EvaluationResult][] 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
	// [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
	// received from a previous
	// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
	// 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 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] method.

func (*ListEvaluationResultsRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListEvaluationResultsRequest.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsRequest) GetEvaluation added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetEvaluation() string

func (*ListEvaluationResultsRequest) GetPageSize added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetPageSize() int32

func (*ListEvaluationResultsRequest) GetPageToken added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetPageToken() string

func (*ListEvaluationResultsRequest) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsRequest) ProtoMessage()

func (*ListEvaluationResultsRequest) ProtoReflect added in v1.10.0 

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

func (*ListEvaluationResultsRequest) Reset added in v1.10.0 

func (x *ListEvaluationResultsRequest) Reset()

func (*ListEvaluationResultsRequest) String added in v1.10.0 

func (x *ListEvaluationResultsRequest) String() string

type ListEvaluationResultsResponse added in v1.10.0 

type ListEvaluationResultsResponse struct {

	// The
	// [EvaluationResult][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.EvaluationResult]s.
	EvaluationResults []*ListEvaluationResultsResponse_EvaluationResult `protobuf:"bytes,1,rep,name=evaluation_results,json=evaluationResults,proto3" json:"evaluation_results,omitempty"`
	// A token that can be sent as
	// [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest.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 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] method.

func (*ListEvaluationResultsResponse) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListEvaluationResultsResponse.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsResponse) GetEvaluationResults added in v1.10.0 

func (x *ListEvaluationResultsResponse) GetEvaluationResults() []*ListEvaluationResultsResponse_EvaluationResult

func (*ListEvaluationResultsResponse) GetNextPageToken added in v1.10.0 

func (x *ListEvaluationResultsResponse) GetNextPageToken() string

func (*ListEvaluationResultsResponse) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsResponse) ProtoMessage()

func (*ListEvaluationResultsResponse) ProtoReflect added in v1.10.0 

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

func (*ListEvaluationResultsResponse) Reset added in v1.10.0 

func (x *ListEvaluationResultsResponse) Reset()

func (*ListEvaluationResultsResponse) String added in v1.10.0 

func (x *ListEvaluationResultsResponse) String() string

type ListEvaluationResultsResponse_EvaluationResult added in v1.10.0 

type ListEvaluationResultsResponse_EvaluationResult struct {

	// Output only. The
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] that was
	// evaluated.
	SampleQuery *SampleQuery `protobuf:"bytes,1,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
	// Output only. The metrics produced by the evaluation, for a given
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	QualityMetrics *QualityMetrics `protobuf:"bytes,2,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
	// contains filtered or unexported fields
}

Represents the results of an evaluation for a single SampleQuery[google.cloud.discoveryengine.v1beta.SampleQuery].

func (*ListEvaluationResultsResponse_EvaluationResult) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListEvaluationResultsResponse_EvaluationResult.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics() *QualityMetrics

func (*ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery() *SampleQuery

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage()

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoReflect added in v1.10.0 

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

func (*ListEvaluationResultsResponse_EvaluationResult) Reset added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) Reset()

func (*ListEvaluationResultsResponse_EvaluationResult) String added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) String() string

type ListEvaluationsRequest added in v1.10.0 

type ListEvaluationsRequest struct {

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

func (*ListEvaluationsRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListEvaluationsRequest.ProtoReflect.Descriptor instead.

func (*ListEvaluationsRequest) GetPageSize added in v1.10.0 

func (x *ListEvaluationsRequest) GetPageSize() int32

func (*ListEvaluationsRequest) GetPageToken added in v1.10.0 

func (x *ListEvaluationsRequest) GetPageToken() string

func (*ListEvaluationsRequest) GetParent added in v1.10.0 

func (x *ListEvaluationsRequest) GetParent() string

func (*ListEvaluationsRequest) ProtoMessage added in v1.10.0 

func (*ListEvaluationsRequest) ProtoMessage()

func (*ListEvaluationsRequest) ProtoReflect added in v1.10.0 

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

func (*ListEvaluationsRequest) Reset added in v1.10.0 

func (x *ListEvaluationsRequest) Reset()

func (*ListEvaluationsRequest) String added in v1.10.0 

func (x *ListEvaluationsRequest) String() string

type ListEvaluationsResponse added in v1.10.0 

type ListEvaluationsResponse struct {

	// The [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.
	Evaluations []*Evaluation `protobuf:"bytes,1,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
	// A token that can be sent as
	// [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationsRequest.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 [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] method.

func (*ListEvaluationsResponse) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListEvaluationsResponse.ProtoReflect.Descriptor instead.

func (*ListEvaluationsResponse) GetEvaluations added in v1.10.0 

func (x *ListEvaluationsResponse) GetEvaluations() []*Evaluation

func (*ListEvaluationsResponse) GetNextPageToken added in v1.10.0 

func (x *ListEvaluationsResponse) GetNextPageToken() string

func (*ListEvaluationsResponse) ProtoMessage added in v1.10.0 

func (*ListEvaluationsResponse) ProtoMessage()

func (*ListEvaluationsResponse) ProtoReflect added in v1.10.0 

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

func (*ListEvaluationsResponse) Reset added in v1.10.0 

func (x *ListEvaluationsResponse) Reset()

func (*ListEvaluationsResponse) String added in v1.10.0 

func (x *ListEvaluationsResponse) String() string

type ListSampleQueriesRequest added in v1.10.0 

type ListSampleQueriesRequest struct {

	// Required. The parent sample query set resource name, such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	//
	// If the caller does not have permission to list
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s under this
	// sample query set, regardless of whether or not this sample query set
	// exists, a `PERMISSION_DENIED` error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]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
	// [ListSampleQueriesResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListSampleQueriesResponse.next_page_token],
	// received from a previous
	// [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries]
	// 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 [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] method.

func (*ListSampleQueriesRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListSampleQueriesRequest.ProtoReflect.Descriptor instead.

func (*ListSampleQueriesRequest) GetPageSize added in v1.10.0 

func (x *ListSampleQueriesRequest) GetPageSize() int32

func (*ListSampleQueriesRequest) GetPageToken added in v1.10.0 

func (x *ListSampleQueriesRequest) GetPageToken() string

func (*ListSampleQueriesRequest) GetParent added in v1.10.0 

func (x *ListSampleQueriesRequest) GetParent() string

func (*ListSampleQueriesRequest) ProtoMessage added in v1.10.0 

func (*ListSampleQueriesRequest) ProtoMessage()

func (*ListSampleQueriesRequest) ProtoReflect added in v1.10.0 

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

func (*ListSampleQueriesRequest) Reset added in v1.10.0 

func (x *ListSampleQueriesRequest) Reset()

func (*ListSampleQueriesRequest) String added in v1.10.0 

func (x *ListSampleQueriesRequest) String() string

type ListSampleQueriesResponse added in v1.10.0 

type ListSampleQueriesResponse struct {

	// The [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.
	SampleQueries []*SampleQuery `protobuf:"bytes,1,rep,name=sample_queries,json=sampleQueries,proto3" json:"sample_queries,omitempty"`
	// A token that can be sent as
	// [ListSampleQueriesRequest.page_token][google.cloud.discoveryengine.v1beta.ListSampleQueriesRequest.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 [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] method.

func (*ListSampleQueriesResponse) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListSampleQueriesResponse.ProtoReflect.Descriptor instead.

func (*ListSampleQueriesResponse) GetNextPageToken added in v1.10.0 

func (x *ListSampleQueriesResponse) GetNextPageToken() string

func (*ListSampleQueriesResponse) GetSampleQueries added in v1.10.0 

func (x *ListSampleQueriesResponse) GetSampleQueries() []*SampleQuery

func (*ListSampleQueriesResponse) ProtoMessage added in v1.10.0 

func (*ListSampleQueriesResponse) ProtoMessage()

func (*ListSampleQueriesResponse) ProtoReflect added in v1.10.0 

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

func (*ListSampleQueriesResponse) Reset added in v1.10.0 

func (x *ListSampleQueriesResponse) Reset()

func (*ListSampleQueriesResponse) String added in v1.10.0 

func (x *ListSampleQueriesResponse) String() string

type ListSampleQuerySetsRequest added in v1.10.0 

type ListSampleQuerySetsRequest struct {

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

func (*ListSampleQuerySetsRequest) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListSampleQuerySetsRequest.ProtoReflect.Descriptor instead.

func (*ListSampleQuerySetsRequest) GetPageSize added in v1.10.0 

func (x *ListSampleQuerySetsRequest) GetPageSize() int32

func (*ListSampleQuerySetsRequest) GetPageToken added in v1.10.0 

func (x *ListSampleQuerySetsRequest) GetPageToken() string

func (*ListSampleQuerySetsRequest) GetParent added in v1.10.0 

func (x *ListSampleQuerySetsRequest) GetParent() string

func (*ListSampleQuerySetsRequest) ProtoMessage added in v1.10.0 

func (*ListSampleQuerySetsRequest) ProtoMessage()

func (*ListSampleQuerySetsRequest) ProtoReflect added in v1.10.0 

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

func (*ListSampleQuerySetsRequest) Reset added in v1.10.0 

func (x *ListSampleQuerySetsRequest) Reset()

func (*ListSampleQuerySetsRequest) String added in v1.10.0 

func (x *ListSampleQuerySetsRequest) String() string

type ListSampleQuerySetsResponse added in v1.10.0 

type ListSampleQuerySetsResponse struct {

	// The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.
	SampleQuerySets []*SampleQuerySet `protobuf:"bytes,1,rep,name=sample_query_sets,json=sampleQuerySets,proto3" json:"sample_query_sets,omitempty"`
	// A token that can be sent as
	// [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1beta.ListSampleQuerySetsRequest.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 [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] method.

func (*ListSampleQuerySetsResponse) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use ListSampleQuerySetsResponse.ProtoReflect.Descriptor instead.

func (*ListSampleQuerySetsResponse) GetNextPageToken added in v1.10.0 

func (x *ListSampleQuerySetsResponse) GetNextPageToken() string

func (*ListSampleQuerySetsResponse) GetSampleQuerySets added in v1.10.0 

func (x *ListSampleQuerySetsResponse) GetSampleQuerySets() []*SampleQuerySet

func (*ListSampleQuerySetsResponse) ProtoMessage added in v1.10.0 

func (*ListSampleQuerySetsResponse) ProtoMessage()

func (*ListSampleQuerySetsResponse) ProtoReflect added in v1.10.0 

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

func (*ListSampleQuerySetsResponse) Reset added in v1.10.0 

func (x *ListSampleQuerySetsResponse) Reset()

func (*ListSampleQuerySetsResponse) String added in v1.10.0 

func (x *ListSampleQuerySetsResponse) String() string

type ListSchemasRequest added in v0.3.0 

type ListSchemasRequest struct {

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

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

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

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

Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListSchemasRequest) GetPageSize added in v0.3.0 

func (x *ListSchemasRequest) GetPageSize() int32

func (*ListSchemasRequest) GetPageToken added in v0.3.0 

func (x *ListSchemasRequest) GetPageToken() string

func (*ListSchemasRequest) GetParent added in v0.3.0 

func (x *ListSchemasRequest) GetParent() string

func (*ListSchemasRequest) ProtoMessage added in v0.3.0 

func (*ListSchemasRequest) ProtoMessage()

func (*ListSchemasRequest) ProtoReflect added in v0.3.0 

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

func (*ListSchemasRequest) Reset added in v0.3.0 

func (x *ListSchemasRequest) Reset()

func (*ListSchemasRequest) String added in v0.3.0 

func (x *ListSchemasRequest) String() string

type ListSchemasResponse added in v0.3.0 

type ListSchemasResponse struct {

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

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

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

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

Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListSchemasResponse) GetNextPageToken added in v0.3.0 

func (x *ListSchemasResponse) GetNextPageToken() string

func (*ListSchemasResponse) GetSchemas added in v0.3.0 

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

func (*ListSchemasResponse) ProtoMessage added in v0.3.0 

func (*ListSchemasResponse) ProtoMessage()

func (*ListSchemasResponse) ProtoReflect added in v0.3.0 

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

func (*ListSchemasResponse) Reset added in v0.3.0 

func (x *ListSchemasResponse) Reset()

func (*ListSchemasResponse) String added in v0.3.0 

func (x *ListSchemasResponse) String() string

type ListServingConfigsRequest added in v1.5.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.5.0 

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

Deprecated: Use ListServingConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListServingConfigsRequest) GetPageSize added in v1.5.0 

func (x *ListServingConfigsRequest) GetPageSize() int32

func (*ListServingConfigsRequest) GetPageToken added in v1.5.0 

func (x *ListServingConfigsRequest) GetPageToken() string

func (*ListServingConfigsRequest) GetParent added in v1.5.0 

func (x *ListServingConfigsRequest) GetParent() string

func (*ListServingConfigsRequest) ProtoMessage added in v1.5.0 

func (*ListServingConfigsRequest) ProtoMessage()

func (*ListServingConfigsRequest) ProtoReflect added in v1.5.0 

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

func (*ListServingConfigsRequest) Reset added in v1.5.0 

func (x *ListServingConfigsRequest) Reset()

func (*ListServingConfigsRequest) String added in v1.5.0 

func (x *ListServingConfigsRequest) String() string

type ListServingConfigsResponse added in v1.5.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.5.0 

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

Deprecated: Use ListServingConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListServingConfigsResponse) GetNextPageToken added in v1.5.0 

func (x *ListServingConfigsResponse) GetNextPageToken() string

func (*ListServingConfigsResponse) GetServingConfigs added in v1.5.0 

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

func (*ListServingConfigsResponse) ProtoMessage added in v1.5.0 

func (*ListServingConfigsResponse) ProtoMessage()

func (*ListServingConfigsResponse) ProtoReflect added in v1.5.0 

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

func (*ListServingConfigsResponse) Reset added in v1.5.0 

func (x *ListServingConfigsResponse) Reset()

func (*ListServingConfigsResponse) String added in v1.5.0 

func (x *ListServingConfigsResponse) String() string

type ListSessionsRequest added in v1.7.0 

type ListSessionsRequest 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 `ListSessions` 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`
	//   - `session_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 ListSessions method.

func (*ListSessionsRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use ListSessionsRequest.ProtoReflect.Descriptor instead.

func (*ListSessionsRequest) GetFilter added in v1.7.0 

func (x *ListSessionsRequest) GetFilter() string

func (*ListSessionsRequest) GetOrderBy added in v1.7.0 

func (x *ListSessionsRequest) GetOrderBy() string

func (*ListSessionsRequest) GetPageSize added in v1.7.0 

func (x *ListSessionsRequest) GetPageSize() int32

func (*ListSessionsRequest) GetPageToken added in v1.7.0 

func (x *ListSessionsRequest) GetPageToken() string

func (*ListSessionsRequest) GetParent added in v1.7.0 

func (x *ListSessionsRequest) GetParent() string

func (*ListSessionsRequest) ProtoMessage added in v1.7.0 

func (*ListSessionsRequest) ProtoMessage()

func (*ListSessionsRequest) ProtoReflect added in v1.7.0 

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

func (*ListSessionsRequest) Reset added in v1.7.0 

func (x *ListSessionsRequest) Reset()

func (*ListSessionsRequest) String added in v1.7.0 

func (x *ListSessionsRequest) String() string

type ListSessionsResponse added in v1.7.0 

type ListSessionsResponse struct {

	// All the Sessions for a given data store.
	Sessions []*Session `protobuf:"bytes,1,rep,name=sessions,proto3" json:"sessions,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 ListSessions method.

func (*ListSessionsResponse) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use ListSessionsResponse.ProtoReflect.Descriptor instead.

func (*ListSessionsResponse) GetNextPageToken added in v1.7.0 

func (x *ListSessionsResponse) GetNextPageToken() string

func (*ListSessionsResponse) GetSessions added in v1.7.0 

func (x *ListSessionsResponse) GetSessions() []*Session

func (*ListSessionsResponse) ProtoMessage added in v1.7.0 

func (*ListSessionsResponse) ProtoMessage()

func (*ListSessionsResponse) ProtoReflect added in v1.7.0 

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

func (*ListSessionsResponse) Reset added in v1.7.0 

func (x *ListSessionsResponse) Reset()

func (*ListSessionsResponse) String added in v1.7.0 

func (x *ListSessionsResponse) String() string

type ListTargetSitesRequest added in v1.5.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.v1beta.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.v1beta.SiteSearchEngineService.ListTargetSites] method.

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

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

Deprecated: Use ListTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*ListTargetSitesRequest) GetPageSize added in v1.5.0 

func (x *ListTargetSitesRequest) GetPageSize() int32

func (*ListTargetSitesRequest) GetPageToken added in v1.5.0 

func (x *ListTargetSitesRequest) GetPageToken() string

func (*ListTargetSitesRequest) GetParent added in v1.5.0 

func (x *ListTargetSitesRequest) GetParent() string

func (*ListTargetSitesRequest) ProtoMessage added in v1.5.0 

func (*ListTargetSitesRequest) ProtoMessage()

func (*ListTargetSitesRequest) ProtoReflect added in v1.5.0 

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

func (*ListTargetSitesRequest) Reset added in v1.5.0 

func (x *ListTargetSitesRequest) Reset()

func (*ListTargetSitesRequest) String added in v1.5.0 

func (x *ListTargetSitesRequest) String() string

type ListTargetSitesResponse added in v1.5.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.v1beta.SiteSearchEngineService.ListTargetSites] method.

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

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

Deprecated: Use ListTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*ListTargetSitesResponse) GetNextPageToken added in v1.5.0 

func (x *ListTargetSitesResponse) GetNextPageToken() string

func (*ListTargetSitesResponse) GetTargetSites added in v1.5.0 

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

func (*ListTargetSitesResponse) GetTotalSize added in v1.5.0 

func (x *ListTargetSitesResponse) GetTotalSize() int32

func (*ListTargetSitesResponse) ProtoMessage added in v1.5.0 

func (*ListTargetSitesResponse) ProtoMessage()

func (*ListTargetSitesResponse) ProtoReflect added in v1.5.0 

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

func (*ListTargetSitesResponse) Reset added in v1.5.0 

func (x *ListTargetSitesResponse) Reset()

func (*ListTargetSitesResponse) String added in v1.5.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.v1beta.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, replace it with
	// other character(s).
	//
	// Category pages include special pages such as sales or promotions. For
	// instance, a special sale page may have the category hierarchy:
	// `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
	//
	// Required for `view-category-page` events. Other event types should not set
	// this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
	PageCategory string `protobuf:"bytes,2,opt,name=page_category,json=pageCategory,proto3" json:"page_category,omitempty"`
	// Complete URL (window.location.href) of the user's current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically. Maximum length 5,000
	// characters.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// The referrer URL of the current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically. However, some browser
	// privacy restrictions may cause this field to be empty.
	ReferrerUri string `protobuf:"bytes,4,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`
	// contains filtered or unexported fields
}

Detailed page information.

func (*PageInfo) Descriptor deprecated 

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

Deprecated: Use PageInfo.ProtoReflect.Descriptor instead.

func (*PageInfo) GetPageCategory 

func (x *PageInfo) GetPageCategory() string

func (*PageInfo) GetPageviewId 

func (x *PageInfo) GetPageviewId() string

func (*PageInfo) GetReferrerUri 

func (x *PageInfo) GetReferrerUri() string

func (*PageInfo) GetUri 

func (x *PageInfo) GetUri() string

func (*PageInfo) ProtoMessage 

func (*PageInfo) ProtoMessage()

func (*PageInfo) ProtoReflect 

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

func (*PageInfo) Reset 

func (x *PageInfo) Reset()

func (*PageInfo) String 

func (x *PageInfo) String() string

type PanelInfo 

type PanelInfo struct {

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

Detailed panel information associated with a user event.

func (*PanelInfo) Descriptor deprecated 

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

Deprecated: Use PanelInfo.ProtoReflect.Descriptor instead.

func (*PanelInfo) GetDisplayName 

func (x *PanelInfo) GetDisplayName() string

func (*PanelInfo) GetPanelId 

func (x *PanelInfo) GetPanelId() string

func (*PanelInfo) GetPanelPosition 

func (x *PanelInfo) GetPanelPosition() int32

func (*PanelInfo) GetTotalPanels 

func (x *PanelInfo) GetTotalPanels() int32

func (*PanelInfo) ProtoMessage 

func (*PanelInfo) ProtoMessage()

func (*PanelInfo) ProtoReflect 

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

func (*PanelInfo) Reset 

func (x *PanelInfo) Reset()

func (*PanelInfo) String 

func (x *PanelInfo) String() string

type PauseEngineRequest added in v1.7.0 

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 added in v1.7.0 

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

Deprecated: Use PauseEngineRequest.ProtoReflect.Descriptor instead.

func (*PauseEngineRequest) GetName added in v1.7.0 

func (x *PauseEngineRequest) GetName() string

func (*PauseEngineRequest) ProtoMessage added in v1.7.0 

func (*PauseEngineRequest) ProtoMessage()

func (*PauseEngineRequest) ProtoReflect added in v1.7.0 

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

func (*PauseEngineRequest) Reset added in v1.7.0 

func (x *PauseEngineRequest) Reset()

func (*PauseEngineRequest) String added in v1.7.0 

func (x *PauseEngineRequest) String() string

type Project added in v1.8.0 

type Project struct {

	// Output only. Full resource name of the project, for example
	// `projects/{project_number}`.
	// Note that when making requests, project number and project id are both
	// acceptable, but the server will always respond in project number.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The timestamp when this project is created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp when this project is successfully provisioned.
	// Empty value means this project is still provisioning and is not ready for
	// use.
	ProvisionCompletionTime *timestamppb.Timestamp `` /* 132-byte string literal not displayed */
	// Output only. A map of terms of services. The key is the `id` of
	// [ServiceTerms][google.cloud.discoveryengine.v1beta.Project.ServiceTerms].
	ServiceTermsMap map[string]*Project_ServiceTerms `` /* 196-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata and configurations for a Google Cloud project in the service.

func (*Project) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetCreateTime added in v1.8.0 

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

func (*Project) GetName added in v1.8.0 

func (x *Project) GetName() string

func (*Project) GetProvisionCompletionTime added in v1.8.0 

func (x *Project) GetProvisionCompletionTime() *timestamppb.Timestamp

func (*Project) GetServiceTermsMap added in v1.8.0 

func (x *Project) GetServiceTermsMap() map[string]*Project_ServiceTerms

func (*Project) ProtoMessage added in v1.8.0 

func (*Project) ProtoMessage()

func (*Project) ProtoReflect added in v1.8.0 

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

func (*Project) Reset added in v1.8.0 

func (x *Project) Reset()

func (*Project) String added in v1.8.0 

func (x *Project) String() string

type ProjectServiceClient added in v1.8.0 

type ProjectServiceClient interface {
	// Provisions the project resource. During the
	// process, related systems will get prepared and initialized.
	//
	// Caller must read the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms), and optionally
	// specify in request to provide consent to that service terms.
	ProvisionProject(ctx context.Context, in *ProvisionProjectRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ProjectServiceClient is the client API for ProjectService service.

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

func NewProjectServiceClient added in v1.8.0 

func NewProjectServiceClient(cc grpc.ClientConnInterface) ProjectServiceClient

type ProjectServiceServer added in v1.8.0 

type ProjectServiceServer interface {
	// Provisions the project resource. During the
	// process, related systems will get prepared and initialized.
	//
	// Caller must read the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms), and optionally
	// specify in request to provide consent to that service terms.
	ProvisionProject(context.Context, *ProvisionProjectRequest) (*longrunningpb.Operation, error)
}

ProjectServiceServer is the server API for ProjectService service.

type Project_ServiceTerms added in v1.8.0 

type Project_ServiceTerms struct {

	// The unique identifier of this terms of service.
	// Available terms:
	//
	// * `GA_DATA_USE_TERMS`: [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms). When using this as
	// `id`, the acceptable
	// [version][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.version]
	// to provide is `2022-11-23`.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The version string of the terms of service.
	// For acceptable values, see the comments for
	// [id][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.id] above.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Whether the project has accepted/rejected the service terms or it is
	// still pending.
	State Project_ServiceTerms_State `` /* 132-byte string literal not displayed */
	// The last time when the project agreed to the terms of service.
	AcceptTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=accept_time,json=acceptTime,proto3" json:"accept_time,omitempty"`
	// The last time when the project declined or revoked the agreement to terms
	// of service.
	DeclineTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=decline_time,json=declineTime,proto3" json:"decline_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the terms of service.

func (*Project_ServiceTerms) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use Project_ServiceTerms.ProtoReflect.Descriptor instead.

func (*Project_ServiceTerms) GetAcceptTime added in v1.8.0 

func (x *Project_ServiceTerms) GetAcceptTime() *timestamppb.Timestamp

func (*Project_ServiceTerms) GetDeclineTime added in v1.8.0 

func (x *Project_ServiceTerms) GetDeclineTime() *timestamppb.Timestamp

func (*Project_ServiceTerms) GetId added in v1.8.0 

func (x *Project_ServiceTerms) GetId() string

func (*Project_ServiceTerms) GetState added in v1.8.0 

func (x *Project_ServiceTerms) GetState() Project_ServiceTerms_State

func (*Project_ServiceTerms) GetVersion added in v1.8.0 

func (x *Project_ServiceTerms) GetVersion() string

func (*Project_ServiceTerms) ProtoMessage added in v1.8.0 

func (*Project_ServiceTerms) ProtoMessage()

func (*Project_ServiceTerms) ProtoReflect added in v1.8.0 

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

func (*Project_ServiceTerms) Reset added in v1.8.0 

func (x *Project_ServiceTerms) Reset()

func (*Project_ServiceTerms) String added in v1.8.0 

func (x *Project_ServiceTerms) String() string

type Project_ServiceTerms_State added in v1.8.0 

type Project_ServiceTerms_State int32

The agreement states this terms of service. 

const (
	// The default value of the enum. This value is not actually used.
	Project_ServiceTerms_STATE_UNSPECIFIED Project_ServiceTerms_State = 0
	// The project has given consent to the terms of service.
	Project_ServiceTerms_TERMS_ACCEPTED Project_ServiceTerms_State = 1
	// The project is pending to review and accept the terms of service.
	Project_ServiceTerms_TERMS_PENDING Project_ServiceTerms_State = 2
	// The project has declined or revoked the agreement to terms of service.
	Project_ServiceTerms_TERMS_DECLINED Project_ServiceTerms_State = 3
)

func (Project_ServiceTerms_State) Descriptor added in v1.8.0 

func (Project_ServiceTerms_State) Descriptor() protoreflect.EnumDescriptor

func (Project_ServiceTerms_State) Enum added in v1.8.0 

func (x Project_ServiceTerms_State) Enum() *Project_ServiceTerms_State

func (Project_ServiceTerms_State) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use Project_ServiceTerms_State.Descriptor instead.

func (Project_ServiceTerms_State) Number added in v1.8.0 

func (x Project_ServiceTerms_State) Number() protoreflect.EnumNumber

func (Project_ServiceTerms_State) String added in v1.8.0 

func (x Project_ServiceTerms_State) String() string

func (Project_ServiceTerms_State) Type added in v1.8.0 

func (Project_ServiceTerms_State) Type() protoreflect.EnumType

type ProvisionProjectMetadata added in v1.8.0 

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

Metadata associated with a project provision operation.

func (*ProvisionProjectMetadata) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ProvisionProjectMetadata.ProtoReflect.Descriptor instead.

func (*ProvisionProjectMetadata) ProtoMessage added in v1.8.0 

func (*ProvisionProjectMetadata) ProtoMessage()

func (*ProvisionProjectMetadata) ProtoReflect added in v1.8.0 

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

func (*ProvisionProjectMetadata) Reset added in v1.8.0 

func (x *ProvisionProjectMetadata) Reset()

func (*ProvisionProjectMetadata) String added in v1.8.0 

func (x *ProvisionProjectMetadata) String() string

type ProvisionProjectRequest added in v1.8.0 

type ProvisionProjectRequest struct {

	// Required. Full resource name of a
	// [Project][google.cloud.discoveryengine.v1beta.Project], such as
	// `projects/{project_id_or_number}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Set to `true` to specify that caller has read and would like to
	// give consent to the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms).
	AcceptDataUseTerms bool `protobuf:"varint,2,opt,name=accept_data_use_terms,json=acceptDataUseTerms,proto3" json:"accept_data_use_terms,omitempty"`
	// Required. The version of the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms) that caller has read
	// and would like to give consent to.
	//
	// Acceptable version is `2022-11-23`, and this may change over time.
	DataUseTermsVersion string `protobuf:"bytes,3,opt,name=data_use_terms_version,json=dataUseTermsVersion,proto3" json:"data_use_terms_version,omitempty"`
	// contains filtered or unexported fields
}

Request for [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] method.

func (*ProvisionProjectRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use ProvisionProjectRequest.ProtoReflect.Descriptor instead.

func (*ProvisionProjectRequest) GetAcceptDataUseTerms added in v1.8.0 

func (x *ProvisionProjectRequest) GetAcceptDataUseTerms() bool

func (*ProvisionProjectRequest) GetDataUseTermsVersion added in v1.8.0 

func (x *ProvisionProjectRequest) GetDataUseTermsVersion() string

func (*ProvisionProjectRequest) GetName added in v1.8.0 

func (x *ProvisionProjectRequest) GetName() string

func (*ProvisionProjectRequest) ProtoMessage added in v1.8.0 

func (*ProvisionProjectRequest) ProtoMessage()

func (*ProvisionProjectRequest) ProtoReflect added in v1.8.0 

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

func (*ProvisionProjectRequest) Reset added in v1.8.0 

func (x *ProvisionProjectRequest) Reset()

func (*ProvisionProjectRequest) String added in v1.8.0 

func (x *ProvisionProjectRequest) String() string

type PurgeCompletionSuggestionsMetadata added in v1.11.0 

type PurgeCompletionSuggestionsMetadata 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 PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

func (*PurgeCompletionSuggestionsMetadata) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use PurgeCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsMetadata) GetCreateTime added in v1.11.0 

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

func (*PurgeCompletionSuggestionsMetadata) GetUpdateTime added in v1.11.0 

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

func (*PurgeCompletionSuggestionsMetadata) ProtoMessage added in v1.11.0 

func (*PurgeCompletionSuggestionsMetadata) ProtoMessage()

func (*PurgeCompletionSuggestionsMetadata) ProtoReflect added in v1.11.0 

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

func (*PurgeCompletionSuggestionsMetadata) Reset added in v1.11.0 

func (x *PurgeCompletionSuggestionsMetadata) Reset()

func (*PurgeCompletionSuggestionsMetadata) String added in v1.11.0 

func (x *PurgeCompletionSuggestionsMetadata) String() string

type PurgeCompletionSuggestionsRequest added in v1.11.0 

type PurgeCompletionSuggestionsRequest struct {

	// Required. The parent data store resource name for which to purge completion
	// suggestions. 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.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] method.

func (*PurgeCompletionSuggestionsRequest) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use PurgeCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsRequest) GetParent added in v1.11.0 

func (x *PurgeCompletionSuggestionsRequest) GetParent() string

func (*PurgeCompletionSuggestionsRequest) ProtoMessage added in v1.11.0 

func (*PurgeCompletionSuggestionsRequest) ProtoMessage()

func (*PurgeCompletionSuggestionsRequest) ProtoReflect added in v1.11.0 

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

func (*PurgeCompletionSuggestionsRequest) Reset added in v1.11.0 

func (x *PurgeCompletionSuggestionsRequest) Reset()

func (*PurgeCompletionSuggestionsRequest) String added in v1.11.0 

func (x *PurgeCompletionSuggestionsRequest) String() string

type PurgeCompletionSuggestionsResponse added in v1.11.0 

type PurgeCompletionSuggestionsResponse struct {

	// Whether the completion suggestions were successfully purged.
	PurgeSucceeded bool `protobuf:"varint,1,opt,name=purge_succeeded,json=purgeSucceeded,proto3" json:"purge_succeeded,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.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] method.

func (*PurgeCompletionSuggestionsResponse) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use PurgeCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsResponse) GetErrorSamples added in v1.11.0 

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

func (*PurgeCompletionSuggestionsResponse) GetPurgeSucceeded added in v1.11.0 

func (x *PurgeCompletionSuggestionsResponse) GetPurgeSucceeded() bool

func (*PurgeCompletionSuggestionsResponse) ProtoMessage added in v1.11.0 

func (*PurgeCompletionSuggestionsResponse) ProtoMessage()

func (*PurgeCompletionSuggestionsResponse) ProtoReflect added in v1.11.0 

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

func (*PurgeCompletionSuggestionsResponse) Reset added in v1.11.0 

func (x *PurgeCompletionSuggestionsResponse) Reset()

func (*PurgeCompletionSuggestionsResponse) String added in v1.11.0 

func (x *PurgeCompletionSuggestionsResponse) String() string

type PurgeDocumentsMetadata added in v0.3.1 

type PurgeDocumentsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were deleted successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// 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 added in v0.3.1 

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

Deprecated: Use PurgeDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsMetadata) GetCreateTime added in v0.3.1 

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

func (*PurgeDocumentsMetadata) GetFailureCount added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetFailureCount() int64

func (*PurgeDocumentsMetadata) GetIgnoredCount added in v1.6.0 

func (x *PurgeDocumentsMetadata) GetIgnoredCount() int64

func (*PurgeDocumentsMetadata) GetSuccessCount added in v0.3.1 

func (x *PurgeDocumentsMetadata) GetSuccessCount() int64

func (*PurgeDocumentsMetadata) GetUpdateTime added in v0.3.1 

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

func (*PurgeDocumentsMetadata) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsMetadata) ProtoMessage()

func (*PurgeDocumentsMetadata) ProtoReflect added in v0.3.1 

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

func (*PurgeDocumentsMetadata) Reset added in v0.3.1 

func (x *PurgeDocumentsMetadata) Reset()

func (*PurgeDocumentsMetadata) String added in v0.3.1 

func (x *PurgeDocumentsMetadata) String() string

type PurgeDocumentsRequest added in v0.3.1 

type PurgeDocumentsRequest struct {

	// The desired input source for the purging documents based on document IDs.
	//
	// Types that are assignable to Source:
	//
	//	*PurgeDocumentsRequest_GcsSource
	//	*PurgeDocumentsRequest_InlineSource_
	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.v1beta.DocumentService.PurgeDocuments] method.

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

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

Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest) GetErrorConfig added in v1.14.0 

func (x *PurgeDocumentsRequest) GetErrorConfig() *PurgeErrorConfig

func (*PurgeDocumentsRequest) GetFilter added in v0.3.1 

func (x *PurgeDocumentsRequest) GetFilter() string

func (*PurgeDocumentsRequest) GetForce added in v0.3.1 

func (x *PurgeDocumentsRequest) GetForce() bool

func (*PurgeDocumentsRequest) GetGcsSource added in v1.14.0 

func (x *PurgeDocumentsRequest) GetGcsSource() *GcsSource

func (*PurgeDocumentsRequest) GetInlineSource added in v1.14.0 

func (x *PurgeDocumentsRequest) GetInlineSource() *PurgeDocumentsRequest_InlineSource

func (*PurgeDocumentsRequest) GetParent added in v0.3.1 

func (x *PurgeDocumentsRequest) GetParent() string

func (*PurgeDocumentsRequest) GetSource added in v1.14.0 

func (m *PurgeDocumentsRequest) GetSource() isPurgeDocumentsRequest_Source

func (*PurgeDocumentsRequest) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsRequest) ProtoMessage()

func (*PurgeDocumentsRequest) ProtoReflect added in v0.3.1 

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

func (*PurgeDocumentsRequest) Reset added in v0.3.1 

func (x *PurgeDocumentsRequest) Reset()

func (*PurgeDocumentsRequest) String added in v0.3.1 

func (x *PurgeDocumentsRequest) String() string

type PurgeDocumentsRequest_GcsSource added in v1.14.0 

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

type PurgeDocumentsRequest_InlineSource added in v1.14.0 

type PurgeDocumentsRequest_InlineSource struct {

	// Required. A list of full resource name of documents to purge. In the
	// format
	// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
	// Recommended max of 100 items.
	Documents []string `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.

func (*PurgeDocumentsRequest_InlineSource) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use PurgeDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest_InlineSource) GetDocuments added in v1.14.0 

func (x *PurgeDocumentsRequest_InlineSource) GetDocuments() []string

func (*PurgeDocumentsRequest_InlineSource) ProtoMessage added in v1.14.0 

func (*PurgeDocumentsRequest_InlineSource) ProtoMessage()

func (*PurgeDocumentsRequest_InlineSource) ProtoReflect added in v1.14.0 

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

func (*PurgeDocumentsRequest_InlineSource) Reset added in v1.14.0 

func (x *PurgeDocumentsRequest_InlineSource) Reset()

func (*PurgeDocumentsRequest_InlineSource) String added in v1.14.0 

func (x *PurgeDocumentsRequest_InlineSource) String() string

type PurgeDocumentsRequest_InlineSource_ added in v1.14.0 

type PurgeDocumentsRequest_InlineSource_ struct {
	// Inline source for the input content for purge.
	InlineSource *PurgeDocumentsRequest_InlineSource `protobuf:"bytes,6,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type PurgeDocumentsResponse added in v0.3.1 

type PurgeDocumentsResponse struct {

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

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

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

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

Deprecated: Use PurgeDocumentsResponse.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsResponse) GetPurgeCount added in v0.3.1 

func (x *PurgeDocumentsResponse) GetPurgeCount() int64

func (*PurgeDocumentsResponse) GetPurgeSample added in v0.3.1 

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

func (*PurgeDocumentsResponse) ProtoMessage added in v0.3.1 

func (*PurgeDocumentsResponse) ProtoMessage()

func (*PurgeDocumentsResponse) ProtoReflect added in v0.3.1 

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

func (*PurgeDocumentsResponse) Reset added in v0.3.1 

func (x *PurgeDocumentsResponse) Reset()

func (*PurgeDocumentsResponse) String added in v0.3.1 

func (x *PurgeDocumentsResponse) String() string

type PurgeErrorConfig added in v1.14.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.14.0 

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

Deprecated: Use PurgeErrorConfig.ProtoReflect.Descriptor instead.

func (*PurgeErrorConfig) GetDestination added in v1.14.0 

func (m *PurgeErrorConfig) GetDestination() isPurgeErrorConfig_Destination

func (*PurgeErrorConfig) GetGcsPrefix added in v1.14.0 

func (x *PurgeErrorConfig) GetGcsPrefix() string

func (*PurgeErrorConfig) ProtoMessage added in v1.14.0 

func (*PurgeErrorConfig) ProtoMessage()

func (*PurgeErrorConfig) ProtoReflect added in v1.14.0 

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

func (*PurgeErrorConfig) Reset added in v1.14.0 

func (x *PurgeErrorConfig) Reset()

func (*PurgeErrorConfig) String added in v1.14.0 

func (x *PurgeErrorConfig) String() string

type PurgeErrorConfig_GcsPrefix added in v1.14.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.5.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.5.0 

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

Deprecated: Use PurgeSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesMetadata) GetCreateTime added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage added in v1.5.0 

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage()

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoReflect added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesMetadata) Reset added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesMetadata) Reset()

func (*PurgeSuggestionDenyListEntriesMetadata) String added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesMetadata) String() string

type PurgeSuggestionDenyListEntriesRequest added in v1.5.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.v1beta.CompletionService.PurgeSuggestionDenyListEntries] method.

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

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

Deprecated: Use PurgeSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesRequest) GetParent added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesRequest) GetParent() string

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage added in v1.5.0 

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage()

func (*PurgeSuggestionDenyListEntriesRequest) ProtoReflect added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesRequest) Reset added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesRequest) Reset()

func (*PurgeSuggestionDenyListEntriesRequest) String added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesRequest) String() string

type PurgeSuggestionDenyListEntriesResponse added in v1.5.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.v1beta.CompletionService.PurgeSuggestionDenyListEntries] method.

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

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

Deprecated: Use PurgeSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesResponse) GetErrorSamples added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesResponse) GetPurgeCount added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesResponse) GetPurgeCount() int64

func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage added in v1.5.0 

func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage()

func (*PurgeSuggestionDenyListEntriesResponse) ProtoReflect added in v1.5.0 

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

func (*PurgeSuggestionDenyListEntriesResponse) Reset added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesResponse) Reset()

func (*PurgeSuggestionDenyListEntriesResponse) String added in v1.5.0 

func (x *PurgeSuggestionDenyListEntriesResponse) String() string

type PurgeUserEventsMetadata added in v1.11.0 

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 added in v1.11.0 

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

Deprecated: Use PurgeUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsMetadata) GetCreateTime added in v1.11.0 

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

func (*PurgeUserEventsMetadata) GetFailureCount added in v1.11.0 

func (x *PurgeUserEventsMetadata) GetFailureCount() int64

func (*PurgeUserEventsMetadata) GetSuccessCount added in v1.11.0 

func (x *PurgeUserEventsMetadata) GetSuccessCount() int64

func (*PurgeUserEventsMetadata) GetUpdateTime added in v1.11.0 

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

func (*PurgeUserEventsMetadata) ProtoMessage added in v1.11.0 

func (*PurgeUserEventsMetadata) ProtoMessage()

func (*PurgeUserEventsMetadata) ProtoReflect added in v1.11.0 

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

func (*PurgeUserEventsMetadata) Reset added in v1.11.0 

func (x *PurgeUserEventsMetadata) Reset()

func (*PurgeUserEventsMetadata) String added in v1.11.0 

func (x *PurgeUserEventsMetadata) String() string

type PurgeUserEventsRequest added in v1.11.0 

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.v1beta.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 added in v1.11.0 

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

Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsRequest) GetFilter added in v1.11.0 

func (x *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce added in v1.11.0 

func (x *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent added in v1.11.0 

func (x *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage added in v1.11.0 

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) ProtoReflect added in v1.11.0 

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

func (*PurgeUserEventsRequest) Reset added in v1.11.0 

func (x *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String added in v1.11.0 

func (x *PurgeUserEventsRequest) String() string

type PurgeUserEventsResponse added in v1.11.0 

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 added in v1.11.0 

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

Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsResponse) GetPurgeCount added in v1.11.0 

func (x *PurgeUserEventsResponse) GetPurgeCount() int64

func (*PurgeUserEventsResponse) ProtoMessage added in v1.11.0 

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) ProtoReflect added in v1.11.0 

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

func (*PurgeUserEventsResponse) Reset added in v1.11.0 

func (x *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String added in v1.11.0 

func (x *PurgeUserEventsResponse) String() string

type QualityMetrics added in v1.10.0 

type QualityMetrics struct {

	// Recall per document, at various top-k cutoff levels.
	//
	// Recall is the fraction of relevant documents retrieved out of all
	// relevant documents.
	//
	// Example (top-5):
	//   - For a single
	//     [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 3 out
	//     of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
	DocRecall *QualityMetrics_TopkMetrics `protobuf:"bytes,1,opt,name=doc_recall,json=docRecall,proto3" json:"doc_recall,omitempty"`
	// Precision per document, at various top-k cutoff levels.
	//
	// Precision is the fraction of retrieved documents that are relevant.
	//
	// Example (top-5):
	//   - For a single
	//     [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 4 out
	//     of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
	//     0.8
	DocPrecision *QualityMetrics_TopkMetrics `protobuf:"bytes,2,opt,name=doc_precision,json=docPrecision,proto3" json:"doc_precision,omitempty"`
	// Normalized discounted cumulative gain (NDCG) per document, at various top-k
	// cutoff levels.
	//
	// NDCG measures the ranking quality, giving higher relevance to top
	// results.
	//
	// Example (top-3):
	//
	//	Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
	//	with three retrieved documents (D1, D2, D3) and binary relevance
	//	judgements (1 for relevant, 0 for not relevant):
	//
	//	 Retrieved:  [D3 (0), D1 (1), D2 (1)]
	//	 Ideal:      [D1 (1), D2 (1), D3 (0)]
	//
	//	 Calculate NDCG@3 for each
	//	 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
	//	  * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
	//	  * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
	//	  * NDCG@3: 1.13/1.63 = 0.693
	DocNdcg *QualityMetrics_TopkMetrics `protobuf:"bytes,3,opt,name=doc_ndcg,json=docNdcg,proto3" json:"doc_ndcg,omitempty"`
	// Recall per page, at various top-k cutoff levels.
	//
	// Recall is the fraction of relevant pages retrieved out of all relevant
	// pages.
	//
	// Example (top-5):
	//   - For a single
	//     [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], if 3 out
	//     of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
	PageRecall *QualityMetrics_TopkMetrics `protobuf:"bytes,4,opt,name=page_recall,json=pageRecall,proto3" json:"page_recall,omitempty"`
	// Normalized discounted cumulative gain (NDCG) per page, at various top-k
	// cutoff levels.
	//
	// NDCG measures the ranking quality, giving higher relevance to top
	// results.
	//
	// Example (top-3):
	//
	//	Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
	//	with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
	//	for relevant, 0 for not relevant):
	//
	//	 Retrieved:  [P3 (0), P1 (1), P2 (1)]
	//	 Ideal:      [P1 (1), P2 (1), P3 (0)]
	//
	//	 Calculate NDCG@3 for
	//	 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
	//	  * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
	//	  * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
	//	  * NDCG@3: 1.13/1.63 = 0.693
	PageNdcg *QualityMetrics_TopkMetrics `protobuf:"bytes,5,opt,name=page_ndcg,json=pageNdcg,proto3" json:"page_ndcg,omitempty"`
	// contains filtered or unexported fields
}

Describes the metrics produced by the evaluation.

func (*QualityMetrics) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use QualityMetrics.ProtoReflect.Descriptor instead.

func (*QualityMetrics) GetDocNdcg added in v1.10.0 

func (x *QualityMetrics) GetDocNdcg() *QualityMetrics_TopkMetrics

func (*QualityMetrics) GetDocPrecision added in v1.10.0 

func (x *QualityMetrics) GetDocPrecision() *QualityMetrics_TopkMetrics

func (*QualityMetrics) GetDocRecall added in v1.10.0 

func (x *QualityMetrics) GetDocRecall() *QualityMetrics_TopkMetrics

func (*QualityMetrics) GetPageNdcg added in v1.10.0 

func (x *QualityMetrics) GetPageNdcg() *QualityMetrics_TopkMetrics

func (*QualityMetrics) GetPageRecall added in v1.10.0 

func (x *QualityMetrics) GetPageRecall() *QualityMetrics_TopkMetrics

func (*QualityMetrics) ProtoMessage added in v1.10.0 

func (*QualityMetrics) ProtoMessage()

func (*QualityMetrics) ProtoReflect added in v1.10.0 

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

func (*QualityMetrics) Reset added in v1.10.0 

func (x *QualityMetrics) Reset()

func (*QualityMetrics) String added in v1.10.0 

func (x *QualityMetrics) String() string

type QualityMetrics_TopkMetrics added in v1.10.0 

type QualityMetrics_TopkMetrics struct {

	// The top-1 value.
	Top_1 float64 `protobuf:"fixed64,1,opt,name=top_1,json=top1,proto3" json:"top_1,omitempty"`
	// The top-3 value.
	Top_3 float64 `protobuf:"fixed64,2,opt,name=top_3,json=top3,proto3" json:"top_3,omitempty"`
	// The top-5 value.
	Top_5 float64 `protobuf:"fixed64,3,opt,name=top_5,json=top5,proto3" json:"top_5,omitempty"`
	// The top-10 value.
	Top_10 float64 `protobuf:"fixed64,4,opt,name=top_10,json=top10,proto3" json:"top_10,omitempty"`
	// contains filtered or unexported fields
}

Stores the metric values at specific top-k levels.

func (*QualityMetrics_TopkMetrics) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use QualityMetrics_TopkMetrics.ProtoReflect.Descriptor instead.

func (*QualityMetrics_TopkMetrics) GetTop_1 added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) GetTop_1() float64

func (*QualityMetrics_TopkMetrics) GetTop_10 added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) GetTop_10() float64

func (*QualityMetrics_TopkMetrics) GetTop_3 added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) GetTop_3() float64

func (*QualityMetrics_TopkMetrics) GetTop_5 added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) GetTop_5() float64

func (*QualityMetrics_TopkMetrics) ProtoMessage added in v1.10.0 

func (*QualityMetrics_TopkMetrics) ProtoMessage()

func (*QualityMetrics_TopkMetrics) ProtoReflect added in v1.10.0 

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

func (*QualityMetrics_TopkMetrics) Reset added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) Reset()

func (*QualityMetrics_TopkMetrics) String added in v1.10.0 

func (x *QualityMetrics_TopkMetrics) String() string

type Query added in v1.7.0 

type Query struct {

	// Query content.
	//
	// Types that are assignable to Content:
	//
	//	*Query_Text
	Content isQuery_Content `protobuf_oneof:"content"`
	// Unique Id for the query.
	QueryId string `protobuf:"bytes,1,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
	// contains filtered or unexported fields
}

Defines a user inputed query.

func (*Query) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetContent added in v1.7.0 

func (m *Query) GetContent() isQuery_Content

func (*Query) GetQueryId added in v1.7.0 

func (x *Query) GetQueryId() string

func (*Query) GetText added in v1.7.0 

func (x *Query) GetText() string

func (*Query) ProtoMessage added in v1.7.0 

func (*Query) ProtoMessage()

func (*Query) ProtoReflect added in v1.7.0 

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

func (*Query) Reset added in v1.7.0 

func (x *Query) Reset()

func (*Query) String added in v1.7.0 

func (x *Query) String() string

type Query_Text added in v1.7.0 

type Query_Text struct {
	// Plain text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}

type RankRequest added in v1.7.0 

type RankRequest struct {

	// Required. The resource name of the rank service config, such as
	// `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
	RankingConfig string `protobuf:"bytes,1,opt,name=ranking_config,json=rankingConfig,proto3" json:"ranking_config,omitempty"`
	// The identifier of the model to use. It is one of:
	//
	// * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
	// token size 512.
	//
	// It is set to `semantic-ranker-512@latest` by default if unspecified.
	Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	// The number of results to return. If this is unset or no bigger than zero,
	// returns all results.
	TopN int32 `protobuf:"varint,3,opt,name=top_n,json=topN,proto3" json:"top_n,omitempty"`
	// The query to use.
	Query string `protobuf:"bytes,4,opt,name=query,proto3" json:"query,omitempty"`
	// Required. A list of records to rank. At most 200 records to rank.
	Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
	// If true, the response will contain only record ID and score. By default, it
	// is false, the response will contain record details.
	IgnoreRecordDetailsInResponse bool `` /* 155-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 [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 */
	// contains filtered or unexported fields
}

Request message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.

func (*RankRequest) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use RankRequest.ProtoReflect.Descriptor instead.

func (*RankRequest) GetIgnoreRecordDetailsInResponse added in v1.7.0 

func (x *RankRequest) GetIgnoreRecordDetailsInResponse() bool

func (*RankRequest) GetModel added in v1.7.0 

func (x *RankRequest) GetModel() string

func (*RankRequest) GetQuery added in v1.7.0 

func (x *RankRequest) GetQuery() string

func (*RankRequest) GetRankingConfig added in v1.7.0 

func (x *RankRequest) GetRankingConfig() string

func (*RankRequest) GetRecords added in v1.7.0 

func (x *RankRequest) GetRecords() []*RankingRecord

func (*RankRequest) GetTopN added in v1.7.0 

func (x *RankRequest) GetTopN() int32

func (*RankRequest) GetUserLabels added in v1.8.0 

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

func (*RankRequest) ProtoMessage added in v1.7.0 

func (*RankRequest) ProtoMessage()

func (*RankRequest) ProtoReflect added in v1.7.0 

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

func (*RankRequest) Reset added in v1.7.0 

func (x *RankRequest) Reset()

func (*RankRequest) String added in v1.7.0 

func (x *RankRequest) String() string

type RankResponse added in v1.7.0 

type RankResponse struct {

	// A list of records sorted by descending score.
	Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
	// contains filtered or unexported fields
}

Response message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.

func (*RankResponse) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use RankResponse.ProtoReflect.Descriptor instead.

func (*RankResponse) GetRecords added in v1.7.0 

func (x *RankResponse) GetRecords() []*RankingRecord

func (*RankResponse) ProtoMessage added in v1.7.0 

func (*RankResponse) ProtoMessage()

func (*RankResponse) ProtoReflect added in v1.7.0 

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

func (*RankResponse) Reset added in v1.7.0 

func (x *RankResponse) Reset()

func (*RankResponse) String added in v1.7.0 

func (x *RankResponse) String() string

type RankServiceClient added in v1.7.0 

type RankServiceClient interface {
	// Ranks a list of text records based on the given input query.
	Rank(ctx context.Context, in *RankRequest, opts ...grpc.CallOption) (*RankResponse, error)
}

RankServiceClient is the client API for RankService service.

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

func NewRankServiceClient added in v1.7.0 

func NewRankServiceClient(cc grpc.ClientConnInterface) RankServiceClient

type RankServiceServer added in v1.7.0 

type RankServiceServer interface {
	// Ranks a list of text records based on the given input query.
	Rank(context.Context, *RankRequest) (*RankResponse, error)
}

RankServiceServer is the server API for RankService service.

type RankingRecord added in v1.7.0 

type RankingRecord struct {

	// The unique ID to represent the record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The title of the record. Empty by default.
	// At least one of
	// [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
	// [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
	// be set otherwise an INVALID_ARGUMENT error is thrown.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// The content of the record. Empty by default.
	// At least one of
	// [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
	// [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
	// be set otherwise an INVALID_ARGUMENT error is thrown.
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// The score of this record based on the given query and selected model.
	Score float32 `protobuf:"fixed32,4,opt,name=score,proto3" json:"score,omitempty"`
	// contains filtered or unexported fields
}

Record message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.

func (*RankingRecord) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use RankingRecord.ProtoReflect.Descriptor instead.

func (*RankingRecord) GetContent added in v1.7.0 

func (x *RankingRecord) GetContent() string

func (*RankingRecord) GetId added in v1.7.0 

func (x *RankingRecord) GetId() string

func (*RankingRecord) GetScore added in v1.7.0 

func (x *RankingRecord) GetScore() float32

func (*RankingRecord) GetTitle added in v1.7.0 

func (x *RankingRecord) GetTitle() string

func (*RankingRecord) ProtoMessage added in v1.7.0 

func (*RankingRecord) ProtoMessage()

func (*RankingRecord) ProtoReflect added in v1.7.0 

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

func (*RankingRecord) Reset added in v1.7.0 

func (x *RankingRecord) Reset()

func (*RankingRecord) String added in v1.7.0 

func (x *RankingRecord) String() string

type RecommendRequest 

type RecommendRequest struct {

	// Required. Full resource name of a
	// [ServingConfig][google.cloud.discoveryengine.v1beta.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 is 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.v1beta.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.v1beta.UserEvent.user_pseudo_id]
	// or
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
	// to the same fixed ID for different users. If you are trying to receive
	// non-personalized recommendations (not recommended; this can negatively
	// impact model performance), instead set
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// to a random unique ID and leave
	// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
	// unset.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// Maximum number of results to return. Set this property
	// to the number of recommendation results needed. If zero, the service
	// chooses a reasonable default. The maximum allowed value is 100. Values
	// above 100 are set 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 returns generic
	// (unfiltered) popular Documents. If you only want results strictly matching
	// the filters, set `strictFiltering` to `true` in
	// [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
	// to receive empty results instead.
	//
	// Note that the API never returns
	// [Document][google.cloud.discoveryengine.v1beta.Document]s with
	// `storageStatus` as `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 is 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 is returned in
	//     [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
	//   - `returnScore`: Boolean. If set to true, the recommendation score
	//     corresponding to each returned Document is set in
	//     [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
	//     The given score indicates the probability of a Document conversion given
	//     the user's context and history.
	//   - `strictFiltering`: Boolean. True by default. If set to `false`, the
	//
	// service
	//
	//	returns 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.v1beta.UserEvent] logs resulting
	// from this recommendation, which enables accurate attribution of
	// recommendation model performance.
	AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// IDs of documents in the request that were missing from the default Branch
	// associated with the requested ServingConfig.
	MissingIds []string `protobuf:"bytes,3,rep,name=missing_ids,json=missingIds,proto3" json:"missing_ids,omitempty"`
	// True if
	// [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
	// was set.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Response message for Recommend method.

func (*RecommendResponse) Descriptor deprecated 

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

Deprecated: Use RecommendResponse.ProtoReflect.Descriptor instead.

func (*RecommendResponse) GetAttributionToken 

func (x *RecommendResponse) GetAttributionToken() string

func (*RecommendResponse) GetMissingIds 

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

func (*RecommendResponse) GetResults 

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

func (*RecommendResponse) GetValidateOnly 

func (x *RecommendResponse) GetValidateOnly() bool

func (*RecommendResponse) ProtoMessage 

func (*RecommendResponse) ProtoMessage()

func (*RecommendResponse) ProtoReflect 

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

func (*RecommendResponse) Reset 

func (x *RecommendResponse) Reset()

func (*RecommendResponse) String 

func (x *RecommendResponse) String() string

type RecommendResponse_RecommendationResult 

type RecommendResponse_RecommendationResult struct {

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

RecommendationResult represents a generic recommendation result with associated metadata.

func (*RecommendResponse_RecommendationResult) Descriptor deprecated 

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

Deprecated: Use RecommendResponse_RecommendationResult.ProtoReflect.Descriptor instead.

func (*RecommendResponse_RecommendationResult) GetDocument 

func (x *RecommendResponse_RecommendationResult) GetDocument() *Document

func (*RecommendResponse_RecommendationResult) GetId 

func (x *RecommendResponse_RecommendationResult) GetId() string

func (*RecommendResponse_RecommendationResult) GetMetadata 

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

func (*RecommendResponse_RecommendationResult) ProtoMessage 

func (*RecommendResponse_RecommendationResult) ProtoMessage()

func (*RecommendResponse_RecommendationResult) ProtoReflect 

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

func (*RecommendResponse_RecommendationResult) Reset 

func (x *RecommendResponse_RecommendationResult) Reset()

func (*RecommendResponse_RecommendationResult) String 

func (x *RecommendResponse_RecommendationResult) String() string

type RecommendationServiceClient 

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

RecommendationServiceClient is the client API for RecommendationService service.

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

func NewRecommendationServiceClient 

func NewRecommendationServiceClient(cc grpc.ClientConnInterface) RecommendationServiceClient

type RecommendationServiceServer 

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

RecommendationServiceServer is the server API for RecommendationService service.

type RecrawlUrisMetadata added in v1.5.0 

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.v1beta.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*RecrawlUrisMetadata) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use RecrawlUrisMetadata.ProtoReflect.Descriptor instead.

func (*RecrawlUrisMetadata) GetCreateTime added in v1.5.0 

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

func (*RecrawlUrisMetadata) GetInvalidUris added in v1.5.0 

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

func (*RecrawlUrisMetadata) GetPendingCount added in v1.5.0 

func (x *RecrawlUrisMetadata) GetPendingCount() int32

func (*RecrawlUrisMetadata) GetQuotaExceededCount added in v1.5.0 

func (x *RecrawlUrisMetadata) GetQuotaExceededCount() int32

func (*RecrawlUrisMetadata) GetSuccessCount added in v1.5.0 

func (x *RecrawlUrisMetadata) GetSuccessCount() int32

func (*RecrawlUrisMetadata) GetUpdateTime added in v1.5.0 

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

func (*RecrawlUrisMetadata) GetValidUrisCount added in v1.5.0 

func (x *RecrawlUrisMetadata) GetValidUrisCount() int32

func (*RecrawlUrisMetadata) ProtoMessage added in v1.5.0 

func (*RecrawlUrisMetadata) ProtoMessage()

func (*RecrawlUrisMetadata) ProtoReflect added in v1.5.0 

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

func (*RecrawlUrisMetadata) Reset added in v1.5.0 

func (x *RecrawlUrisMetadata) Reset()

func (*RecrawlUrisMetadata) String added in v1.5.0 

func (x *RecrawlUrisMetadata) String() string

type RecrawlUrisRequest added in v1.5.0 

type RecrawlUrisRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.SiteSearchEngineService.RecrawlUris] method.

func (*RecrawlUrisRequest) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use RecrawlUrisRequest.ProtoReflect.Descriptor instead.

func (*RecrawlUrisRequest) GetSiteSearchEngine added in v1.5.0 

func (x *RecrawlUrisRequest) GetSiteSearchEngine() string

func (*RecrawlUrisRequest) GetUris added in v1.5.0 

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

func (*RecrawlUrisRequest) ProtoMessage added in v1.5.0 

func (*RecrawlUrisRequest) ProtoMessage()

func (*RecrawlUrisRequest) ProtoReflect added in v1.5.0 

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

func (*RecrawlUrisRequest) Reset added in v1.5.0 

func (x *RecrawlUrisRequest) Reset()

func (*RecrawlUrisRequest) String added in v1.5.0 

func (x *RecrawlUrisRequest) String() string

type RecrawlUrisResponse added in v1.5.0 

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.v1beta.SiteSearchEngineService.RecrawlUris] method.

func (*RecrawlUrisResponse) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use RecrawlUrisResponse.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse) GetFailedUris added in v1.5.0 

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

func (*RecrawlUrisResponse) GetFailureSamples added in v1.5.0 

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

func (*RecrawlUrisResponse) ProtoMessage added in v1.5.0 

func (*RecrawlUrisResponse) ProtoMessage()

func (*RecrawlUrisResponse) ProtoReflect added in v1.5.0 

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

func (*RecrawlUrisResponse) Reset added in v1.5.0 

func (x *RecrawlUrisResponse) Reset()

func (*RecrawlUrisResponse) String added in v1.5.0 

func (x *RecrawlUrisResponse) String() string

type RecrawlUrisResponse_FailureInfo added in v1.5.0 

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 added in v1.5.0 

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

Deprecated: Use RecrawlUrisResponse_FailureInfo.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse_FailureInfo) GetFailureReasons added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo) GetFailureReasons() []*RecrawlUrisResponse_FailureInfo_FailureReason

func (*RecrawlUrisResponse_FailureInfo) GetUri added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo) GetUri() string

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage added in v1.5.0 

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage()

func (*RecrawlUrisResponse_FailureInfo) ProtoReflect added in v1.5.0 

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

func (*RecrawlUrisResponse_FailureInfo) Reset added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo) Reset()

func (*RecrawlUrisResponse_FailureInfo) String added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo) String() string

type RecrawlUrisResponse_FailureInfo_FailureReason added in v1.5.0 

type RecrawlUrisResponse_FailureInfo_FailureReason struct {

	// DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
	CorpusType RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType `` /* 190-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 added in v1.5.0 

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

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType() RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage() string

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage added in v1.5.0 

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage()

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect added in v1.5.0 

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

func (*RecrawlUrisResponse_FailureInfo_FailureReason) Reset added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo_FailureReason) Reset()

func (*RecrawlUrisResponse_FailureInfo_FailureReason) String added in v1.5.0 

func (x *RecrawlUrisResponse_FailureInfo_FailureReason) String() string

type RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType added in v1.5.0 

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 added in v1.5.0 

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor() protoreflect.EnumDescriptor

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum added in v1.5.0 

func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum() *RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor deprecated added in v1.5.0 

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

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.Descriptor instead.

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number added in v1.5.0 

func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number() protoreflect.EnumNumber

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String added in v1.5.0 

func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String() string

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type added in v1.5.0 

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type() protoreflect.EnumType

type Reply added in v1.1.0 

type Reply struct {

	// DEPRECATED: use `summary` instead.
	// Text reply.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/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/v1beta/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 added in v1.1.0 

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

Deprecated: Use Reply.ProtoReflect.Descriptor instead.

func (*Reply) GetReferences deprecated added in v1.1.0 

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

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

func (*Reply) GetReply deprecated added in v1.1.0 

func (x *Reply) GetReply() string

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

func (*Reply) GetSummary added in v1.2.0 

func (x *Reply) GetSummary() *SearchResponse_Summary

func (*Reply) ProtoMessage added in v1.1.0 

func (*Reply) ProtoMessage()

func (*Reply) ProtoReflect added in v1.1.0 

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

func (*Reply) Reset added in v1.1.0 

func (x *Reply) Reset()

func (*Reply) String added in v1.1.0 

func (x *Reply) String() string

type Reply_Reference deprecated added in v1.1.0 

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/v1beta/conversation.proto.

func (*Reply_Reference) Descriptor deprecated added in v1.1.0 

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

Deprecated: Use Reply_Reference.ProtoReflect.Descriptor instead.

func (*Reply_Reference) GetAnchorText added in v1.1.0 

func (x *Reply_Reference) GetAnchorText() string

func (*Reply_Reference) GetEnd added in v1.1.0 

func (x *Reply_Reference) GetEnd() int32

func (*Reply_Reference) GetStart added in v1.1.0 

func (x *Reply_Reference) GetStart() int32

func (*Reply_Reference) GetUri added in v1.1.0 

func (x *Reply_Reference) GetUri() string

func (*Reply_Reference) ProtoMessage added in v1.1.0 

func (*Reply_Reference) ProtoMessage()

func (*Reply_Reference) ProtoReflect added in v1.1.0 

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

func (*Reply_Reference) Reset added in v1.1.0 

func (x *Reply_Reference) Reset()

func (*Reply_Reference) String added in v1.1.0 

func (x *Reply_Reference) String() string

type ResumeEngineRequest added in v1.7.0 

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 added in v1.7.0 

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

Deprecated: Use ResumeEngineRequest.ProtoReflect.Descriptor instead.

func (*ResumeEngineRequest) GetName added in v1.7.0 

func (x *ResumeEngineRequest) GetName() string

func (*ResumeEngineRequest) ProtoMessage added in v1.7.0 

func (*ResumeEngineRequest) ProtoMessage()

func (*ResumeEngineRequest) ProtoReflect added in v1.7.0 

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

func (*ResumeEngineRequest) Reset added in v1.7.0 

func (x *ResumeEngineRequest) Reset()

func (*ResumeEngineRequest) String added in v1.7.0 

func (x *ResumeEngineRequest) String() string

type SampleQuery added in v1.10.0 

type SampleQuery struct {

	// The content of the sample query.
	//
	// Types that are assignable to Content:
	//
	//	*SampleQuery_QueryEntry_
	Content isSampleQuery_Content `protobuf_oneof:"content"`
	// Identifier. The full resource name of the sample query, in the format of
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
	//
	// 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. Timestamp the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] was created
	// at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Sample Query captures metadata to be used for evaluation.

func (*SampleQuery) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use SampleQuery.ProtoReflect.Descriptor instead.

func (*SampleQuery) GetContent added in v1.10.0 

func (m *SampleQuery) GetContent() isSampleQuery_Content

func (*SampleQuery) GetCreateTime added in v1.10.0 

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

func (*SampleQuery) GetName added in v1.10.0 

func (x *SampleQuery) GetName() string

func (*SampleQuery) GetQueryEntry added in v1.10.0 

func (x *SampleQuery) GetQueryEntry() *SampleQuery_QueryEntry

func (*SampleQuery) ProtoMessage added in v1.10.0 

func (*SampleQuery) ProtoMessage()

func (*SampleQuery) ProtoReflect added in v1.10.0 

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

func (*SampleQuery) Reset added in v1.10.0 

func (x *SampleQuery) Reset()

func (*SampleQuery) String added in v1.10.0 

func (x *SampleQuery) String() string

type SampleQueryServiceClient added in v1.10.0 

type SampleQueryServiceClient interface {
	// Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	GetSampleQuery(ctx context.Context, in *GetSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
	// Gets a list of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.
	ListSampleQueries(ctx context.Context, in *ListSampleQueriesRequest, opts ...grpc.CallOption) (*ListSampleQueriesResponse, error)
	// Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
	CreateSampleQuery(ctx context.Context, in *CreateSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
	// Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	UpdateSampleQuery(ctx context.Context, in *UpdateSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
	// Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	DeleteSampleQuery(ctx context.Context, in *DeleteSampleQueryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample
	// queries that already exist may be deleted.
	//
	// Note: It is possible for a subset of the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be
	// successfully imported.
	ImportSampleQueries(ctx context.Context, in *ImportSampleQueriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

SampleQueryServiceClient is the client API for SampleQueryService service.

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

func NewSampleQueryServiceClient added in v1.10.0 

func NewSampleQueryServiceClient(cc grpc.ClientConnInterface) SampleQueryServiceClient

type SampleQueryServiceServer added in v1.10.0 

type SampleQueryServiceServer interface {
	// Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	GetSampleQuery(context.Context, *GetSampleQueryRequest) (*SampleQuery, error)
	// Gets a list of
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.
	ListSampleQueries(context.Context, *ListSampleQueriesRequest) (*ListSampleQueriesResponse, error)
	// Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
	CreateSampleQuery(context.Context, *CreateSampleQueryRequest) (*SampleQuery, error)
	// Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	UpdateSampleQuery(context.Context, *UpdateSampleQueryRequest) (*SampleQuery, error)
	// Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
	DeleteSampleQuery(context.Context, *DeleteSampleQueryRequest) (*emptypb.Empty, error)
	// Bulk import of multiple
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample
	// queries that already exist may be deleted.
	//
	// Note: It is possible for a subset of the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be
	// successfully imported.
	ImportSampleQueries(context.Context, *ImportSampleQueriesRequest) (*longrunningpb.Operation, error)
}

SampleQueryServiceServer is the server API for SampleQueryService service.

type SampleQuerySet added in v1.10.0 

type SampleQuerySet struct {

	// Identifier. The full resource name of the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], in
	// the format of
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
	//
	// 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 sample query set display name.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Timestamp the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] was
	// created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The description of the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.

func (*SampleQuerySet) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use SampleQuerySet.ProtoReflect.Descriptor instead.

func (*SampleQuerySet) GetCreateTime added in v1.10.0 

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

func (*SampleQuerySet) GetDescription added in v1.10.0 

func (x *SampleQuerySet) GetDescription() string

func (*SampleQuerySet) GetDisplayName added in v1.10.0 

func (x *SampleQuerySet) GetDisplayName() string

func (*SampleQuerySet) GetName added in v1.10.0 

func (x *SampleQuerySet) GetName() string

func (*SampleQuerySet) ProtoMessage added in v1.10.0 

func (*SampleQuerySet) ProtoMessage()

func (*SampleQuerySet) ProtoReflect added in v1.10.0 

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

func (*SampleQuerySet) Reset added in v1.10.0 

func (x *SampleQuerySet) Reset()

func (*SampleQuerySet) String added in v1.10.0 

func (x *SampleQuerySet) String() string

type SampleQuerySetServiceClient added in v1.10.0 

type SampleQuerySetServiceClient interface {
	// Gets a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	GetSampleQuerySet(ctx context.Context, in *GetSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
	// Gets a list of
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.
	ListSampleQuerySets(ctx context.Context, in *ListSampleQuerySetsRequest, opts ...grpc.CallOption) (*ListSampleQuerySetsResponse, error)
	// Creates a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
	CreateSampleQuerySet(ctx context.Context, in *CreateSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
	// Updates a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	UpdateSampleQuerySet(ctx context.Context, in *UpdateSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
	// Deletes a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	DeleteSampleQuerySet(ctx context.Context, in *DeleteSampleQuerySetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

SampleQuerySetServiceClient is the client API for SampleQuerySetService service.

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

func NewSampleQuerySetServiceClient added in v1.10.0 

func NewSampleQuerySetServiceClient(cc grpc.ClientConnInterface) SampleQuerySetServiceClient

type SampleQuerySetServiceServer added in v1.10.0 

type SampleQuerySetServiceServer interface {
	// Gets a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	GetSampleQuerySet(context.Context, *GetSampleQuerySetRequest) (*SampleQuerySet, error)
	// Gets a list of
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.
	ListSampleQuerySets(context.Context, *ListSampleQuerySetsRequest) (*ListSampleQuerySetsResponse, error)
	// Creates a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
	CreateSampleQuerySet(context.Context, *CreateSampleQuerySetRequest) (*SampleQuerySet, error)
	// Updates a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	UpdateSampleQuerySet(context.Context, *UpdateSampleQuerySetRequest) (*SampleQuerySet, error)
	// Deletes a
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].
	DeleteSampleQuerySet(context.Context, *DeleteSampleQuerySetRequest) (*emptypb.Empty, error)
}

SampleQuerySetServiceServer is the server API for SampleQuerySetService service.

type SampleQuery_QueryEntry added in v1.10.0 

type SampleQuery_QueryEntry struct {

	// Required. The query.
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// List of targets for the query.
	Targets []*SampleQuery_QueryEntry_Target `protobuf:"bytes,3,rep,name=targets,proto3" json:"targets,omitempty"`
	// contains filtered or unexported fields
}

Query Entry captures metadata to be used for search evaluation.

func (*SampleQuery_QueryEntry) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use SampleQuery_QueryEntry.ProtoReflect.Descriptor instead.

func (*SampleQuery_QueryEntry) GetQuery added in v1.10.0 

func (x *SampleQuery_QueryEntry) GetQuery() string

func (*SampleQuery_QueryEntry) GetTargets added in v1.10.0 

func (x *SampleQuery_QueryEntry) GetTargets() []*SampleQuery_QueryEntry_Target

func (*SampleQuery_QueryEntry) ProtoMessage added in v1.10.0 

func (*SampleQuery_QueryEntry) ProtoMessage()

func (*SampleQuery_QueryEntry) ProtoReflect added in v1.10.0 

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

func (*SampleQuery_QueryEntry) Reset added in v1.10.0 

func (x *SampleQuery_QueryEntry) Reset()

func (*SampleQuery_QueryEntry) String added in v1.10.0 

func (x *SampleQuery_QueryEntry) String() string

type SampleQuery_QueryEntry_ added in v1.10.0 

type SampleQuery_QueryEntry_ struct {
	// The query entry.
	QueryEntry *SampleQuery_QueryEntry `protobuf:"bytes,2,opt,name=query_entry,json=queryEntry,proto3,oneof"`
}

type SampleQuery_QueryEntry_Target added in v1.10.0 

type SampleQuery_QueryEntry_Target struct {

	// Expected uri of the target.
	//
	// This field must be a UTF-8 encoded string with a length limit of 2048
	// characters.
	//
	// Example of valid uris: `https://example.com/abc`,
	// `gcs://example/example.pdf`.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Expected page numbers of the target.
	//
	// Each page number must be non negative.
	PageNumbers []int32 `protobuf:"varint,2,rep,packed,name=page_numbers,json=pageNumbers,proto3" json:"page_numbers,omitempty"`
	// Relevance score of the target.
	Score *float64 `protobuf:"fixed64,3,opt,name=score,proto3,oneof" json:"score,omitempty"`
	// contains filtered or unexported fields
}

Defines the parameters of the query's expected outcome.

func (*SampleQuery_QueryEntry_Target) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use SampleQuery_QueryEntry_Target.ProtoReflect.Descriptor instead.

func (*SampleQuery_QueryEntry_Target) GetPageNumbers added in v1.10.0 

func (x *SampleQuery_QueryEntry_Target) GetPageNumbers() []int32

func (*SampleQuery_QueryEntry_Target) GetScore added in v1.10.0 

func (x *SampleQuery_QueryEntry_Target) GetScore() float64

func (*SampleQuery_QueryEntry_Target) GetUri added in v1.10.0 

func (x *SampleQuery_QueryEntry_Target) GetUri() string

func (*SampleQuery_QueryEntry_Target) ProtoMessage added in v1.10.0 

func (*SampleQuery_QueryEntry_Target) ProtoMessage()

func (*SampleQuery_QueryEntry_Target) ProtoReflect added in v1.10.0 

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

func (*SampleQuery_QueryEntry_Target) Reset added in v1.10.0 

func (x *SampleQuery_QueryEntry_Target) Reset()

func (*SampleQuery_QueryEntry_Target) String added in v1.10.0 

func (x *SampleQuery_QueryEntry_Target) String() string

type Schema added in v0.3.0 

type Schema struct {

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

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

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

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetJsonSchema added in v0.3.0 

func (x *Schema) GetJsonSchema() string

func (*Schema) GetName added in v0.3.0 

func (x *Schema) GetName() string

func (*Schema) GetSchema added in v0.3.0 

func (m *Schema) GetSchema() isSchema_Schema

func (*Schema) GetStructSchema added in v0.3.0 

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

func (*Schema) ProtoMessage added in v0.3.0 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect added in v0.3.0 

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

func (*Schema) Reset added in v0.3.0 

func (x *Schema) Reset()

func (*Schema) String added in v0.3.0 

func (x *Schema) String() string

type SchemaServiceClient added in v0.3.0 

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

SchemaServiceClient is the client API for SchemaService service.

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

func NewSchemaServiceClient added in v0.3.0 

func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient

type SchemaServiceServer added in v0.3.0 

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

SchemaServiceServer is the server API for SchemaService service.

type Schema_JsonSchema added in v0.3.0 

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

type Schema_StructSchema added in v0.3.0 

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

type SearchAddOn added in v1.5.0 

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 added in v1.5.0 

func (SearchAddOn) Descriptor() protoreflect.EnumDescriptor

func (SearchAddOn) Enum added in v1.5.0 

func (x SearchAddOn) Enum() *SearchAddOn

func (SearchAddOn) EnumDescriptor deprecated added in v1.5.0 

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

Deprecated: Use SearchAddOn.Descriptor instead.

func (SearchAddOn) Number added in v1.5.0 

func (x SearchAddOn) Number() protoreflect.EnumNumber

func (SearchAddOn) String added in v1.5.0 

func (x SearchAddOn) String() string

func (SearchAddOn) Type added in v1.5.0 

func (SearchAddOn) Type() protoreflect.EnumType

type SearchInfo 

type SearchInfo struct {

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

Detailed search information.

func (*SearchInfo) Descriptor deprecated 

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

Deprecated: Use SearchInfo.ProtoReflect.Descriptor instead.

func (*SearchInfo) GetOffset 

func (x *SearchInfo) GetOffset() int32

func (*SearchInfo) GetOrderBy 

func (x *SearchInfo) GetOrderBy() string

func (*SearchInfo) GetSearchQuery 

func (x *SearchInfo) GetSearchQuery() string

func (*SearchInfo) ProtoMessage 

func (*SearchInfo) ProtoMessage()

func (*SearchInfo) ProtoReflect 

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

func (*SearchInfo) Reset 

func (x *SearchInfo) Reset()

func (*SearchInfo) String 

func (x *SearchInfo) String() string

type SearchRequest added in v0.3.0 

type SearchRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/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.v1beta.Document]s
	// to return. The maximum allowed value depends on the data type. Values above
	// the maximum value are coerced to the maximum value.
	//
	// * Websites with basic indexing: Default `10`, Maximum `25`.
	// * Websites with advanced indexing: Default `25`, Maximum `50`.
	// * Other: Default `50`, Maximum `100`.
	//
	// If this field is negative, an  `INVALID_ARGUMENT` is returned.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token received from a previous
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
	// must match the call that provided the page token. Otherwise, an
	//
	//	`INVALID_ARGUMENT`  error is returned.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A 0-indexed integer that specifies the current offset (that is, starting
	// result location, amongst the
	// [Document][google.cloud.discoveryengine.v1beta.Document]s deemed by the API
	// as relevant) in search results. This field is only considered if
	// [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
	// is unset.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
	// Specs defining dataStores to filter on in a search call and configurations
	// for those dataStores. This is only considered for engines with multiple
	// dataStores use case. For single dataStore within an engine, they should
	// use the specs at the top level.
	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.v1beta.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.v1beta.Document]
	// object. Leave it unset if ordered by relevance. `order_by` expression is
	// case-sensitive.
	//
	// For more information on ordering the website search results, see
	// [Order web search
	// results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
	// For more information on ordering the healthcare search results, see
	// [Order healthcare search
	// results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
	// 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.v1beta.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"`
	// The BCP-47 language code, such as "en-US" or "sr-Latn". For more
	// information, see [Standard
	// fields](https://cloud.google.com/apis/design/standard_fields). This field
	// helps to better interpret the query. If a value isn't specified, the query
	// language code is automatically detected, which may not be accurate.
	LanguageCode string `protobuf:"bytes,35,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// The Unicode country/region code (CLDR) of a location, such as "US" and
	// "419". For more information, see [Standard
	// fields](https://cloud.google.com/apis/design/standard_fields). If set,
	// then results will be boosted based on the region_code provided.
	RegionCode string `protobuf:"bytes,36,opt,name=region_code,json=regionCode,proto3" json:"region_code,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/generative-ai-app-builder/docs/boost-search-results)
	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.
	//     For 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.
	//     For 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.v1beta.UserEvent.user_pseudo_id]
	// and
	// [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id]
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
	UserPseudoId string `protobuf:"bytes,15,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// 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.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// and the document embedding that is provided in
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].
	//
	// If
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
	// is not provided, it will use
	// [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
	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.v1beta.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,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 */
	// If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
	// natural language query understanding will be done.
	NaturalLanguageQueryUnderstandingSpec *SearchRequest_NaturalLanguageQueryUnderstandingSpec `` /* 179-byte string literal not displayed */
	// Search as you type configuration. Only supported for the
	// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
	// vertical.
	SearchAsYouTypeSpec *SearchRequest_SearchAsYouTypeSpec `protobuf:"bytes,31,opt,name=search_as_you_type_spec,json=searchAsYouTypeSpec,proto3" json:"search_as_you_type_spec,omitempty"`
	// The session resource name. Optional.
	//
	// Session allows users to do multi-turn /search API calls or coordination
	// between /search API calls and /answer API calls.
	//
	// Example #1 (multi-turn /search API calls):
	//  1. Call /search API with the auto-session mode (see below).
	//  2. Call /search API with the session ID generated in the first call.
	//     Here, the previous search query gets considered in query
	//     standing. I.e., if the first query is "How did Alphabet do in 2022?"
	//     and the current query is "How about 2023?", the current query will
	//     be interpreted as "How did Alphabet do in 2023?".
	//
	// Example #2 (coordination between /search API calls and /answer API calls):
	//  1. Call /search API with the auto-session mode (see below).
	//  2. Call /answer API with the session ID generated in the first call.
	//     Here, the answer generation happens in the context of the search
	//     results from the first search call.
	//
	// Auto-session mode: when `projects/.../sessions/-` is used, a new session
	// gets automatically created. Otherwise, users can use the create-session API
	// to create a session manually.
	//
	// Multi-turn Search feature is currently at private GA stage. Please use
	// v1alpha or v1beta version instead before we launch this feature to public
	// GA. Or ask for allowlisting through Google Support team.
	Session string `protobuf:"bytes,41,opt,name=session,proto3" json:"session,omitempty"`
	// Session specification.
	//
	// Can be used only when `session` is set.
	SessionSpec *SearchRequest_SessionSpec `protobuf:"bytes,42,opt,name=session_spec,json=sessionSpec,proto3" json:"session_spec,omitempty"`
	// The relevance threshold of the search results.
	//
	// Default to Google defined threshold, leveraging a balance of
	// precision and recall to deliver both highly accurate results and
	// comprehensive coverage of relevant information.
	RelevanceThreshold SearchRequest_RelevanceThreshold `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBoostSpec added in v0.3.0 

func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*SearchRequest) GetBranch added in v0.3.0 

func (x *SearchRequest) GetBranch() string

func (*SearchRequest) GetCanonicalFilter added in v1.5.0 

func (x *SearchRequest) GetCanonicalFilter() string

func (*SearchRequest) GetContentSearchSpec added in v0.3.0 

func (x *SearchRequest) GetContentSearchSpec() *SearchRequest_ContentSearchSpec

func (*SearchRequest) GetDataStoreSpecs added in v1.6.0 

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

func (*SearchRequest) GetEmbeddingSpec added in v1.2.0 

func (x *SearchRequest) GetEmbeddingSpec() *SearchRequest_EmbeddingSpec

func (*SearchRequest) GetFacetSpecs added in v0.3.0 

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

func (*SearchRequest) GetFilter added in v0.3.0 

func (x *SearchRequest) GetFilter() string

func (*SearchRequest) GetImageQuery added in v1.1.0 

func (x *SearchRequest) GetImageQuery() *SearchRequest_ImageQuery

func (*SearchRequest) GetLanguageCode added in v1.11.0 

func (x *SearchRequest) GetLanguageCode() string

func (*SearchRequest) GetNaturalLanguageQueryUnderstandingSpec added in v1.11.0 

func (x *SearchRequest) GetNaturalLanguageQueryUnderstandingSpec() *SearchRequest_NaturalLanguageQueryUnderstandingSpec

func (*SearchRequest) GetOffset added in v0.3.0 

func (x *SearchRequest) GetOffset() int32

func (*SearchRequest) GetOrderBy added in v0.3.0 

func (x *SearchRequest) GetOrderBy() string

func (*SearchRequest) GetPageSize added in v0.3.0 

func (x *SearchRequest) GetPageSize() int32

func (*SearchRequest) GetPageToken added in v0.3.0 

func (x *SearchRequest) GetPageToken() string

func (*SearchRequest) GetParams added in v0.3.0 

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

func (*SearchRequest) GetQuery added in v0.3.0 

func (x *SearchRequest) GetQuery() string

func (*SearchRequest) GetQueryExpansionSpec added in v0.3.0 

func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpec

func (*SearchRequest) GetRankingExpression added in v1.2.0 

func (x *SearchRequest) GetRankingExpression() string

func (*SearchRequest) GetRegionCode added in v1.11.0 

func (x *SearchRequest) GetRegionCode() string

func (*SearchRequest) GetRelevanceThreshold added in v1.14.0 

func (x *SearchRequest) GetRelevanceThreshold() SearchRequest_RelevanceThreshold

func (*SearchRequest) GetSafeSearch added in v0.4.0 

func (x *SearchRequest) GetSafeSearch() bool

func (*SearchRequest) GetSearchAsYouTypeSpec added in v1.11.0 

func (x *SearchRequest) GetSearchAsYouTypeSpec() *SearchRequest_SearchAsYouTypeSpec

func (*SearchRequest) GetServingConfig added in v0.3.0 

func (x *SearchRequest) GetServingConfig() string

func (*SearchRequest) GetSession added in v1.11.0 

func (x *SearchRequest) GetSession() string

func (*SearchRequest) GetSessionSpec added in v1.11.0 

func (x *SearchRequest) GetSessionSpec() *SearchRequest_SessionSpec

func (*SearchRequest) GetSpellCorrectionSpec added in v0.3.0 

func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpec

func (*SearchRequest) GetUserInfo added in v0.4.0 

func (x *SearchRequest) GetUserInfo() *UserInfo

func (*SearchRequest) GetUserLabels added in v0.4.0 

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

func (*SearchRequest) GetUserPseudoId added in v0.3.0 

func (x *SearchRequest) GetUserPseudoId() string

func (*SearchRequest) ProtoMessage added in v0.3.0 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect added in v0.3.0 

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

func (*SearchRequest) Reset added in v0.3.0 

func (x *SearchRequest) Reset()

func (*SearchRequest) String added in v0.3.0 

func (x *SearchRequest) String() string

type SearchRequest_BoostSpec added in v0.3.0 

type SearchRequest_BoostSpec struct {

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

Boost specification to boost certain documents.

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

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

Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec) GetConditionBoostSpecs added in v0.3.0 

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

func (*SearchRequest_BoostSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_BoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec) ProtoReflect added in v0.3.0 

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

func (*SearchRequest_BoostSpec) Reset added in v0.3.0 

func (x *SearchRequest_BoostSpec) Reset()

func (*SearchRequest_BoostSpec) String added in v0.3.0 

func (x *SearchRequest_BoostSpec) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec added in v0.3.0 

type SearchRequest_BoostSpec_ConditionBoostSpec struct {

	// An expression which specifies a boost condition. The syntax and
	// supported fields are the same as a filter expression. See
	// [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost documents with document ID "doc_1" or "doc_2", and
	// color "Red" or "Blue":
	// `(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. Only one of the (condition, boost) combination or the
	// boost_control_spec below are set. If both are set then the global boost
	// is ignored and the more fine-grained boost_control_spec is applied.
	Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
	// Complex specification for custom ranking based on customer defined
	// attribute value.
	BoostControlSpec *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec `protobuf:"bytes,3,opt,name=boost_control_spec,json=boostControlSpec,proto3" json:"boost_control_spec,omitempty"`
	// contains filtered or unexported fields
}

Boost applies to documents which match a condition.

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

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

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition() string

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) Reset()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) String added in v0.3.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec added in v1.7.0 

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec struct {

	// The name of the field whose value will be used to determine the
	// boost amount.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The attribute type to be used to determine the boost amount. The
	// attribute value can be derived from the field value of the specified
	// field_name. In the case of numerical it is straightforward i.e.
	// attribute_value = numerical_field_value. In the case of freshness
	// however, attribute_value = (time.now() - datetime_field_value).
	AttributeType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType `` /* 216-byte string literal not displayed */
	// The interpolation type to be applied to connect the control points
	// listed below.
	InterpolationType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType `` /* 232-byte string literal not displayed */
	// The control points used to define the curve. The monotonic function
	// (defined through the interpolation_type above) passes through the
	// control points listed here.
	ControlPoints []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
	// contains filtered or unexported fields
}

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor deprecated added in v1.7.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints() []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName() string

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage added in v1.7.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage()

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset()

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType added in v1.7.0 

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType int32

The attribute(or function) for which the custom ranking is to be applied. 

const (
	// Unspecified AttributeType.
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 0
	// The value of the numerical field will be used to dynamically update
	// the boost amount. In this case, the attribute_value (the x value)
	// of the control point will be the actual value of the numerical
	// field for which the boost_amount is specified.
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 1
	// For the freshness use case the attribute value will be the duration
	// between the current time and the date in the datetime field
	// specified. The value must be formatted as an XSD `dayTimeDuration`
	// value (a restricted subset of an ISO 8601 duration value). The
	// pattern for this is: `[nD][T[nH][nM][nS]]`.
	// For example, `5D`, `3DT12H30M`, `T24H`.
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 2
)

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor deprecated added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.Descriptor instead.

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number() protoreflect.EnumNumber

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String() string

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type() protoreflect.EnumType

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint added in v1.7.0 

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint struct {

	// Can be one of:
	// 1. The numerical field value.
	// 2. The duration spec for freshness:
	// The value must be formatted as an XSD `dayTimeDuration` value (a
	// restricted subset of an ISO 8601 duration value). The pattern for
	// this is: `[nD][T[nH][nM][nS]]`.
	AttributeValue string `protobuf:"bytes,1,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
	// The value between -1 to 1 by which to boost the score if the
	// attribute_value evaluates to the value specified above.
	BoostAmount float32 `protobuf:"fixed32,2,opt,name=boost_amount,json=boostAmount,proto3" json:"boost_amount,omitempty"`
	// contains filtered or unexported fields
}

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor deprecated added in v1.7.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue() string

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount() float32

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage added in v1.7.0 

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage()

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset()

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String added in v1.7.0 

func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String() string

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType added in v1.7.0 

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType int32

The interpolation type to be applied. Default will be linear (Piecewise Linear). 

const (
	// Interpolation type is unspecified. In this case, it defaults to
	// Linear.
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 0
	// Piecewise linear interpolation will be applied.
	SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_LINEAR SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 1
)

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor deprecated added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.Descriptor instead.

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number() protoreflect.EnumNumber

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String added in v1.7.0 

func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String() string

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type added in v1.7.0 

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type() protoreflect.EnumType

type SearchRequest_ContentSearchSpec added in v0.3.0 

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 defaults to `DOCUMENTS`.
	SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `` /* 202-byte string literal not displayed */
	// Specifies the chunk spec to be returned from the search response.
	// Only available if the
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
	ChunkSpec *SearchRequest_ContentSearchSpec_ChunkSpec `protobuf:"bytes,5,opt,name=chunk_spec,json=chunkSpec,proto3" json:"chunk_spec,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring the behavior of content search.

func (*SearchRequest_ContentSearchSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_ContentSearchSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec) GetChunkSpec added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec) GetChunkSpec() *SearchRequest_ContentSearchSpec_ChunkSpec

func (*SearchRequest_ContentSearchSpec) GetExtractiveContentSpec added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec) GetExtractiveContentSpec() *SearchRequest_ContentSearchSpec_ExtractiveContentSpec

func (*SearchRequest_ContentSearchSpec) GetSearchResultMode added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultMode

func (*SearchRequest_ContentSearchSpec) GetSnippetSpec added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) GetSnippetSpec() *SearchRequest_ContentSearchSpec_SnippetSpec

func (*SearchRequest_ContentSearchSpec) GetSummarySpec added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec

func (*SearchRequest_ContentSearchSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) Reset()

func (*SearchRequest_ContentSearchSpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec) String() string

type SearchRequest_ContentSearchSpec_ChunkSpec added in v1.10.0 

type SearchRequest_ContentSearchSpec_ChunkSpec struct {

	// The number of previous chunks to be returned of the current chunk. The
	// maximum allowed value is 3.
	// If not specified, no previous chunks will be returned.
	NumPreviousChunks int32 `protobuf:"varint,1,opt,name=num_previous_chunks,json=numPreviousChunks,proto3" json:"num_previous_chunks,omitempty"`
	// The number of next chunks to be returned of the current chunk. The
	// maximum allowed value is 3.
	// If not specified, no next chunks will be returned.
	NumNextChunks int32 `protobuf:"varint,2,opt,name=num_next_chunks,json=numNextChunks,proto3" json:"num_next_chunks,omitempty"`
	// contains filtered or unexported fields
}

Specifies the chunk spec to be returned from the search response. Only available if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]

func (*SearchRequest_ContentSearchSpec_ChunkSpec) Descriptor deprecated added in v1.10.0 

func (*SearchRequest_ContentSearchSpec_ChunkSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_ChunkSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks() int32

func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks() int32

func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoMessage added in v1.10.0 

func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoReflect added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_ChunkSpec) Reset added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) Reset()

func (*SearchRequest_ContentSearchSpec_ChunkSpec) String added in v1.10.0 

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) String() string

type SearchRequest_ContentSearchSpec_ExtractiveContentSpec added in v0.5.0 

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.v1beta.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.v1beta.DataStore] is set to
	// [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED]
	// or
	// [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.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. This feature is available only for new
	// or allowlisted data stores. To allowlist your data store,
	// contact your Customer Engineer. The default value is `false`.
	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 added in v0.5.0 

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_ExtractiveContentSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments added in v1.2.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments added in v1.2.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore added in v1.2.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore() bool

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage added in v0.5.0 

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset()

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String added in v0.5.0 

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String() string

type SearchRequest_ContentSearchSpec_SearchResultMode added in v1.10.0 

type SearchRequest_ContentSearchSpec_SearchResultMode int32

Specifies the search result mode. If unspecified, the search result mode 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.10.0 

func (SearchRequest_ContentSearchSpec_SearchResultMode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_ContentSearchSpec_SearchResultMode) Enum added in v1.10.0 

func (x SearchRequest_ContentSearchSpec_SearchResultMode) Enum() *SearchRequest_ContentSearchSpec_SearchResultMode

func (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor deprecated added in v1.10.0 

func (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SearchResultMode.Descriptor instead.

func (SearchRequest_ContentSearchSpec_SearchResultMode) Number added in v1.10.0 

func (x SearchRequest_ContentSearchSpec_SearchResultMode) Number() protoreflect.EnumNumber

func (SearchRequest_ContentSearchSpec_SearchResultMode) String added in v1.10.0 

func (x SearchRequest_ContentSearchSpec_SearchResultMode) String() string

func (SearchRequest_ContentSearchSpec_SearchResultMode) Type added in v1.10.0 

func (SearchRequest_ContentSearchSpec_SearchResultMode) Type() protoreflect.EnumType

type SearchRequest_ContentSearchSpec_SnippetSpec added in v0.3.0 

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/v1beta/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/v1beta/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 added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SnippetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount deprecated added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount() int32

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/search_service.proto.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly deprecated added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() bool

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/search_service.proto.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet added in v1.1.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet() bool

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) Reset()

func (*SearchRequest_ContentSearchSpec_SnippetSpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) String() string

type SearchRequest_ContentSearchSpec_SummarySpec added in v0.3.0 

type SearchRequest_ContentSearchSpec_SummarySpec struct {

	// The number of top results 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 for documents mode, or 50 for chunks mode, can be
	// used to generate a summary. The chunks mode is used when
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
	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 */
	// Specifies whether to filter out queries that have low relevance. The
	// default value is `false`.
	//
	// If this field is set to `false`, all search results are used regardless
	// of relevance to generate answers. If set to `true`, only queries with
	// high relevance search results will generate answers.
	IgnoreLowRelevantContent bool `` /* 138-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"`
	// If true, answer will be generated from most relevant chunks from top
	// search results. This feature will improve summary quality.
	// Note that with this feature enabled, not all top search results
	// will be referenced and included in the reference list, so the citation
	// source index only points to the search results listed in the reference
	// list.
	UseSemanticChunks bool `protobuf:"varint,8,opt,name=use_semantic_chunks,json=useSemanticChunks,proto3" json:"use_semantic_chunks,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring a summary returned in a search response.

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery added in v1.1.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent added in v1.14.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery added in v1.1.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations added in v1.1.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode added in v1.2.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode() string

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount() int32

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks added in v1.7.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SummarySpec) Reset added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) Reset()

func (*SearchRequest_ContentSearchSpec_SummarySpec) String added in v0.3.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec) String() string

type SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec added in v1.5.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.5.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble() string

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage added in v1.5.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset()

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String() string

type SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec added in v1.5.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 model. For more information, see
	//     [Answer generation model versions and
	//     lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
	//   - `preview`: string. (Public preview) Uses a preview model. For more
	//     information, see
	//     [Answer generation model versions and
	//     lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
	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.5.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion() string

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage added in v1.5.0 

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset()

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String added in v1.5.0 

func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String() string

type SearchRequest_DataStoreSpec added in v1.6.0 

type SearchRequest_DataStoreSpec struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1beta.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 and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.

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 (x *SearchRequest_DataStoreSpec) ProtoReflect() protoreflect.Message

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 added in v1.2.0 

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 added in v1.2.0 

func (*SearchRequest_EmbeddingSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_EmbeddingSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_EmbeddingSpec) GetEmbeddingVectors added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec) GetEmbeddingVectors() []*SearchRequest_EmbeddingSpec_EmbeddingVector

func (*SearchRequest_EmbeddingSpec) ProtoMessage added in v1.2.0 

func (*SearchRequest_EmbeddingSpec) ProtoMessage()

func (*SearchRequest_EmbeddingSpec) ProtoReflect added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_EmbeddingSpec) Reset added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec) Reset()

func (*SearchRequest_EmbeddingSpec) String added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec) String() string

type SearchRequest_EmbeddingSpec_EmbeddingVector added in v1.2.0 

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 added in v1.2.0 

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_EmbeddingSpec_EmbeddingVector.ProtoReflect.Descriptor instead.

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath() string

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector() []float32

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage added in v1.2.0 

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage()

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect() protoreflect.Message

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Reset added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) Reset()

func (*SearchRequest_EmbeddingSpec_EmbeddingVector) String added in v1.2.0 

func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) String() string

type SearchRequest_FacetSpec added in v0.3.0 

type SearchRequest_FacetSpec struct {

	// Required. The facet key specification.
	FacetKey *SearchRequest_FacetSpec_FacetKey `protobuf:"bytes,1,opt,name=facet_key,json=facetKey,proto3" json:"facet_key,omitempty"`
	// Maximum facet values that are returned for this facet. If
	// unspecified, defaults to 20. The maximum allowed value is 300. Values
	// above 300 are coerced to 300.
	// For aggregation in healthcare search, when the [FacetKey.key] is
	// "healthcare_aggregation_key", the limit will be overridden to
	// 10,000 internally, regardless of the value set here.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// List of keys to exclude when faceting.
	//
	// By default,
	// [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key]
	// is not excluded from the filter unless it is listed in this field.
	//
	// Listing a facet key in this field allows its values to appear as facet
	// results, even when they are filtered out of search results. Using this
	// field does not affect what search results are returned.
	//
	// For example, suppose there are 100 documents with the color facet "Red"
	// and 200 documents with the color facet "Blue". A query containing the
	// filter "color:ANY("Red")" and having "color" as
	// [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key]
	// would by default return only "Red" documents in the search results, and
	// also return "Red" with count 100 as the only color facet. Although there
	// are also blue documents available, "Blue" would not be shown as an
	// available facet value.
	//
	// If "color" is listed in "excludedFilterKeys", then the query returns the
	// facet values "Red" with count 100 and "Blue" with count 200, because the
	// "color" key is now excluded from the filter. Because this field doesn't
	// affect search results, the search results are still correctly filtered to
	// return only "Red" documents.
	//
	// A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
	// error is returned.
	ExcludedFilterKeys []string `protobuf:"bytes,3,rep,name=excluded_filter_keys,json=excludedFilterKeys,proto3" json:"excluded_filter_keys,omitempty"`
	// Enables dynamic position for this facet. If set to true, the position of
	// this facet among all facets in the response is determined automatically.
	// 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 added in v0.3.0 

func (*SearchRequest_FacetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec) GetEnableDynamicPosition added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() bool

func (*SearchRequest_FacetSpec) GetExcludedFilterKeys added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetExcludedFilterKeys() []string

func (*SearchRequest_FacetSpec) GetFacetKey added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetFacetKey() *SearchRequest_FacetSpec_FacetKey

func (*SearchRequest_FacetSpec) GetLimit added in v0.3.0 

func (x *SearchRequest_FacetSpec) GetLimit() int32

func (*SearchRequest_FacetSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_FacetSpec) ProtoMessage()

func (*SearchRequest_FacetSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_FacetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec) Reset added in v0.3.0 

func (x *SearchRequest_FacetSpec) Reset()

func (*SearchRequest_FacetSpec) String added in v0.3.0 

func (x *SearchRequest_FacetSpec) String() string

type SearchRequest_FacetSpec_FacetKey added in v0.3.0 

type SearchRequest_FacetSpec_FacetKey struct {

	// Required. Supported textual and numerical facet keys in
	// [Document][google.cloud.discoveryengine.v1beta.Document] object, over
	// which the facet values are computed. Facet key is case-sensitive.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Set only if values should be 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 contain 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.v1beta.SearchResponse.Facet.FacetValue.count]
	// descending.
	//
	// * "value desc", which means order by
	// [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.value]
	// descending.
	//
	//	Only applies to textual facets.
	//
	// If not set, textual values are sorted in [natural
	// order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
	// intervals are sorted in the order given by
	// [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
	OrderBy string `protobuf:"bytes,7,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Specifies how a facet is computed.

func (*SearchRequest_FacetSpec_FacetKey) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_FacetSpec_FacetKey) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() bool

func (*SearchRequest_FacetSpec_FacetKey) GetContains added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetContains() []string

func (*SearchRequest_FacetSpec_FacetKey) GetIntervals added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetIntervals() []*Interval

func (*SearchRequest_FacetSpec_FacetKey) GetKey added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetKey() string

func (*SearchRequest_FacetSpec_FacetKey) GetOrderBy added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string

func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetPrefixes() []string

func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) GetRestrictedValues() []string

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage added in v0.3.0 

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()

func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec_FacetKey) Reset added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) Reset()

func (*SearchRequest_FacetSpec_FacetKey) String added in v0.3.0 

func (x *SearchRequest_FacetSpec_FacetKey) String() string

type SearchRequest_ImageQuery added in v1.1.0 

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 added in v1.1.0 

func (*SearchRequest_ImageQuery) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_ImageQuery.ProtoReflect.Descriptor instead.

func (*SearchRequest_ImageQuery) GetImage added in v1.1.0 

func (m *SearchRequest_ImageQuery) GetImage() isSearchRequest_ImageQuery_Image

func (*SearchRequest_ImageQuery) GetImageBytes added in v1.1.0 

func (x *SearchRequest_ImageQuery) GetImageBytes() string

func (*SearchRequest_ImageQuery) ProtoMessage added in v1.1.0 

func (*SearchRequest_ImageQuery) ProtoMessage()

func (*SearchRequest_ImageQuery) ProtoReflect added in v1.1.0 

func (x *SearchRequest_ImageQuery) ProtoReflect() protoreflect.Message

func (*SearchRequest_ImageQuery) Reset added in v1.1.0 

func (x *SearchRequest_ImageQuery) Reset()

func (*SearchRequest_ImageQuery) String added in v1.1.0 

func (x *SearchRequest_ImageQuery) String() string

type SearchRequest_ImageQuery_ImageBytes added in v1.1.0 

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_NaturalLanguageQueryUnderstandingSpec added in v1.11.0 

type SearchRequest_NaturalLanguageQueryUnderstandingSpec struct {

	// The condition under which filter extraction should occur.
	// Default to [Condition.DISABLED][].
	FilterExtractionCondition SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition `` /* 258-byte string literal not displayed */
	// Field names used for location-based filtering, where geolocation filters
	// are detected in natural language search queries.
	// Only valid when the FilterExtractionCondition is set to `ENABLED`.
	//
	// If this field is set, it overrides the field names set in
	// [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names].
	GeoSearchQueryDetectionFieldNames []string `` /* 168-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specification to enable natural language understanding capabilities for search requests.

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Descriptor deprecated added in v1.11.0 

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_NaturalLanguageQueryUnderstandingSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetFilterExtractionCondition added in v1.11.0 

func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetFilterExtractionCondition() SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetGeoSearchQueryDetectionFieldNames added in v1.11.0 

func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetGeoSearchQueryDetectionFieldNames() []string

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoMessage added in v1.11.0 

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoMessage()

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoReflect added in v1.11.0 

func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Reset added in v1.11.0 

func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) Reset()

func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) String added in v1.11.0 

func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) String() string

type SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition added in v1.11.0 

type SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition int32

Enum describing under which condition filter extraction should occur. 

const (
	// Server behavior defaults to [Condition.DISABLED][].
	SearchRequest_NaturalLanguageQueryUnderstandingSpec_CONDITION_UNSPECIFIED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 0
	// Disables NL filter extraction.
	SearchRequest_NaturalLanguageQueryUnderstandingSpec_DISABLED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 1
	// Enables NL filter extraction.
	SearchRequest_NaturalLanguageQueryUnderstandingSpec_ENABLED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 2
)

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Descriptor added in v1.11.0 

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Enum added in v1.11.0 

func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Enum() *SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) EnumDescriptor deprecated added in v1.11.0 

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition.Descriptor instead.

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Number added in v1.11.0 

func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Number() protoreflect.EnumNumber

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) String added in v1.11.0 

func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) String() string

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Type added in v1.11.0 

func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Type() protoreflect.EnumType

type SearchRequest_QueryExpansionSpec added in v0.3.0 

type SearchRequest_QueryExpansionSpec struct {

	// The condition under which query expansion should occur. Default to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	Condition SearchRequest_QueryExpansionSpec_Condition `` /* 156-byte string literal not displayed */
	// 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 added in v0.3.0 

func (*SearchRequest_QueryExpansionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_QueryExpansionSpec) GetCondition added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) GetCondition() SearchRequest_QueryExpansionSpec_Condition

func (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults added in v1.2.0 

func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() bool

func (*SearchRequest_QueryExpansionSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_QueryExpansionSpec) ProtoMessage()

func (*SearchRequest_QueryExpansionSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_QueryExpansionSpec) Reset added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) Reset()

func (*SearchRequest_QueryExpansionSpec) String added in v0.3.0 

func (x *SearchRequest_QueryExpansionSpec) String() string

type SearchRequest_QueryExpansionSpec_Condition added in v0.3.0 

type SearchRequest_QueryExpansionSpec_Condition int32

Enum describing under which condition query expansion should occur. 

const (
	// Unspecified query expansion condition. In this case, server behavior
	// defaults to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED SearchRequest_QueryExpansionSpec_Condition = 0
	// Disabled query expansion. Only the exact search query is used, even if
	// [SearchResponse.total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size]
	// is zero.
	SearchRequest_QueryExpansionSpec_DISABLED SearchRequest_QueryExpansionSpec_Condition = 1
	// Automatic query expansion built by the Search API.
	SearchRequest_QueryExpansionSpec_AUTO SearchRequest_QueryExpansionSpec_Condition = 2
)

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_QueryExpansionSpec_Condition) Enum added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) Enum() *SearchRequest_QueryExpansionSpec_Condition

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor deprecated added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.

func (SearchRequest_QueryExpansionSpec_Condition) Number added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) Number() protoreflect.EnumNumber

func (SearchRequest_QueryExpansionSpec_Condition) String added in v0.3.0 

func (x SearchRequest_QueryExpansionSpec_Condition) String() string

func (SearchRequest_QueryExpansionSpec_Condition) Type added in v0.3.0 

func (SearchRequest_QueryExpansionSpec_Condition) Type() protoreflect.EnumType

type SearchRequest_RelevanceThreshold added in v1.14.0 

type SearchRequest_RelevanceThreshold int32

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned. 

const (
	// Default value. In this case, server behavior defaults to Google defined
	// threshold.
	SearchRequest_RELEVANCE_THRESHOLD_UNSPECIFIED SearchRequest_RelevanceThreshold = 0
	// Lowest relevance threshold.
	SearchRequest_LOWEST SearchRequest_RelevanceThreshold = 1
	// Low relevance threshold.
	SearchRequest_LOW SearchRequest_RelevanceThreshold = 2
	// Medium relevance threshold.
	SearchRequest_MEDIUM SearchRequest_RelevanceThreshold = 3
	// High relevance threshold.
	SearchRequest_HIGH SearchRequest_RelevanceThreshold = 4
)

func (SearchRequest_RelevanceThreshold) Descriptor added in v1.14.0 

func (SearchRequest_RelevanceThreshold) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_RelevanceThreshold) Enum added in v1.14.0 

func (x SearchRequest_RelevanceThreshold) Enum() *SearchRequest_RelevanceThreshold

func (SearchRequest_RelevanceThreshold) EnumDescriptor deprecated added in v1.14.0 

func (SearchRequest_RelevanceThreshold) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_RelevanceThreshold.Descriptor instead.

func (SearchRequest_RelevanceThreshold) Number added in v1.14.0 

func (x SearchRequest_RelevanceThreshold) Number() protoreflect.EnumNumber

func (SearchRequest_RelevanceThreshold) String added in v1.14.0 

func (x SearchRequest_RelevanceThreshold) String() string

func (SearchRequest_RelevanceThreshold) Type added in v1.14.0 

func (SearchRequest_RelevanceThreshold) Type() protoreflect.EnumType

type SearchRequest_SearchAsYouTypeSpec added in v1.11.0 

type SearchRequest_SearchAsYouTypeSpec struct {

	// The condition under which search as you type should occur.
	// Default to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
	Condition SearchRequest_SearchAsYouTypeSpec_Condition `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specification for search as you type in search requests.

func (*SearchRequest_SearchAsYouTypeSpec) Descriptor deprecated added in v1.11.0 

func (*SearchRequest_SearchAsYouTypeSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SearchAsYouTypeSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SearchAsYouTypeSpec) GetCondition added in v1.11.0 

func (x *SearchRequest_SearchAsYouTypeSpec) GetCondition() SearchRequest_SearchAsYouTypeSpec_Condition

func (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage added in v1.11.0 

func (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage()

func (*SearchRequest_SearchAsYouTypeSpec) ProtoReflect added in v1.11.0 

func (x *SearchRequest_SearchAsYouTypeSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_SearchAsYouTypeSpec) Reset added in v1.11.0 

func (x *SearchRequest_SearchAsYouTypeSpec) Reset()

func (*SearchRequest_SearchAsYouTypeSpec) String added in v1.11.0 

func (x *SearchRequest_SearchAsYouTypeSpec) String() string

type SearchRequest_SearchAsYouTypeSpec_Condition added in v1.11.0 

type SearchRequest_SearchAsYouTypeSpec_Condition int32

Enum describing under which condition search as you type should occur. 

const (
	// Server behavior defaults to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
	SearchRequest_SearchAsYouTypeSpec_CONDITION_UNSPECIFIED SearchRequest_SearchAsYouTypeSpec_Condition = 0
	// Disables Search As You Type.
	SearchRequest_SearchAsYouTypeSpec_DISABLED SearchRequest_SearchAsYouTypeSpec_Condition = 1
	// Enables Search As You Type.
	SearchRequest_SearchAsYouTypeSpec_ENABLED SearchRequest_SearchAsYouTypeSpec_Condition = 2
)

func (SearchRequest_SearchAsYouTypeSpec_Condition) Descriptor added in v1.11.0 

func (SearchRequest_SearchAsYouTypeSpec_Condition) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_SearchAsYouTypeSpec_Condition) Enum added in v1.11.0 

func (x SearchRequest_SearchAsYouTypeSpec_Condition) Enum() *SearchRequest_SearchAsYouTypeSpec_Condition

func (SearchRequest_SearchAsYouTypeSpec_Condition) EnumDescriptor deprecated added in v1.11.0 

func (SearchRequest_SearchAsYouTypeSpec_Condition) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SearchAsYouTypeSpec_Condition.Descriptor instead.

func (SearchRequest_SearchAsYouTypeSpec_Condition) Number added in v1.11.0 

func (x SearchRequest_SearchAsYouTypeSpec_Condition) Number() protoreflect.EnumNumber

func (SearchRequest_SearchAsYouTypeSpec_Condition) String added in v1.11.0 

func (x SearchRequest_SearchAsYouTypeSpec_Condition) String() string

func (SearchRequest_SearchAsYouTypeSpec_Condition) Type added in v1.11.0 

func (SearchRequest_SearchAsYouTypeSpec_Condition) Type() protoreflect.EnumType

type SearchRequest_SessionSpec added in v1.11.0 

type SearchRequest_SessionSpec struct {

	// If set, the search result gets stored to the "turn" specified by this
	// query ID.
	//
	// Example: Let's say the session looks like this:
	//
	//	session {
	//	  name: ".../sessions/xxx"
	//	  turns {
	//	    query { text: "What is foo?" query_id: ".../questions/yyy" }
	//	    answer: "Foo is ..."
	//	  }
	//	  turns {
	//	    query { text: "How about bar then?" query_id: ".../questions/zzz" }
	//	  }
	//	}
	//
	// The user can call /search API with a request like this:
	//
	//	session: ".../sessions/xxx"
	//	session_spec { query_id: ".../questions/zzz" }
	//
	// Then, the API stores the search result, associated with the last turn.
	// The stored search result can be used by a subsequent /answer API call
	// (with the session ID and the query ID specified). Also, it is possible
	// to call /search and /answer in parallel with the same session ID & query
	// ID.
	QueryId string `protobuf:"bytes,1,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
	// The number of top search results to persist. The persisted search results
	// can be used for the subsequent /answer api call.
	//
	// This field is simliar to the `summary_result_count` field in
	// [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].
	//
	// At most 10 results for documents mode, or 50 for chunks mode.
	SearchResultPersistenceCount *int32 `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

Session specification.

Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

func (*SearchRequest_SessionSpec) Descriptor deprecated added in v1.11.0 

func (*SearchRequest_SessionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SessionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SessionSpec) GetQueryId added in v1.11.0 

func (x *SearchRequest_SessionSpec) GetQueryId() string

func (*SearchRequest_SessionSpec) GetSearchResultPersistenceCount added in v1.11.0 

func (x *SearchRequest_SessionSpec) GetSearchResultPersistenceCount() int32

func (*SearchRequest_SessionSpec) ProtoMessage added in v1.11.0 

func (*SearchRequest_SessionSpec) ProtoMessage()

func (*SearchRequest_SessionSpec) ProtoReflect added in v1.11.0 

func (x *SearchRequest_SessionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_SessionSpec) Reset added in v1.11.0 

func (x *SearchRequest_SessionSpec) Reset()

func (*SearchRequest_SessionSpec) String added in v1.11.0 

func (x *SearchRequest_SessionSpec) String() string

type SearchRequest_SpellCorrectionSpec added in v0.3.0 

type SearchRequest_SpellCorrectionSpec struct {

	// The mode under which spell correction
	// replaces the original search query. Defaults to
	// [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	Mode SearchRequest_SpellCorrectionSpec_Mode `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

The specification for query spell correction.

func (*SearchRequest_SpellCorrectionSpec) Descriptor deprecated added in v0.3.0 

func (*SearchRequest_SpellCorrectionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SpellCorrectionSpec) GetMode added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) GetMode() SearchRequest_SpellCorrectionSpec_Mode

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage added in v0.3.0 

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()

func (*SearchRequest_SpellCorrectionSpec) ProtoReflect added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_SpellCorrectionSpec) Reset added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) Reset()

func (*SearchRequest_SpellCorrectionSpec) String added in v0.3.0 

func (x *SearchRequest_SpellCorrectionSpec) String() string

type SearchRequest_SpellCorrectionSpec_Mode added in v0.3.0 

type SearchRequest_SpellCorrectionSpec_Mode int32

Enum describing under which mode spell correction should occur. 

const (
	// Unspecified spell correction mode. In this case, server behavior
	// defaults to
	// [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
	// Search API tries to find a spelling suggestion. If a suggestion is
	// found, it is put in the
	// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query].
	// The spelling suggestion won't be used as the search query.
	SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
	// Automatic spell correction built by the Search API. Search will
	// be based on the corrected query if found.
	SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_SpellCorrectionSpec_Mode) Enum added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) Enum() *SearchRequest_SpellCorrectionSpec_Mode

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor deprecated added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.

func (SearchRequest_SpellCorrectionSpec_Mode) Number added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) Number() protoreflect.EnumNumber

func (SearchRequest_SpellCorrectionSpec_Mode) String added in v0.3.0 

func (x SearchRequest_SpellCorrectionSpec_Mode) String() string

func (SearchRequest_SpellCorrectionSpec_Mode) Type added in v0.3.0 

func (SearchRequest_SpellCorrectionSpec_Mode) Type() protoreflect.EnumType

type SearchResponse added in v0.3.0 

type SearchResponse struct {

	// A list of matched documents. The order represents the ranking.
	Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// Results of facets requested by user.
	Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`
	// Guided search result.
	GuidedSearchResult *SearchResponse_GuidedSearchResult `protobuf:"bytes,8,opt,name=guided_search_result,json=guidedSearchResult,proto3" json:"guided_search_result,omitempty"`
	// The estimated total count of matched items irrespective of pagination. The
	// count of
	// [results][google.cloud.discoveryengine.v1beta.SearchResponse.results]
	// returned by pagination may be less than the
	// [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size]
	// that matches.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// A unique search token. This should be included in the
	// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
	// from this search, which enables accurate attribution of search model
	// performance. This also helps to identify a request during the customer
	// support scenarios.
	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.v1beta.SearchResponse.redirect_uri]
	// and
	// [attribution_token][google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,5,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Contains the spell corrected query, if found. If the spell correction type
	// is AUTOMATIC, then the search results are based on corrected_query.
	// Otherwise the original query is used for search.
	CorrectedQuery string `protobuf:"bytes,7,opt,name=corrected_query,json=correctedQuery,proto3" json:"corrected_query,omitempty"`
	// A summary as part of the search results.
	// This field is only returned if
	// [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec]
	// is set.
	Summary *SearchResponse_Summary `protobuf:"bytes,9,opt,name=summary,proto3" json:"summary,omitempty"`
	// Controls applied as part of the Control service.
	AppliedControls    []string                             `protobuf:"bytes,10,rep,name=applied_controls,json=appliedControls,proto3" json:"applied_controls,omitempty"`
	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"`
	// Natural language query understanding information for the returned results.
	NaturalLanguageQueryUnderstandingInfo *SearchResponse_NaturalLanguageQueryUnderstandingInfo `` /* 179-byte string literal not displayed */
	// Session information.
	//
	// Only set if
	// [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session]
	// is provided. See its description for more details.
	SessionInfo *SearchResponse_SessionInfo `protobuf:"bytes,19,opt,name=session_info,json=sessionInfo,proto3" json:"session_info,omitempty"`
	// A list of One Box results. There can be multiple One Box results of
	// different types.
	OneBoxResults []*SearchResponse_OneBoxResult `protobuf:"bytes,20,rep,name=one_box_results,json=oneBoxResults,proto3" json:"one_box_results,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.

func (*SearchResponse) Descriptor deprecated added in v0.3.0 

func (*SearchResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetAppliedControls added in v0.3.0 

func (x *SearchResponse) GetAppliedControls() []string

func (*SearchResponse) GetAttributionToken added in v0.3.0 

func (x *SearchResponse) GetAttributionToken() string

func (*SearchResponse) GetCorrectedQuery added in v0.3.0 

func (x *SearchResponse) GetCorrectedQuery() string

func (*SearchResponse) GetFacets added in v0.3.0 

func (x *SearchResponse) GetFacets() []*SearchResponse_Facet

func (*SearchResponse) GetGeoSearchDebugInfo added in v1.7.0 

func (x *SearchResponse) GetGeoSearchDebugInfo() []*SearchResponse_GeoSearchDebugInfo

func (*SearchResponse) GetGuidedSearchResult added in v0.3.0 

func (x *SearchResponse) GetGuidedSearchResult() *SearchResponse_GuidedSearchResult

func (*SearchResponse) GetNaturalLanguageQueryUnderstandingInfo added in v1.11.0 

func (x *SearchResponse) GetNaturalLanguageQueryUnderstandingInfo() *SearchResponse_NaturalLanguageQueryUnderstandingInfo

func (*SearchResponse) GetNextPageToken added in v0.3.0 

func (x *SearchResponse) GetNextPageToken() string

func (*SearchResponse) GetOneBoxResults added in v1.14.0 

func (x *SearchResponse) GetOneBoxResults() []*SearchResponse_OneBoxResult

func (*SearchResponse) GetQueryExpansionInfo added in v1.2.0 

func (x *SearchResponse) GetQueryExpansionInfo() *SearchResponse_QueryExpansionInfo

func (*SearchResponse) GetRedirectUri added in v0.5.0 

func (x *SearchResponse) GetRedirectUri() string

func (*SearchResponse) GetResults added in v0.3.0 

func (x *SearchResponse) GetResults() []*SearchResponse_SearchResult

func (*SearchResponse) GetSessionInfo added in v1.11.0 

func (x *SearchResponse) GetSessionInfo() *SearchResponse_SessionInfo

func (*SearchResponse) GetSummary added in v0.3.0 

func (x *SearchResponse) GetSummary() *SearchResponse_Summary

func (*SearchResponse) GetTotalSize added in v0.3.0 

func (x *SearchResponse) GetTotalSize() int32

func (*SearchResponse) ProtoMessage added in v0.3.0 

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect added in v0.3.0 

func (x *SearchResponse) ProtoReflect() protoreflect.Message

func (*SearchResponse) Reset added in v0.3.0 

func (x *SearchResponse) Reset()

func (*SearchResponse) String added in v0.3.0 

func (x *SearchResponse) String() string

type SearchResponse_Facet added in v0.3.0 

type SearchResponse_Facet struct {

	// The key for this facet. For example, `"colors"` or `"price"`. It matches
	// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key].
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The facet values for this field.
	Values []*SearchResponse_Facet_FacetValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// Whether the facet is dynamically generated.
	DynamicFacet bool `protobuf:"varint,3,opt,name=dynamic_facet,json=dynamicFacet,proto3" json:"dynamic_facet,omitempty"`
	// contains filtered or unexported fields
}

A facet result.

func (*SearchResponse_Facet) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Facet) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet) GetDynamicFacet added in v0.3.0 

func (x *SearchResponse_Facet) GetDynamicFacet() bool

func (*SearchResponse_Facet) GetKey added in v0.3.0 

func (x *SearchResponse_Facet) GetKey() string

func (*SearchResponse_Facet) GetValues added in v0.3.0 

func (x *SearchResponse_Facet) GetValues() []*SearchResponse_Facet_FacetValue

func (*SearchResponse_Facet) ProtoMessage added in v0.3.0 

func (*SearchResponse_Facet) ProtoMessage()

func (*SearchResponse_Facet) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Facet) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet) Reset added in v0.3.0 

func (x *SearchResponse_Facet) Reset()

func (*SearchResponse_Facet) String added in v0.3.0 

func (x *SearchResponse_Facet) String() string

type SearchResponse_Facet_FacetValue added in v0.3.0 

type SearchResponse_Facet_FacetValue struct {

	// A facet value which contains values.
	//
	// Types that are assignable to FacetValue:
	//
	//	*SearchResponse_Facet_FacetValue_Value
	//	*SearchResponse_Facet_FacetValue_Interval
	FacetValue isSearchResponse_Facet_FacetValue_FacetValue `protobuf_oneof:"facet_value"`
	// Number of items that have this facet value.
	Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

A facet value which contains value names and their count.

func (*SearchResponse_Facet_FacetValue) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Facet_FacetValue) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet_FacetValue) GetCount added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetCount() int64

func (*SearchResponse_Facet_FacetValue) GetFacetValue added in v0.3.0 

func (m *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValue

func (*SearchResponse_Facet_FacetValue) GetInterval added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetInterval() *Interval

func (*SearchResponse_Facet_FacetValue) GetValue added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) GetValue() string

func (*SearchResponse_Facet_FacetValue) ProtoMessage added in v0.3.0 

func (*SearchResponse_Facet_FacetValue) ProtoMessage()

func (*SearchResponse_Facet_FacetValue) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet_FacetValue) Reset added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) Reset()

func (*SearchResponse_Facet_FacetValue) String added in v0.3.0 

func (x *SearchResponse_Facet_FacetValue) String() string

type SearchResponse_Facet_FacetValue_Interval added in v0.3.0 

type SearchResponse_Facet_FacetValue_Interval struct {
	// Interval value for a facet, such as [10, 20) for facet "price". It
	// matches
	// [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
	Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}

type SearchResponse_Facet_FacetValue_Value added in v0.3.0 

type SearchResponse_Facet_FacetValue_Value struct {
	// Text value of a facet, such as "Black" for facet "colors".
	Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

type SearchResponse_GeoSearchDebugInfo added in v1.7.0 

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 added in v1.7.0 

func (*SearchResponse_GeoSearchDebugInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_GeoSearchDebugInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_GeoSearchDebugInfo) GetErrorMessage added in v1.7.0 

func (x *SearchResponse_GeoSearchDebugInfo) GetErrorMessage() string

func (*SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery added in v1.7.0 

func (x *SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery() string

func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage added in v1.7.0 

func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage()

func (*SearchResponse_GeoSearchDebugInfo) ProtoReflect added in v1.7.0 

func (x *SearchResponse_GeoSearchDebugInfo) ProtoReflect() protoreflect.Message

func (*SearchResponse_GeoSearchDebugInfo) Reset added in v1.7.0 

func (x *SearchResponse_GeoSearchDebugInfo) Reset()

func (*SearchResponse_GeoSearchDebugInfo) String added in v1.7.0 

func (x *SearchResponse_GeoSearchDebugInfo) String() string

type SearchResponse_GuidedSearchResult added in v0.3.0 

type SearchResponse_GuidedSearchResult struct {

	// A list of ranked refinement attributes.
	RefinementAttributes []*SearchResponse_GuidedSearchResult_RefinementAttribute `protobuf:"bytes,1,rep,name=refinement_attributes,json=refinementAttributes,proto3" json:"refinement_attributes,omitempty"`
	// 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 added in v0.3.0 

func (*SearchResponse_GuidedSearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_GuidedSearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult) GetFollowUpQuestions added in v1.1.0 

func (x *SearchResponse_GuidedSearchResult) GetFollowUpQuestions() []string

func (*SearchResponse_GuidedSearchResult) GetRefinementAttributes added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) GetRefinementAttributes() []*SearchResponse_GuidedSearchResult_RefinementAttribute

func (*SearchResponse_GuidedSearchResult) ProtoMessage added in v0.3.0 

func (*SearchResponse_GuidedSearchResult) ProtoMessage()

func (*SearchResponse_GuidedSearchResult) ProtoReflect added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_GuidedSearchResult) Reset added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) Reset()

func (*SearchResponse_GuidedSearchResult) String added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult) String() string

type SearchResponse_GuidedSearchResult_RefinementAttribute added in v0.3.0 

type SearchResponse_GuidedSearchResult_RefinementAttribute struct {

	// Attribute key used to refine the results. For example, `"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. For example, `"drama"`.
	AttributeValue string `protobuf:"bytes,2,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
	// contains filtered or unexported fields
}

Useful attribute for search result refinements.

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_GuidedSearchResult_RefinementAttribute.ProtoReflect.Descriptor instead.

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey() string

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue() string

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage added in v0.3.0 

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage()

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect() protoreflect.Message

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Reset added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) Reset()

func (*SearchResponse_GuidedSearchResult_RefinementAttribute) String added in v0.3.0 

func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo struct {

	// The filters that were extracted from the input query.
	ExtractedFilters string `protobuf:"bytes,1,opt,name=extracted_filters,json=extractedFilters,proto3" json:"extracted_filters,omitempty"`
	// Rewritten input query minus the extracted filters.
	RewrittenQuery string `protobuf:"bytes,2,opt,name=rewritten_query,json=rewrittenQuery,proto3" json:"rewritten_query,omitempty"`
	// The filters that were extracted from the input query represented in a
	// structured form.
	StructuredExtractedFilter *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

Information describing what natural language understanding was done on the input query.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetExtractedFilters added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetExtractedFilters() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetRewrittenQuery added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetRewrittenQuery() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetStructuredExtractedFilter added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetStructuredExtractedFilter() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter struct {

	// The expression denoting the filter that was extracted from the input
	// query in a structured form. It can be a simple expression denoting a
	// single string, numerical or geolocation constraint or a compound
	// expression which is a combination of multiple expressions connected
	// using logical (OR and AND) operators.
	Expression *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
	// contains filtered or unexported fields
}

The filters that were extracted from the input query represented in a structured form.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) GetExpression added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) GetExpression() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression struct {

	// The expressions that were ANDed together.
	Expressions []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

Logical `And` operator.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) GetExpressions added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) GetExpressions() []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression struct {

	// The expression type.
	//
	// Types that are assignable to Expr:
	//
	//	*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint
	//	*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint
	//	*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint
	//	*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr
	//	*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr
	Expr isSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

The expression denoting the filter that was extracted from the input query.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetAndExpr added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetAndExpr() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetExpr added in v1.11.0 

func (m *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetExpr() isSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_Expr

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetGeolocationConstraint added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetGeolocationConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetNumberConstraint added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetNumberConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetOrExpr added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetOrExpr() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetStringConstraint added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetStringConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr struct {
	// Logical "And" compound operator connecting multiple expressions.
	AndExpr *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression `protobuf:"bytes,4,opt,name=and_expr,json=andExpr,proto3,oneof"`
}

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint struct {
	// Geolocation constraint expression.
	GeolocationConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint `protobuf:"bytes,3,opt,name=geolocation_constraint,json=geolocationConstraint,proto3,oneof"`
}

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint struct {
	// Numerical constraint expression.
	NumberConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint `protobuf:"bytes,2,opt,name=number_constraint,json=numberConstraint,proto3,oneof"`
}

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr struct {
	// Logical "Or" compound operator connecting multiple expressions.
	OrExpr *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression `protobuf:"bytes,5,opt,name=or_expr,json=orExpr,proto3,oneof"`
}

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint struct {
	// String constraint expression.
	StringConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint `protobuf:"bytes,1,opt,name=string_constraint,json=stringConstraint,proto3,oneof"`
}

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint struct {

	// The name of the geolocation field as defined in the schema.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The reference address that was inferred from the input query. The
	// proximity of the reference address to the geolocation field will be
	// used to filter the results.
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// The latitude of the geolocation inferred from the input query.
	Latitude float64 `protobuf:"fixed64,4,opt,name=latitude,proto3" json:"latitude,omitempty"`
	// The longitude of the geolocation inferred from the input query.
	Longitude float64 `protobuf:"fixed64,5,opt,name=longitude,proto3" json:"longitude,omitempty"`
	// The radius in meters around the address. The record is returned if
	// the location of the geolocation field is within the radius.
	RadiusInMeters float32 `protobuf:"fixed32,3,opt,name=radius_in_meters,json=radiusInMeters,proto3" json:"radius_in_meters,omitempty"`
	// contains filtered or unexported fields
}

Constraint of a geolocation field. Name of the geolocation field as defined in the schema.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetAddress added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetAddress() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetFieldName added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetFieldName() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLatitude added in v1.14.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLatitude() float64

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLongitude added in v1.14.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLongitude() float64

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetRadiusInMeters added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetRadiusInMeters() float32

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint struct {

	// Name of the numerical field as defined in the schema.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The comparison operation performed between the field value and the
	// value specified in the constraint.
	Comparison SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison `` /* 222-byte string literal not displayed */
	// The value specified in the numerical constraint.
	Value float64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
	// Identifies the keywords within the search query that match a filter.
	QuerySegment string `protobuf:"bytes,4,opt,name=query_segment,json=querySegment,proto3" json:"query_segment,omitempty"`
	// contains filtered or unexported fields
}

Constraint expression of a number field. Example: price < 100.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetComparison added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetComparison() SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetFieldName added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetFieldName() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetQuerySegment added in v1.14.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetQuerySegment() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetValue added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetValue() float64

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison int32

The comparison operation that was performed. 

const (
	// Undefined comparison operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_COMPARISON_UNSPECIFIED SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 0
	// Denotes equality `=` operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_EQUALS SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 1
	// Denotes less than or equal to `<=` operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_LESS_THAN_EQUALS SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 2
	// Denotes less than `<` operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_LESS_THAN SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 3
	// Denotes greater than or equal to `>=` operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN_EQUALS SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 4
	// Denotes greater than `>` operator.
	SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 5
)

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Descriptor added in v1.11.0 

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Descriptor() protoreflect.EnumDescriptor

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Enum added in v1.11.0 

func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Enum() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) EnumDescriptor deprecated added in v1.11.0 

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison.Descriptor instead.

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Number added in v1.11.0 

func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Number() protoreflect.EnumNumber

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) String added in v1.11.0 

func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) String() string

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Type added in v1.11.0 

func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Type() protoreflect.EnumType

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression struct {

	// The expressions that were ORed together.
	Expressions []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

Logical `Or` operator.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) GetExpressions added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) GetExpressions() []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) String() string

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint added in v1.11.0 

type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint struct {

	// Name of the string field as defined in the schema.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Values of the string field. The record will only be returned if the
	// field value matches one of the values specified here.
	Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// Identifies the keywords within the search query that match a filter.
	QuerySegment string `protobuf:"bytes,3,opt,name=query_segment,json=querySegment,proto3" json:"query_segment,omitempty"`
	// contains filtered or unexported fields
}

Constraint expression of a string field.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint.ProtoReflect.Descriptor instead.

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetFieldName added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetFieldName() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetQuerySegment added in v1.14.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetQuerySegment() string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetValues added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetValues() []string

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoMessage added in v1.11.0 

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoMessage()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoReflect added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoReflect() protoreflect.Message

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Reset added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Reset()

func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) String added in v1.11.0 

func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) String() string

type SearchResponse_OneBoxResult added in v1.14.0 

type SearchResponse_OneBoxResult struct {

	// The type of One Box result.
	OneBoxType SearchResponse_OneBoxResult_OneBoxType `` /* 174-byte string literal not displayed */
	// The search results for this One Box.
	SearchResults []*SearchResponse_SearchResult `protobuf:"bytes,2,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
	// contains filtered or unexported fields
}

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

func (*SearchResponse_OneBoxResult) Descriptor deprecated added in v1.14.0 

func (*SearchResponse_OneBoxResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_OneBoxResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_OneBoxResult) GetOneBoxType added in v1.14.0 

func (x *SearchResponse_OneBoxResult) GetOneBoxType() SearchResponse_OneBoxResult_OneBoxType

func (*SearchResponse_OneBoxResult) GetSearchResults added in v1.14.0 

func (x *SearchResponse_OneBoxResult) GetSearchResults() []*SearchResponse_SearchResult

func (*SearchResponse_OneBoxResult) ProtoMessage added in v1.14.0 

func (*SearchResponse_OneBoxResult) ProtoMessage()

func (*SearchResponse_OneBoxResult) ProtoReflect added in v1.14.0 

func (x *SearchResponse_OneBoxResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_OneBoxResult) Reset added in v1.14.0 

func (x *SearchResponse_OneBoxResult) Reset()

func (*SearchResponse_OneBoxResult) String added in v1.14.0 

func (x *SearchResponse_OneBoxResult) String() string

type SearchResponse_OneBoxResult_OneBoxType added in v1.14.0 

type SearchResponse_OneBoxResult_OneBoxType int32

The type of One Box result. 

const (
	// Default value. Should not be used.
	SearchResponse_OneBoxResult_ONE_BOX_TYPE_UNSPECIFIED SearchResponse_OneBoxResult_OneBoxType = 0
	// One Box result contains people results.
	SearchResponse_OneBoxResult_PEOPLE SearchResponse_OneBoxResult_OneBoxType = 1
	// One Box result contains organization results.
	SearchResponse_OneBoxResult_ORGANIZATION SearchResponse_OneBoxResult_OneBoxType = 2
	// One Box result contains slack results.
	SearchResponse_OneBoxResult_SLACK SearchResponse_OneBoxResult_OneBoxType = 3
)

func (SearchResponse_OneBoxResult_OneBoxType) Descriptor added in v1.14.0 

func (SearchResponse_OneBoxResult_OneBoxType) Descriptor() protoreflect.EnumDescriptor

func (SearchResponse_OneBoxResult_OneBoxType) Enum added in v1.14.0 

func (x SearchResponse_OneBoxResult_OneBoxType) Enum() *SearchResponse_OneBoxResult_OneBoxType

func (SearchResponse_OneBoxResult_OneBoxType) EnumDescriptor deprecated added in v1.14.0 

func (SearchResponse_OneBoxResult_OneBoxType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchResponse_OneBoxResult_OneBoxType.Descriptor instead.

func (SearchResponse_OneBoxResult_OneBoxType) Number added in v1.14.0 

func (x SearchResponse_OneBoxResult_OneBoxType) Number() protoreflect.EnumNumber

func (SearchResponse_OneBoxResult_OneBoxType) String added in v1.14.0 

func (x SearchResponse_OneBoxResult_OneBoxType) String() string

func (SearchResponse_OneBoxResult_OneBoxType) Type added in v1.14.0 

func (SearchResponse_OneBoxResult_OneBoxType) Type() protoreflect.EnumType

type SearchResponse_QueryExpansionInfo added in v1.2.0 

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.v1beta.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 added in v1.2.0 

func (*SearchResponse_QueryExpansionInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_QueryExpansionInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_QueryExpansionInfo) GetExpandedQuery added in v1.2.0 

func (x *SearchResponse_QueryExpansionInfo) GetExpandedQuery() bool

func (*SearchResponse_QueryExpansionInfo) GetPinnedResultCount added in v1.2.0 

func (x *SearchResponse_QueryExpansionInfo) GetPinnedResultCount() int64

func (*SearchResponse_QueryExpansionInfo) ProtoMessage added in v1.2.0 

func (*SearchResponse_QueryExpansionInfo) ProtoMessage()

func (*SearchResponse_QueryExpansionInfo) ProtoReflect added in v1.2.0 

func (x *SearchResponse_QueryExpansionInfo) ProtoReflect() protoreflect.Message

func (*SearchResponse_QueryExpansionInfo) Reset added in v1.2.0 

func (x *SearchResponse_QueryExpansionInfo) Reset()

func (*SearchResponse_QueryExpansionInfo) String added in v1.2.0 

func (x *SearchResponse_QueryExpansionInfo) String() string

type SearchResponse_SearchResult added in v0.3.0 

type SearchResponse_SearchResult struct {

	// [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
	// searched [Document][google.cloud.discoveryengine.v1beta.Document].
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The document data snippet in the search response. Only fields that are
	// marked as `retrievable` are populated.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// The chunk data in the search response if the
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1beta.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 added in v0.3.0 

func (*SearchResponse_SearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchResult) GetChunk added in v1.10.0 

func (x *SearchResponse_SearchResult) GetChunk() *Chunk

func (*SearchResponse_SearchResult) GetDocument added in v0.3.0 

func (x *SearchResponse_SearchResult) GetDocument() *Document

func (*SearchResponse_SearchResult) GetId added in v0.3.0 

func (x *SearchResponse_SearchResult) GetId() string

func (*SearchResponse_SearchResult) GetModelScores added in v1.2.0 

func (x *SearchResponse_SearchResult) GetModelScores() map[string]*DoubleList

func (*SearchResponse_SearchResult) ProtoMessage added in v0.3.0 

func (*SearchResponse_SearchResult) ProtoMessage()

func (*SearchResponse_SearchResult) ProtoReflect added in v0.3.0 

func (x *SearchResponse_SearchResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_SearchResult) Reset added in v0.3.0 

func (x *SearchResponse_SearchResult) Reset()

func (*SearchResponse_SearchResult) String added in v0.3.0 

func (x *SearchResponse_SearchResult) String() string

type SearchResponse_SessionInfo added in v1.11.0 

type SearchResponse_SessionInfo struct {

	// Name of the session.
	// If the auto-session mode is used (when
	// [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session]
	// ends with "-"), this field holds the newly generated session name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Query ID that corresponds to this search API call.
	// One session can have multiple turns, each with a unique query ID.
	//
	// By specifying the session name and this query ID in the Answer API call,
	// the answer generation happens in the context of the search results from
	// this search call.
	QueryId string `protobuf:"bytes,2,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
	// contains filtered or unexported fields
}

Information about the session.

func (*SearchResponse_SessionInfo) Descriptor deprecated added in v1.11.0 

func (*SearchResponse_SessionInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_SessionInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_SessionInfo) GetName added in v1.11.0 

func (x *SearchResponse_SessionInfo) GetName() string

func (*SearchResponse_SessionInfo) GetQueryId added in v1.11.0 

func (x *SearchResponse_SessionInfo) GetQueryId() string

func (*SearchResponse_SessionInfo) ProtoMessage added in v1.11.0 

func (*SearchResponse_SessionInfo) ProtoMessage()

func (*SearchResponse_SessionInfo) ProtoReflect added in v1.11.0 

func (x *SearchResponse_SessionInfo) ProtoReflect() protoreflect.Message

func (*SearchResponse_SessionInfo) Reset added in v1.11.0 

func (x *SearchResponse_SessionInfo) Reset()

func (*SearchResponse_SessionInfo) String added in v1.11.0 

func (x *SearchResponse_SessionInfo) String() string

type SearchResponse_Summary added in v0.3.0 

type SearchResponse_Summary struct {

	// The summary content.
	SummaryText string `protobuf:"bytes,1,opt,name=summary_text,json=summaryText,proto3" json:"summary_text,omitempty"`
	// Additional summary-skipped reasons. This provides the reason for ignored
	// cases. If nothing is skipped, this field is not set.
	SummarySkippedReasons []SearchResponse_Summary_SummarySkippedReason `` /* 219-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 results specified by the summary spec.

func (*SearchResponse_Summary) Descriptor deprecated added in v0.3.0 

func (*SearchResponse_Summary) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary) GetSafetyAttributes added in v1.2.0 

func (x *SearchResponse_Summary) GetSafetyAttributes() *SearchResponse_Summary_SafetyAttributes

func (*SearchResponse_Summary) GetSummarySkippedReasons added in v1.1.0 

func (x *SearchResponse_Summary) GetSummarySkippedReasons() []SearchResponse_Summary_SummarySkippedReason

func (*SearchResponse_Summary) GetSummaryText added in v0.3.0 

func (x *SearchResponse_Summary) GetSummaryText() string

func (*SearchResponse_Summary) GetSummaryWithMetadata added in v1.5.0 

func (x *SearchResponse_Summary) GetSummaryWithMetadata() *SearchResponse_Summary_SummaryWithMetadata

func (*SearchResponse_Summary) ProtoMessage added in v0.3.0 

func (*SearchResponse_Summary) ProtoMessage()

func (*SearchResponse_Summary) ProtoReflect added in v0.3.0 

func (x *SearchResponse_Summary) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary) Reset added in v0.3.0 

func (x *SearchResponse_Summary) Reset()

func (*SearchResponse_Summary) String added in v0.3.0 

func (x *SearchResponse_Summary) String() string

type SearchResponse_Summary_Citation added in v1.5.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.5.0 

func (*SearchResponse_Summary_Citation) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_Citation.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Citation) GetEndIndex added in v1.5.0 

func (x *SearchResponse_Summary_Citation) GetEndIndex() int64

func (*SearchResponse_Summary_Citation) GetSources added in v1.5.0 

func (x *SearchResponse_Summary_Citation) GetSources() []*SearchResponse_Summary_CitationSource

func (*SearchResponse_Summary_Citation) GetStartIndex added in v1.5.0 

func (x *SearchResponse_Summary_Citation) GetStartIndex() int64

func (*SearchResponse_Summary_Citation) ProtoMessage added in v1.5.0 

func (*SearchResponse_Summary_Citation) ProtoMessage()

func (*SearchResponse_Summary_Citation) ProtoReflect added in v1.5.0 

func (x *SearchResponse_Summary_Citation) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_Citation) Reset added in v1.5.0 

func (x *SearchResponse_Summary_Citation) Reset()

func (*SearchResponse_Summary_Citation) String added in v1.5.0 

func (x *SearchResponse_Summary_Citation) String() string

type SearchResponse_Summary_CitationMetadata added in v1.5.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.5.0 

func (*SearchResponse_Summary_CitationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_CitationMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_CitationMetadata) GetCitations added in v1.5.0 

func (x *SearchResponse_Summary_CitationMetadata) GetCitations() []*SearchResponse_Summary_Citation

func (*SearchResponse_Summary_CitationMetadata) ProtoMessage added in v1.5.0 

func (*SearchResponse_Summary_CitationMetadata) ProtoMessage()

func (*SearchResponse_Summary_CitationMetadata) ProtoReflect added in v1.5.0 

func (x *SearchResponse_Summary_CitationMetadata) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_CitationMetadata) Reset added in v1.5.0 

func (x *SearchResponse_Summary_CitationMetadata) Reset()

func (*SearchResponse_Summary_CitationMetadata) String added in v1.5.0 

func (x *SearchResponse_Summary_CitationMetadata) String() string

type SearchResponse_Summary_CitationSource added in v1.5.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.5.0 

func (*SearchResponse_Summary_CitationSource) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_CitationSource.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_CitationSource) GetReferenceIndex added in v1.5.0 

func (x *SearchResponse_Summary_CitationSource) GetReferenceIndex() int64

func (*SearchResponse_Summary_CitationSource) ProtoMessage added in v1.5.0 

func (*SearchResponse_Summary_CitationSource) ProtoMessage()

func (*SearchResponse_Summary_CitationSource) ProtoReflect added in v1.5.0 

func (x *SearchResponse_Summary_CitationSource) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_CitationSource) Reset added in v1.5.0 

func (x *SearchResponse_Summary_CitationSource) Reset()

func (*SearchResponse_Summary_CitationSource) String added in v1.5.0 

func (x *SearchResponse_Summary_CitationSource) String() string

type SearchResponse_Summary_Reference added in v1.5.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.v1beta.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"`
	// List of cited chunk contents derived from document content.
	ChunkContents []*SearchResponse_Summary_Reference_ChunkContent `protobuf:"bytes,4,rep,name=chunk_contents,json=chunkContents,proto3" json:"chunk_contents,omitempty"`
	// contains filtered or unexported fields
}

Document reference.

func (*SearchResponse_Summary_Reference) Descriptor deprecated added in v1.5.0 

func (*SearchResponse_Summary_Reference) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_Reference.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Reference) GetChunkContents added in v1.7.0 

func (x *SearchResponse_Summary_Reference) GetChunkContents() []*SearchResponse_Summary_Reference_ChunkContent

func (*SearchResponse_Summary_Reference) GetDocument added in v1.5.0 

func (x *SearchResponse_Summary_Reference) GetDocument() string

func (*SearchResponse_Summary_Reference) GetTitle added in v1.5.0 

func (x *SearchResponse_Summary_Reference) GetTitle() string

func (*SearchResponse_Summary_Reference) GetUri added in v1.5.0 

func (x *SearchResponse_Summary_Reference) GetUri() string

func (*SearchResponse_Summary_Reference) ProtoMessage added in v1.5.0 

func (*SearchResponse_Summary_Reference) ProtoMessage()

func (*SearchResponse_Summary_Reference) ProtoReflect added in v1.5.0 

func (x *SearchResponse_Summary_Reference) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_Reference) Reset added in v1.5.0 

func (x *SearchResponse_Summary_Reference) Reset()

func (*SearchResponse_Summary_Reference) String added in v1.5.0 

func (x *SearchResponse_Summary_Reference) String() string

type SearchResponse_Summary_Reference_ChunkContent added in v1.7.0 

type SearchResponse_Summary_Reference_ChunkContent struct {

	// Chunk textual content.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Page identifier.
	PageIdentifier string `protobuf:"bytes,2,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// contains filtered or unexported fields
}

Chunk content.

func (*SearchResponse_Summary_Reference_ChunkContent) Descriptor deprecated added in v1.7.0 

func (*SearchResponse_Summary_Reference_ChunkContent) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_Reference_ChunkContent.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Reference_ChunkContent) GetContent added in v1.7.0 

func (x *SearchResponse_Summary_Reference_ChunkContent) GetContent() string

func (*SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier added in v1.7.0 

func (x *SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier() string

func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage added in v1.7.0 

func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage()

func (*SearchResponse_Summary_Reference_ChunkContent) ProtoReflect added in v1.7.0 

func (x *SearchResponse_Summary_Reference_ChunkContent) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_Reference_ChunkContent) Reset added in v1.7.0 

func (x *SearchResponse_Summary_Reference_ChunkContent) Reset()

func (*SearchResponse_Summary_Reference_ChunkContent) String added in v1.7.0 

func (x *SearchResponse_Summary_Reference_ChunkContent) String() string

type SearchResponse_Summary_SafetyAttributes added in v1.2.0 

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 added in v1.2.0 

func (*SearchResponse_Summary_SafetyAttributes) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_SafetyAttributes.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_SafetyAttributes) GetCategories added in v1.2.0 

func (x *SearchResponse_Summary_SafetyAttributes) GetCategories() []string

func (*SearchResponse_Summary_SafetyAttributes) GetScores added in v1.2.0 

func (x *SearchResponse_Summary_SafetyAttributes) GetScores() []float32

func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage added in v1.2.0 

func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage()

func (*SearchResponse_Summary_SafetyAttributes) ProtoReflect added in v1.2.0 

func (x *SearchResponse_Summary_SafetyAttributes) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_SafetyAttributes) Reset added in v1.2.0 

func (x *SearchResponse_Summary_SafetyAttributes) Reset()

func (*SearchResponse_Summary_SafetyAttributes) String added in v1.2.0 

func (x *SearchResponse_Summary_SafetyAttributes) String() string

type SearchResponse_Summary_SummarySkippedReason added in v1.1.0 

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 used when
	// [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1beta.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 used when
	// [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1beta.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
	// The no relevant content case.
	//
	// Google skips the summary if there is no relevant content in the
	// retrieved search results.
	SearchResponse_Summary_NO_RELEVANT_CONTENT SearchResponse_Summary_SummarySkippedReason = 6
	// The jail-breaking query ignored case.
	//
	// For example, "Reply in the tone of a competing company's CEO".
	// Only used when
	// [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
	// is set to `true`.
	SearchResponse_Summary_JAIL_BREAKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 7
	// The customer policy violation case.
	//
	// Google skips the summary if there is a customer policy violation
	// detected. The policy is defined by the customer.
	SearchResponse_Summary_CUSTOMER_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 8
)

func (SearchResponse_Summary_SummarySkippedReason) Descriptor added in v1.1.0 

func (SearchResponse_Summary_SummarySkippedReason) Descriptor() protoreflect.EnumDescriptor

func (SearchResponse_Summary_SummarySkippedReason) Enum added in v1.1.0 

func (x SearchResponse_Summary_SummarySkippedReason) Enum() *SearchResponse_Summary_SummarySkippedReason

func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor deprecated added in v1.1.0 

func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_SummarySkippedReason.Descriptor instead.

func (SearchResponse_Summary_SummarySkippedReason) Number added in v1.1.0 

func (x SearchResponse_Summary_SummarySkippedReason) Number() protoreflect.EnumNumber

func (SearchResponse_Summary_SummarySkippedReason) String added in v1.1.0 

func (x SearchResponse_Summary_SummarySkippedReason) String() string

func (SearchResponse_Summary_SummarySkippedReason) Type added in v1.1.0 

func (SearchResponse_Summary_SummarySkippedReason) Type() protoreflect.EnumType

type SearchResponse_Summary_SummaryWithMetadata added in v1.5.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.5.0 

func (*SearchResponse_Summary_SummaryWithMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Summary_SummaryWithMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata() *SearchResponse_Summary_CitationMetadata

func (*SearchResponse_Summary_SummaryWithMetadata) GetReferences added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) GetReferences() []*SearchResponse_Summary_Reference

func (*SearchResponse_Summary_SummaryWithMetadata) GetSummary added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) GetSummary() string

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage added in v1.5.0 

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage()

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoReflect added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) ProtoReflect() protoreflect.Message

func (*SearchResponse_Summary_SummaryWithMetadata) Reset added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) Reset()

func (*SearchResponse_Summary_SummaryWithMetadata) String added in v1.5.0 

func (x *SearchResponse_Summary_SummaryWithMetadata) String() string

type SearchServiceClient added in v0.3.0 

type SearchServiceClient interface {
	// Performs a search.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}

SearchServiceClient is the client API for SearchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSearchServiceClient added in v0.3.0 

func NewSearchServiceClient(cc grpc.ClientConnInterface) SearchServiceClient

type SearchServiceServer added in v0.3.0 

type SearchServiceServer interface {
	// Performs a search.
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
}

SearchServiceServer is the server API for SearchService service.

type SearchTier added in v1.5.0 

type SearchTier int32

Tiers of search features. Different tiers might have different pricing. To learn more, 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 added in v1.5.0 

func (SearchTier) Descriptor() protoreflect.EnumDescriptor

func (SearchTier) Enum added in v1.5.0 

func (x SearchTier) Enum() *SearchTier

func (SearchTier) EnumDescriptor deprecated added in v1.5.0 

func (SearchTier) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchTier.Descriptor instead.

func (SearchTier) Number added in v1.5.0 

func (x SearchTier) Number() protoreflect.EnumNumber

func (SearchTier) String added in v1.5.0 

func (x SearchTier) String() string

func (SearchTier) Type added in v1.5.0 

func (SearchTier) Type() protoreflect.EnumType

type SearchTuningServiceClient added in v1.6.0 

type SearchTuningServiceClient interface {
	// Trains a custom model.
	TrainCustomModel(ctx context.Context, in *TrainCustomModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of all the custom models.
	ListCustomModels(ctx context.Context, in *ListCustomModelsRequest, opts ...grpc.CallOption) (*ListCustomModelsResponse, 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.6.0 

func NewSearchTuningServiceClient(cc grpc.ClientConnInterface) SearchTuningServiceClient

type SearchTuningServiceServer added in v1.6.0 

type SearchTuningServiceServer interface {
	// Trains a custom model.
	TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
	// Gets a list of all the custom models.
	ListCustomModels(context.Context, *ListCustomModelsRequest) (*ListCustomModelsResponse, error)
}

SearchTuningServiceServer is the server API for SearchTuningService service.

type SearchUseCase added in v1.8.0 

type SearchUseCase int32

Defines a further subdivision of `SolutionType`. Specifically applies to [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. 

const (
	// Value used when unset. Will not occur in CSS.
	SearchUseCase_SEARCH_USE_CASE_UNSPECIFIED SearchUseCase = 0
	// Search use case. Expects the traffic has a non-empty
	// [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
	SearchUseCase_SEARCH_USE_CASE_SEARCH SearchUseCase = 1
	// Browse use case. Expects the traffic has an empty
	// [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
	SearchUseCase_SEARCH_USE_CASE_BROWSE SearchUseCase = 2
)

func (SearchUseCase) Descriptor added in v1.8.0 

func (SearchUseCase) Descriptor() protoreflect.EnumDescriptor

func (SearchUseCase) Enum added in v1.8.0 

func (x SearchUseCase) Enum() *SearchUseCase

func (SearchUseCase) EnumDescriptor deprecated added in v1.8.0 

func (SearchUseCase) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchUseCase.Descriptor instead.

func (SearchUseCase) Number added in v1.8.0 

func (x SearchUseCase) Number() protoreflect.EnumNumber

func (SearchUseCase) String added in v1.8.0 

func (x SearchUseCase) String() string

func (SearchUseCase) Type added in v1.8.0 

func (SearchUseCase) Type() protoreflect.EnumType

type ServingConfig added in v1.5.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 `` /* 152-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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// and the document embeddings that are provided by this EmbeddingConfig. If
	// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
	// is provided, it overrides this
	// [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.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.v1beta.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"`
	// 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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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.5.0 

func (*ServingConfig) Descriptor() ([]byte, []int)

Deprecated: Use ServingConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig) GetBoostControlIds added in v1.5.0 

func (x *ServingConfig) GetBoostControlIds() []string

func (*ServingConfig) GetCreateTime added in v1.5.0 

func (x *ServingConfig) GetCreateTime() *timestamppb.Timestamp

func (*ServingConfig) GetDisplayName added in v1.5.0 

func (x *ServingConfig) GetDisplayName() string

func (*ServingConfig) GetDissociateControlIds added in v1.5.0 

func (x *ServingConfig) GetDissociateControlIds() []string

func (*ServingConfig) GetDiversityLevel added in v1.5.0 

func (x *ServingConfig) GetDiversityLevel() string

func (*ServingConfig) GetEmbeddingConfig added in v1.5.0 

func (x *ServingConfig) GetEmbeddingConfig() *EmbeddingConfig

func (*ServingConfig) GetFilterControlIds added in v1.5.0 

func (x *ServingConfig) GetFilterControlIds() []string

func (*ServingConfig) GetGenericConfig added in v1.5.0 

func (x *ServingConfig) GetGenericConfig() *ServingConfig_GenericConfig

func (*ServingConfig) GetIgnoreControlIds added in v1.5.0 

func (x *ServingConfig) GetIgnoreControlIds() []string

func (*ServingConfig) GetMediaConfig added in v1.5.0 

func (x *ServingConfig) GetMediaConfig() *ServingConfig_MediaConfig

func (*ServingConfig) GetModelId added in v1.5.0 

func (x *ServingConfig) GetModelId() string

func (*ServingConfig) GetName added in v1.5.0 

func (x *ServingConfig) GetName() string

func (*ServingConfig) GetOnewaySynonymsControlIds added in v1.5.0 

func (x *ServingConfig) GetOnewaySynonymsControlIds() []string

func (*ServingConfig) GetRankingExpression added in v1.5.0 

func (x *ServingConfig) GetRankingExpression() string

func (*ServingConfig) GetRedirectControlIds added in v1.5.0 

func (x *ServingConfig) GetRedirectControlIds() []string

func (*ServingConfig) GetReplacementControlIds added in v1.5.0 

func (x *ServingConfig) GetReplacementControlIds() []string

func (*ServingConfig) GetSolutionType added in v1.5.0 

func (x *ServingConfig) GetSolutionType() SolutionType

func (*ServingConfig) GetSynonymsControlIds added in v1.5.0 

func (x *ServingConfig) GetSynonymsControlIds() []string

func (*ServingConfig) GetUpdateTime added in v1.5.0 

func (x *ServingConfig) GetUpdateTime() *timestamppb.Timestamp

func (*ServingConfig) GetVerticalConfig added in v1.5.0 

func (m *ServingConfig) GetVerticalConfig() isServingConfig_VerticalConfig

func (*ServingConfig) ProtoMessage added in v1.5.0 

func (*ServingConfig) ProtoMessage()

func (*ServingConfig) ProtoReflect added in v1.5.0 

func (x *ServingConfig) ProtoReflect() protoreflect.Message

func (*ServingConfig) Reset added in v1.5.0 

func (x *ServingConfig) Reset()

func (*ServingConfig) String added in v1.5.0 

func (x *ServingConfig) String() string

type ServingConfigServiceClient added in v1.5.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.5.0 

func NewServingConfigServiceClient(cc grpc.ClientConnInterface) ServingConfigServiceClient

type ServingConfigServiceServer added in v1.5.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.5.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.5.0 

func (*ServingConfig_GenericConfig) Descriptor() ([]byte, []int)

Deprecated: Use ServingConfig_GenericConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig_GenericConfig) GetContentSearchSpec added in v1.5.0 

func (x *ServingConfig_GenericConfig) GetContentSearchSpec() *SearchRequest_ContentSearchSpec

func (*ServingConfig_GenericConfig) ProtoMessage added in v1.5.0 

func (*ServingConfig_GenericConfig) ProtoMessage()

func (*ServingConfig_GenericConfig) ProtoReflect added in v1.5.0 

func (x *ServingConfig_GenericConfig) ProtoReflect() protoreflect.Message

func (*ServingConfig_GenericConfig) Reset added in v1.5.0 

func (x *ServingConfig_GenericConfig) Reset()

func (*ServingConfig_GenericConfig) String added in v1.5.0 

func (x *ServingConfig_GenericConfig) String() string

type ServingConfig_GenericConfig_ added in v1.5.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.5.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.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

func (*ServingConfig_MediaConfig) Descriptor deprecated added in v1.5.0 

func (*ServingConfig_MediaConfig) Descriptor() ([]byte, []int)

Deprecated: Use ServingConfig_MediaConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig_MediaConfig) GetContentFreshnessCutoffDays added in v1.5.0 

func (x *ServingConfig_MediaConfig) GetContentFreshnessCutoffDays() int32

func (*ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold added in v1.5.0 

func (x *ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold() float32

func (*ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold added in v1.5.0 

func (x *ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold() float32

func (*ServingConfig_MediaConfig) GetDemoteContentWatched added in v1.5.0 

func (m *ServingConfig_MediaConfig) GetDemoteContentWatched() isServingConfig_MediaConfig_DemoteContentWatched

func (*ServingConfig_MediaConfig) GetDemotionEventType added in v1.5.0 

func (x *ServingConfig_MediaConfig) GetDemotionEventType() string

func (*ServingConfig_MediaConfig) ProtoMessage added in v1.5.0 

func (*ServingConfig_MediaConfig) ProtoMessage()

func (*ServingConfig_MediaConfig) ProtoReflect added in v1.5.0 

func (x *ServingConfig_MediaConfig) ProtoReflect() protoreflect.Message

func (*ServingConfig_MediaConfig) Reset added in v1.5.0 

func (x *ServingConfig_MediaConfig) Reset()

func (*ServingConfig_MediaConfig) String added in v1.5.0 

func (x *ServingConfig_MediaConfig) String() string

type ServingConfig_MediaConfig_ added in v1.5.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.5.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.5.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 Session added in v1.7.0 

type Session struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the session.
	State Session_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Session_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"`
	// Turns.
	Turns []*Session_Turn `protobuf:"bytes,4,rep,name=turns,proto3" json:"turns,omitempty"`
	// Output only. The time the session started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The time the session finished.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

External session proto definition.

func (*Session) Descriptor deprecated added in v1.7.0 

func (*Session) Descriptor() ([]byte, []int)

Deprecated: Use Session.ProtoReflect.Descriptor instead.

func (*Session) GetEndTime added in v1.7.0 

func (x *Session) GetEndTime() *timestamppb.Timestamp

func (*Session) GetName added in v1.7.0 

func (x *Session) GetName() string

func (*Session) GetStartTime added in v1.7.0 

func (x *Session) GetStartTime() *timestamppb.Timestamp

func (*Session) GetState added in v1.7.0 

func (x *Session) GetState() Session_State

func (*Session) GetTurns added in v1.7.0 

func (x *Session) GetTurns() []*Session_Turn

func (*Session) GetUserPseudoId added in v1.7.0 

func (x *Session) GetUserPseudoId() string

func (*Session) ProtoMessage added in v1.7.0 

func (*Session) ProtoMessage()

func (*Session) ProtoReflect added in v1.7.0 

func (x *Session) ProtoReflect() protoreflect.Message

func (*Session) Reset added in v1.7.0 

func (x *Session) Reset()

func (*Session) String added in v1.7.0 

func (x *Session) String() string

type Session_State added in v1.7.0 

type Session_State int32

Enumeration of the state of the session. 

const (
	// State is unspecified.
	Session_STATE_UNSPECIFIED Session_State = 0
	// The session is currently open.
	Session_IN_PROGRESS Session_State = 1
)

func (Session_State) Descriptor added in v1.7.0 

func (Session_State) Descriptor() protoreflect.EnumDescriptor

func (Session_State) Enum added in v1.7.0 

func (x Session_State) Enum() *Session_State

func (Session_State) EnumDescriptor deprecated added in v1.7.0 

func (Session_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Session_State.Descriptor instead.

func (Session_State) Number added in v1.7.0 

func (x Session_State) Number() protoreflect.EnumNumber

func (Session_State) String added in v1.7.0 

func (x Session_State) String() string

func (Session_State) Type added in v1.7.0 

func (Session_State) Type() protoreflect.EnumType

type Session_Turn added in v1.7.0 

type Session_Turn struct {

	// The user query.
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// The resource name of the answer to the user query.
	//
	// Only set if the answer generation (/answer API call) happened in this
	// turn.
	Answer string `protobuf:"bytes,2,opt,name=answer,proto3" json:"answer,omitempty"`
	// contains filtered or unexported fields
}

Represents a turn, including a query from the user and a answer from service.

func (*Session_Turn) Descriptor deprecated added in v1.7.0 

func (*Session_Turn) Descriptor() ([]byte, []int)

Deprecated: Use Session_Turn.ProtoReflect.Descriptor instead.

func (*Session_Turn) GetAnswer added in v1.7.0 

func (x *Session_Turn) GetAnswer() string

func (*Session_Turn) GetQuery added in v1.7.0 

func (x *Session_Turn) GetQuery() *Query

func (*Session_Turn) ProtoMessage added in v1.7.0 

func (*Session_Turn) ProtoMessage()

func (*Session_Turn) ProtoReflect added in v1.7.0 

func (x *Session_Turn) ProtoReflect() protoreflect.Message

func (*Session_Turn) Reset added in v1.7.0 

func (x *Session_Turn) Reset()

func (*Session_Turn) String added in v1.7.0 

func (x *Session_Turn) String() string

type SiteSearchEngine added in v1.5.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.5.0 

func (*SiteSearchEngine) Descriptor() ([]byte, []int)

Deprecated: Use SiteSearchEngine.ProtoReflect.Descriptor instead.

func (*SiteSearchEngine) GetName added in v1.5.0 

func (x *SiteSearchEngine) GetName() string

func (*SiteSearchEngine) ProtoMessage added in v1.5.0 

func (*SiteSearchEngine) ProtoMessage()

func (*SiteSearchEngine) ProtoReflect added in v1.5.0 

func (x *SiteSearchEngine) ProtoReflect() protoreflect.Message

func (*SiteSearchEngine) Reset added in v1.5.0 

func (x *SiteSearchEngine) Reset()

func (*SiteSearchEngine) String added in v1.5.0 

func (x *SiteSearchEngine) String() string

type SiteSearchEngineServiceClient added in v1.5.0 

type SiteSearchEngineServiceClient interface {
	// Gets the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
	GetSiteSearchEngine(ctx context.Context, in *GetSiteSearchEngineRequest, opts ...grpc.CallOption) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	CreateTargetSite(ctx context.Context, in *CreateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a
	// batch.
	BatchCreateTargetSites(ctx context.Context, in *BatchCreateTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	GetTargetSite(ctx context.Context, in *GetTargetSiteRequest, opts ...grpc.CallOption) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	UpdateTargetSite(ctx context.Context, in *UpdateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	DeleteTargetSite(ctx context.Context, in *DeleteTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.

func NewSiteSearchEngineServiceClient added in v1.5.0 

func NewSiteSearchEngineServiceClient(cc grpc.ClientConnInterface) SiteSearchEngineServiceClient

type SiteSearchEngineServiceServer added in v1.5.0 

type SiteSearchEngineServiceServer interface {
	// Gets the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
	GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a
	// batch.
	BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
	DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)
	// Gets a list of
	// [TargetSite][google.cloud.discoveryengine.v1beta.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.5.0 

type SiteVerificationInfo struct {

	// Site verification state indicating the ownership and validity.
	SiteVerificationState SiteVerificationInfo_SiteVerificationState `` /* 211-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.5.0 

func (*SiteVerificationInfo) Descriptor() ([]byte, []int)

Deprecated: Use SiteVerificationInfo.ProtoReflect.Descriptor instead.

func (*SiteVerificationInfo) GetSiteVerificationState added in v1.5.0 

func (x *SiteVerificationInfo) GetSiteVerificationState() SiteVerificationInfo_SiteVerificationState

func (*SiteVerificationInfo) GetVerifyTime added in v1.5.0 

func (x *SiteVerificationInfo) GetVerifyTime() *timestamppb.Timestamp

func (*SiteVerificationInfo) ProtoMessage added in v1.5.0 

func (*SiteVerificationInfo) ProtoMessage()

func (*SiteVerificationInfo) ProtoReflect added in v1.5.0 

func (x *SiteVerificationInfo) ProtoReflect() protoreflect.Message

func (*SiteVerificationInfo) Reset added in v1.5.0 

func (x *SiteVerificationInfo) Reset()

func (*SiteVerificationInfo) String added in v1.5.0 

func (x *SiteVerificationInfo) String() string

type SiteVerificationInfo_SiteVerificationState added in v1.5.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.5.0 

func (SiteVerificationInfo_SiteVerificationState) Descriptor() protoreflect.EnumDescriptor

func (SiteVerificationInfo_SiteVerificationState) Enum added in v1.5.0 

func (x SiteVerificationInfo_SiteVerificationState) Enum() *SiteVerificationInfo_SiteVerificationState

func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor deprecated added in v1.5.0 

func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use SiteVerificationInfo_SiteVerificationState.Descriptor instead.

func (SiteVerificationInfo_SiteVerificationState) Number added in v1.5.0 

func (x SiteVerificationInfo_SiteVerificationState) Number() protoreflect.EnumNumber

func (SiteVerificationInfo_SiteVerificationState) String added in v1.5.0 

func (x SiteVerificationInfo_SiteVerificationState) String() string

func (SiteVerificationInfo_SiteVerificationState) Type added in v1.5.0 

func (SiteVerificationInfo_SiteVerificationState) Type() protoreflect.EnumType

type SolutionType added in v1.5.0 

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
	// Used for use cases related to the Generative Chat agent.
	// It's used for Generative chat engine only, the associated data stores
	// must enrolled with `SOLUTION_TYPE_CHAT` solution.
	SolutionType_SOLUTION_TYPE_GENERATIVE_CHAT SolutionType = 4
)

func (SolutionType) Descriptor added in v1.5.0 

func (SolutionType) Descriptor() protoreflect.EnumDescriptor

func (SolutionType) Enum added in v1.5.0 

func (x SolutionType) Enum() *SolutionType

func (SolutionType) EnumDescriptor deprecated added in v1.5.0 

func (SolutionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SolutionType.Descriptor instead.

func (SolutionType) Number added in v1.5.0 

func (x SolutionType) Number() protoreflect.EnumNumber

func (SolutionType) String added in v1.5.0 

func (x SolutionType) String() string

func (SolutionType) Type added in v1.5.0 

func (SolutionType) Type() protoreflect.EnumType

type SpannerSource added in v1.7.0 

type SpannerSource struct {

	// The project ID that contains the Spanner source. Has 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 instance ID of the source Spanner table.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The database ID of the source Spanner table.
	DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The table name of the Spanner database that needs to be imported.
	TableId string `protobuf:"bytes,4,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Whether to apply data boost on Spanner export. Enabling this option will
	// incur additional cost. More info can be found
	// [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
	EnableDataBoost bool `protobuf:"varint,5,opt,name=enable_data_boost,json=enableDataBoost,proto3" json:"enable_data_boost,omitempty"`
	// contains filtered or unexported fields
}

The Spanner source for importing data

func (*SpannerSource) Descriptor deprecated added in v1.7.0 

func (*SpannerSource) Descriptor() ([]byte, []int)

Deprecated: Use SpannerSource.ProtoReflect.Descriptor instead.

func (*SpannerSource) GetDatabaseId added in v1.7.0 

func (x *SpannerSource) GetDatabaseId() string

func (*SpannerSource) GetEnableDataBoost added in v1.7.0 

func (x *SpannerSource) GetEnableDataBoost() bool

func (*SpannerSource) GetInstanceId added in v1.7.0 

func (x *SpannerSource) GetInstanceId() string

func (*SpannerSource) GetProjectId added in v1.7.0 

func (x *SpannerSource) GetProjectId() string

func (*SpannerSource) GetTableId added in v1.7.0 

func (x *SpannerSource) GetTableId() string

func (*SpannerSource) ProtoMessage added in v1.7.0 

func (*SpannerSource) ProtoMessage()

func (*SpannerSource) ProtoReflect added in v1.7.0 

func (x *SpannerSource) ProtoReflect() protoreflect.Message

func (*SpannerSource) Reset added in v1.7.0 

func (x *SpannerSource) Reset()

func (*SpannerSource) String added in v1.7.0 

func (x *SpannerSource) String() string

type SuggestionDenyListEntry added in v1.5.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 `` /* 180-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.5.0 

func (*SuggestionDenyListEntry) Descriptor() ([]byte, []int)

Deprecated: Use SuggestionDenyListEntry.ProtoReflect.Descriptor instead.

func (*SuggestionDenyListEntry) GetBlockPhrase added in v1.5.0 

func (x *SuggestionDenyListEntry) GetBlockPhrase() string

func (*SuggestionDenyListEntry) GetMatchOperator added in v1.5.0 

func (x *SuggestionDenyListEntry) GetMatchOperator() SuggestionDenyListEntry_MatchOperator

func (*SuggestionDenyListEntry) ProtoMessage added in v1.5.0 

func (*SuggestionDenyListEntry) ProtoMessage()

func (*SuggestionDenyListEntry) ProtoReflect added in v1.5.0 

func (x *SuggestionDenyListEntry) ProtoReflect() protoreflect.Message

func (*SuggestionDenyListEntry) Reset added in v1.5.0 

func (x *SuggestionDenyListEntry) Reset()

func (*SuggestionDenyListEntry) String added in v1.5.0 

func (x *SuggestionDenyListEntry) String() string

type SuggestionDenyListEntry_MatchOperator added in v1.5.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.5.0 

func (SuggestionDenyListEntry_MatchOperator) Descriptor() protoreflect.EnumDescriptor

func (SuggestionDenyListEntry_MatchOperator) Enum added in v1.5.0 

func (x SuggestionDenyListEntry_MatchOperator) Enum() *SuggestionDenyListEntry_MatchOperator

func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor deprecated added in v1.5.0 

func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor() ([]byte, []int)

Deprecated: Use SuggestionDenyListEntry_MatchOperator.Descriptor instead.

func (SuggestionDenyListEntry_MatchOperator) Number added in v1.5.0 

func (x SuggestionDenyListEntry_MatchOperator) Number() protoreflect.EnumNumber

func (SuggestionDenyListEntry_MatchOperator) String added in v1.5.0 

func (x SuggestionDenyListEntry_MatchOperator) String() string

func (SuggestionDenyListEntry_MatchOperator) Type added in v1.5.0 

func (SuggestionDenyListEntry_MatchOperator) Type() protoreflect.EnumType

type TargetSite added in v1.5.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.v1beta.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. Root domain of the provided_uri_pattern.
	RootDomainUri string `protobuf:"bytes,10,opt,name=root_domain_uri,json=rootDomainUri,proto3" json:"root_domain_uri,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 `` /* 171-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.5.0 

func (*TargetSite) Descriptor() ([]byte, []int)

Deprecated: Use TargetSite.ProtoReflect.Descriptor instead.

func (*TargetSite) GetExactMatch added in v1.5.0 

func (x *TargetSite) GetExactMatch() bool

func (*TargetSite) GetFailureReason added in v1.5.0 

func (x *TargetSite) GetFailureReason() *TargetSite_FailureReason

func (*TargetSite) GetGeneratedUriPattern added in v1.5.0 

func (x *TargetSite) GetGeneratedUriPattern() string

func (*TargetSite) GetIndexingStatus added in v1.5.0 

func (x *TargetSite) GetIndexingStatus() TargetSite_IndexingStatus

func (*TargetSite) GetName added in v1.5.0 

func (x *TargetSite) GetName() string

func (*TargetSite) GetProvidedUriPattern added in v1.5.0 

func (x *TargetSite) GetProvidedUriPattern() string

func (*TargetSite) GetRootDomainUri added in v1.8.0 

func (x *TargetSite) GetRootDomainUri() string

func (*TargetSite) GetSiteVerificationInfo added in v1.5.0 

func (x *TargetSite) GetSiteVerificationInfo() *SiteVerificationInfo

func (*TargetSite) GetType added in v1.5.0 

func (x *TargetSite) GetType() TargetSite_Type

func (*TargetSite) GetUpdateTime added in v1.5.0 

func (x *TargetSite) GetUpdateTime() *timestamppb.Timestamp

func (*TargetSite) ProtoMessage added in v1.5.0 

func (*TargetSite) ProtoMessage()

func (*TargetSite) ProtoReflect added in v1.5.0 

func (x *TargetSite) ProtoReflect() protoreflect.Message

func (*TargetSite) Reset added in v1.5.0 

func (x *TargetSite) Reset()

func (*TargetSite) String added in v1.5.0 

func (x *TargetSite) String() string

type TargetSite_FailureReason added in v1.5.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.5.0 

func (*TargetSite_FailureReason) Descriptor() ([]byte, []int)

Deprecated: Use TargetSite_FailureReason.ProtoReflect.Descriptor instead.

func (*TargetSite_FailureReason) GetFailure added in v1.5.0 

func (m *TargetSite_FailureReason) GetFailure() isTargetSite_FailureReason_Failure

func (*TargetSite_FailureReason) GetQuotaFailure added in v1.5.0 

func (x *TargetSite_FailureReason) GetQuotaFailure() *TargetSite_FailureReason_QuotaFailure

func (*TargetSite_FailureReason) ProtoMessage added in v1.5.0 

func (*TargetSite_FailureReason) ProtoMessage()

func (*TargetSite_FailureReason) ProtoReflect added in v1.5.0 

func (x *TargetSite_FailureReason) ProtoReflect() protoreflect.Message

func (*TargetSite_FailureReason) Reset added in v1.5.0 

func (x *TargetSite_FailureReason) Reset()

func (*TargetSite_FailureReason) String added in v1.5.0 

func (x *TargetSite_FailureReason) String() string

type TargetSite_FailureReason_QuotaFailure added in v1.5.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.5.0 

func (*TargetSite_FailureReason_QuotaFailure) Descriptor() ([]byte, []int)

Deprecated: Use TargetSite_FailureReason_QuotaFailure.ProtoReflect.Descriptor instead.

func (*TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota added in v1.5.0 

func (x *TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota() int64

func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage added in v1.5.0 

func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage()

func (*TargetSite_FailureReason_QuotaFailure) ProtoReflect added in v1.5.0 

func (x *TargetSite_FailureReason_QuotaFailure) ProtoReflect() protoreflect.Message

func (*TargetSite_FailureReason_QuotaFailure) Reset added in v1.5.0 

func (x *TargetSite_FailureReason_QuotaFailure) Reset()

func (*TargetSite_FailureReason_QuotaFailure) String added in v1.5.0 

func (x *TargetSite_FailureReason_QuotaFailure) String() string

type TargetSite_FailureReason_QuotaFailure_ added in v1.5.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.5.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.5.0 

func (TargetSite_IndexingStatus) Descriptor() protoreflect.EnumDescriptor

func (TargetSite_IndexingStatus) Enum added in v1.5.0 

func (x TargetSite_IndexingStatus) Enum() *TargetSite_IndexingStatus

func (TargetSite_IndexingStatus) EnumDescriptor deprecated added in v1.5.0 

func (TargetSite_IndexingStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use TargetSite_IndexingStatus.Descriptor instead.

func (TargetSite_IndexingStatus) Number added in v1.5.0 

func (x TargetSite_IndexingStatus) Number() protoreflect.EnumNumber

func (TargetSite_IndexingStatus) String added in v1.5.0 

func (x TargetSite_IndexingStatus) String() string

func (TargetSite_IndexingStatus) Type added in v1.5.0 

func (TargetSite_IndexingStatus) Type() protoreflect.EnumType

type TargetSite_Type added in v1.5.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.v1beta.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.5.0 

func (TargetSite_Type) Descriptor() protoreflect.EnumDescriptor

func (TargetSite_Type) Enum added in v1.5.0 

func (x TargetSite_Type) Enum() *TargetSite_Type

func (TargetSite_Type) EnumDescriptor deprecated added in v1.5.0 

func (TargetSite_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use TargetSite_Type.Descriptor instead.

func (TargetSite_Type) Number added in v1.5.0 

func (x TargetSite_Type) Number() protoreflect.EnumNumber

func (TargetSite_Type) String added in v1.5.0 

func (x TargetSite_Type) String() string

func (TargetSite_Type) Type added in v1.5.0 

func (TargetSite_Type) Type() protoreflect.EnumType

type TextInput added in v1.1.0 

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 added in v1.1.0 

func (*TextInput) Descriptor() ([]byte, []int)

Deprecated: Use TextInput.ProtoReflect.Descriptor instead.

func (*TextInput) GetContext added in v1.1.0 

func (x *TextInput) GetContext() *ConversationContext

func (*TextInput) GetInput added in v1.1.0 

func (x *TextInput) GetInput() string

func (*TextInput) ProtoMessage added in v1.1.0 

func (*TextInput) ProtoMessage()

func (*TextInput) ProtoReflect added in v1.1.0 

func (x *TextInput) ProtoReflect() protoreflect.Message

func (*TextInput) Reset added in v1.1.0 

func (x *TextInput) Reset()

func (*TextInput) String added in v1.1.0 

func (x *TextInput) String() string

type TrainCustomModelMetadata added in v1.6.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.6.0 

func (*TrainCustomModelMetadata) Descriptor() ([]byte, []int)

Deprecated: Use TrainCustomModelMetadata.ProtoReflect.Descriptor instead.

func (*TrainCustomModelMetadata) GetCreateTime added in v1.6.0 

func (x *TrainCustomModelMetadata) GetCreateTime() *timestamppb.Timestamp

func (*TrainCustomModelMetadata) GetUpdateTime added in v1.6.0 

func (x *TrainCustomModelMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*TrainCustomModelMetadata) ProtoMessage added in v1.6.0 

func (*TrainCustomModelMetadata) ProtoMessage()

func (*TrainCustomModelMetadata) ProtoReflect added in v1.6.0 

func (x *TrainCustomModelMetadata) ProtoReflect() protoreflect.Message

func (*TrainCustomModelMetadata) Reset added in v1.6.0 

func (x *TrainCustomModelMetadata) Reset()

func (*TrainCustomModelMetadata) String added in v1.6.0 

func (x *TrainCustomModelMetadata) String() string

type TrainCustomModelRequest added in v1.6.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"`
	// If not provided, a UUID will be generated.
	ModelId string `protobuf:"bytes,5,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] method.

func (*TrainCustomModelRequest) Descriptor deprecated added in v1.6.0 

func (*TrainCustomModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use TrainCustomModelRequest.ProtoReflect.Descriptor instead.

func (*TrainCustomModelRequest) GetDataStore added in v1.6.0 

func (x *TrainCustomModelRequest) GetDataStore() string

func (*TrainCustomModelRequest) GetErrorConfig added in v1.6.0 

func (x *TrainCustomModelRequest) GetErrorConfig() *ImportErrorConfig

func (*TrainCustomModelRequest) GetGcsTrainingInput added in v1.6.0 

func (x *TrainCustomModelRequest) GetGcsTrainingInput() *TrainCustomModelRequest_GcsTrainingInput

func (*TrainCustomModelRequest) GetModelId added in v1.8.0 

func (x *TrainCustomModelRequest) GetModelId() string

func (*TrainCustomModelRequest) GetModelType added in v1.6.0 

func (x *TrainCustomModelRequest) GetModelType() string

func (*TrainCustomModelRequest) GetTrainingInput added in v1.6.0 

func (m *TrainCustomModelRequest) GetTrainingInput() isTrainCustomModelRequest_TrainingInput

func (*TrainCustomModelRequest) ProtoMessage added in v1.6.0 

func (*TrainCustomModelRequest) ProtoMessage()

func (*TrainCustomModelRequest) ProtoReflect added in v1.6.0 

func (x *TrainCustomModelRequest) ProtoReflect() protoreflect.Message

func (*TrainCustomModelRequest) Reset added in v1.6.0 

func (x *TrainCustomModelRequest) Reset()

func (*TrainCustomModelRequest) String added in v1.6.0 

func (x *TrainCustomModelRequest) String() string

type TrainCustomModelRequest_GcsTrainingInput added in v1.6.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.6.0 

func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor() ([]byte, []int)

Deprecated: Use TrainCustomModelRequest_GcsTrainingInput.ProtoReflect.Descriptor instead.

func (*TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath() string

func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage added in v1.6.0 

func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage()

func (*TrainCustomModelRequest_GcsTrainingInput) ProtoReflect added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) ProtoReflect() protoreflect.Message

func (*TrainCustomModelRequest_GcsTrainingInput) Reset added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) Reset()

func (*TrainCustomModelRequest_GcsTrainingInput) String added in v1.6.0 

func (x *TrainCustomModelRequest_GcsTrainingInput) String() string

type TrainCustomModelRequest_GcsTrainingInput_ added in v1.6.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.6.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 job creation is in progress.
	//   - **training**: Model is actively training.
	//   - **evaluating**: The model is evaluating trained metrics.
	//   - **indexing**: The model trained metrics are indexing.
	//   - **ready**: The model is ready for serving.
	ModelStatus string `protobuf:"bytes,3,opt,name=model_status,json=modelStatus,proto3" json:"model_status,omitempty"`
	// The metrics of the trained model.
	Metrics map[string]float64 `` /* 157-byte string literal not displayed */
	// Fully qualified name of the CustomTuningModel.
	ModelName string `protobuf:"bytes,5,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// contains filtered or unexported fields
}

Response of the TrainCustomModelRequest[google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.

func (*TrainCustomModelResponse) Descriptor deprecated added in v1.6.0 

func (*TrainCustomModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use TrainCustomModelResponse.ProtoReflect.Descriptor instead.

func (*TrainCustomModelResponse) GetErrorConfig added in v1.6.0 

func (x *TrainCustomModelResponse) GetErrorConfig() *ImportErrorConfig

func (*TrainCustomModelResponse) GetErrorSamples added in v1.6.0 

func (x *TrainCustomModelResponse) GetErrorSamples() []*status.Status

func (*TrainCustomModelResponse) GetMetrics added in v1.7.0 

func (x *TrainCustomModelResponse) GetMetrics() map[string]float64

func (*TrainCustomModelResponse) GetModelName added in v1.8.0 

func (x *TrainCustomModelResponse) GetModelName() string

func (*TrainCustomModelResponse) GetModelStatus added in v1.6.0 

func (x *TrainCustomModelResponse) GetModelStatus() string

func (*TrainCustomModelResponse) ProtoMessage added in v1.6.0 

func (*TrainCustomModelResponse) ProtoMessage()

func (*TrainCustomModelResponse) ProtoReflect added in v1.6.0 

func (x *TrainCustomModelResponse) ProtoReflect() protoreflect.Message

func (*TrainCustomModelResponse) Reset added in v1.6.0 

func (x *TrainCustomModelResponse) Reset()

func (*TrainCustomModelResponse) String added in v1.6.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.v1beta.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost]
	Cost *float32 `protobuf:"fixed32,5,opt,name=cost,proto3,oneof" json:"cost,omitempty"`
	// The total discount(s) value applied to this transaction.
	// This figure should be excluded from
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	//
	// For example, if a user paid
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	// amount, then nominal (pre-discount) value of the transaction is the sum of
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]
	// and
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value]
	//
	// This means that profit is calculated the same way, regardless of the
	// discount value, and that
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value]
	// can be larger than
	// [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]:
	//
	// * Profit =
	// [value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost]
	DiscountValue *float32 `protobuf:"fixed32,6,opt,name=discount_value,json=discountValue,proto3,oneof" json:"discount_value,omitempty"`
	// contains filtered or unexported fields
}

A transaction represents the entire purchase transaction.

func (*TransactionInfo) Descriptor deprecated 

func (*TransactionInfo) Descriptor() ([]byte, []int)

Deprecated: Use TransactionInfo.ProtoReflect.Descriptor instead.

func (*TransactionInfo) GetCost 

func (x *TransactionInfo) GetCost() float32

func (*TransactionInfo) GetCurrency 

func (x *TransactionInfo) GetCurrency() string

func (*TransactionInfo) GetDiscountValue 

func (x *TransactionInfo) GetDiscountValue() float32

func (*TransactionInfo) GetTax 

func (x *TransactionInfo) GetTax() float32

func (*TransactionInfo) GetTransactionId 

func (x *TransactionInfo) GetTransactionId() string

func (*TransactionInfo) GetValue 

func (x *TransactionInfo) GetValue() float32

func (*TransactionInfo) ProtoMessage 

func (*TransactionInfo) ProtoMessage()

func (*TransactionInfo) ProtoReflect 

func (x *TransactionInfo) ProtoReflect() protoreflect.Message

func (*TransactionInfo) Reset 

func (x *TransactionInfo) Reset()

func (*TransactionInfo) String 

func (x *TransactionInfo) String() string

type TuneEngineMetadata added in v1.7.0 

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 added in v1.7.0 

func (*TuneEngineMetadata) Descriptor() ([]byte, []int)

Deprecated: Use TuneEngineMetadata.ProtoReflect.Descriptor instead.

func (*TuneEngineMetadata) GetEngine added in v1.7.0 

func (x *TuneEngineMetadata) GetEngine() string

func (*TuneEngineMetadata) ProtoMessage added in v1.7.0 

func (*TuneEngineMetadata) ProtoMessage()

func (*TuneEngineMetadata) ProtoReflect added in v1.7.0 

func (x *TuneEngineMetadata) ProtoReflect() protoreflect.Message

func (*TuneEngineMetadata) Reset added in v1.7.0 

func (x *TuneEngineMetadata) Reset()

func (*TuneEngineMetadata) String added in v1.7.0 

func (x *TuneEngineMetadata) String() string

type TuneEngineRequest added in v1.7.0 

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 added in v1.7.0 

func (*TuneEngineRequest) Descriptor() ([]byte, []int)

Deprecated: Use TuneEngineRequest.ProtoReflect.Descriptor instead.

func (*TuneEngineRequest) GetName added in v1.7.0 

func (x *TuneEngineRequest) GetName() string

func (*TuneEngineRequest) ProtoMessage added in v1.7.0 

func (*TuneEngineRequest) ProtoMessage()

func (*TuneEngineRequest) ProtoReflect added in v1.7.0 

func (x *TuneEngineRequest) ProtoReflect() protoreflect.Message

func (*TuneEngineRequest) Reset added in v1.7.0 

func (x *TuneEngineRequest) Reset()

func (*TuneEngineRequest) String added in v1.7.0 

func (x *TuneEngineRequest) String() string

type TuneEngineResponse added in v1.7.0 

type TuneEngineResponse struct {
	// contains filtered or unexported fields
}

Response associated with a tune operation.

func (*TuneEngineResponse) Descriptor deprecated added in v1.7.0 

func (*TuneEngineResponse) Descriptor() ([]byte, []int)

Deprecated: Use TuneEngineResponse.ProtoReflect.Descriptor instead.

func (*TuneEngineResponse) ProtoMessage added in v1.7.0 

func (*TuneEngineResponse) ProtoMessage()

func (*TuneEngineResponse) ProtoReflect added in v1.7.0 

func (x *TuneEngineResponse) ProtoReflect() protoreflect.Message

func (*TuneEngineResponse) Reset added in v1.7.0 

func (x *TuneEngineResponse) Reset()

func (*TuneEngineResponse) String added in v1.7.0 

func (x *TuneEngineResponse) String() string

type UnimplementedCompletionServiceServer added in v0.3.0 

type UnimplementedCompletionServiceServer struct {
}

UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCompletionServiceServer) CompleteQuery added in v0.3.0 

func (*UnimplementedCompletionServiceServer) CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)

func (*UnimplementedCompletionServiceServer) ImportCompletionSuggestions added in v1.11.0 

func (*UnimplementedCompletionServiceServer) ImportCompletionSuggestions(context.Context, *ImportCompletionSuggestionsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries added in v1.5.0 

func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedCompletionServiceServer) PurgeCompletionSuggestions added in v1.11.0 

func (*UnimplementedCompletionServiceServer) PurgeCompletionSuggestions(context.Context, *PurgeCompletionSuggestionsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries added in v1.5.0 

func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)

type UnimplementedControlServiceServer added in v1.8.0 

type UnimplementedControlServiceServer struct {
}

UnimplementedControlServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedControlServiceServer) CreateControl added in v1.8.0 

func (*UnimplementedControlServiceServer) CreateControl(context.Context, *CreateControlRequest) (*Control, error)

func (*UnimplementedControlServiceServer) DeleteControl added in v1.8.0 

func (*UnimplementedControlServiceServer) DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)

func (*UnimplementedControlServiceServer) GetControl added in v1.8.0 

func (*UnimplementedControlServiceServer) GetControl(context.Context, *GetControlRequest) (*Control, error)

func (*UnimplementedControlServiceServer) ListControls added in v1.8.0 

func (*UnimplementedControlServiceServer) ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)

func (*UnimplementedControlServiceServer) UpdateControl added in v1.8.0 

func (*UnimplementedControlServiceServer) UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)

type UnimplementedConversationalSearchServiceServer added in v1.1.0 

type UnimplementedConversationalSearchServiceServer struct {
}

UnimplementedConversationalSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedConversationalSearchServiceServer) AnswerQuery added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)

func (*UnimplementedConversationalSearchServiceServer) ConverseConversation added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)

func (*UnimplementedConversationalSearchServiceServer) CreateConversation added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)

func (*UnimplementedConversationalSearchServiceServer) CreateSession added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) CreateSession(context.Context, *CreateSessionRequest) (*Session, error)

func (*UnimplementedConversationalSearchServiceServer) DeleteConversation added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)

func (*UnimplementedConversationalSearchServiceServer) DeleteSession added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)

func (*UnimplementedConversationalSearchServiceServer) GetAnswer added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)

func (*UnimplementedConversationalSearchServiceServer) GetConversation added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)

func (*UnimplementedConversationalSearchServiceServer) GetSession added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) GetSession(context.Context, *GetSessionRequest) (*Session, error)

func (*UnimplementedConversationalSearchServiceServer) ListConversations added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)

func (*UnimplementedConversationalSearchServiceServer) ListSessions added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)

func (*UnimplementedConversationalSearchServiceServer) UpdateConversation added in v1.1.0 

func (*UnimplementedConversationalSearchServiceServer) UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)

func (*UnimplementedConversationalSearchServiceServer) UpdateSession added in v1.7.0 

func (*UnimplementedConversationalSearchServiceServer) UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)

type UnimplementedDataStoreServiceServer added in v1.5.0 

type UnimplementedDataStoreServiceServer struct {
}

UnimplementedDataStoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataStoreServiceServer) CreateDataStore added in v1.5.0 

func (*UnimplementedDataStoreServiceServer) CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDataStoreServiceServer) DeleteDataStore added in v1.5.0 

func (*UnimplementedDataStoreServiceServer) DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDataStoreServiceServer) GetDataStore added in v1.5.0 

func (*UnimplementedDataStoreServiceServer) GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)

func (*UnimplementedDataStoreServiceServer) ListDataStores added in v1.5.0 

func (*UnimplementedDataStoreServiceServer) ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)

func (*UnimplementedDataStoreServiceServer) UpdateDataStore added in v1.5.0 

func (*UnimplementedDataStoreServiceServer) UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)

type UnimplementedDocumentServiceServer 

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentServiceServer) BatchGetDocumentsMetadata added in v1.14.0 

func (*UnimplementedDocumentServiceServer) BatchGetDocumentsMetadata(context.Context, *BatchGetDocumentsMetadataRequest) (*BatchGetDocumentsMetadataResponse, error)

func (*UnimplementedDocumentServiceServer) CreateDocument 

func (*UnimplementedDocumentServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)

func (*UnimplementedDocumentServiceServer) DeleteDocument 

func (*UnimplementedDocumentServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)

func (*UnimplementedDocumentServiceServer) GetDocument 

func (*UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)

func (*UnimplementedDocumentServiceServer) ImportDocuments 

func (*UnimplementedDocumentServiceServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDocumentServiceServer) ListDocuments 

func (*UnimplementedDocumentServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

func (*UnimplementedDocumentServiceServer) PurgeDocuments added in v0.3.1 

func (*UnimplementedDocumentServiceServer) PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDocumentServiceServer) UpdateDocument 

func (*UnimplementedDocumentServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)

type UnimplementedEngineServiceServer added in v1.5.0 

type UnimplementedEngineServiceServer struct {
}

UnimplementedEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEngineServiceServer) CreateEngine added in v1.5.0 

func (*UnimplementedEngineServiceServer) CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)

func (*UnimplementedEngineServiceServer) DeleteEngine added in v1.5.0 

func (*UnimplementedEngineServiceServer) DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)

func (*UnimplementedEngineServiceServer) GetEngine added in v1.5.0 

func (*UnimplementedEngineServiceServer) GetEngine(context.Context, *GetEngineRequest) (*Engine, error)

func (*UnimplementedEngineServiceServer) ListEngines added in v1.5.0 

func (*UnimplementedEngineServiceServer) ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)

func (*UnimplementedEngineServiceServer) PauseEngine added in v1.7.0 

func (*UnimplementedEngineServiceServer) PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)

func (*UnimplementedEngineServiceServer) ResumeEngine added in v1.7.0 

func (*UnimplementedEngineServiceServer) ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)

func (*UnimplementedEngineServiceServer) TuneEngine added in v1.7.0 

func (*UnimplementedEngineServiceServer) TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)

func (*UnimplementedEngineServiceServer) UpdateEngine added in v1.5.0 

func (*UnimplementedEngineServiceServer) UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)

type UnimplementedEvaluationServiceServer added in v1.10.0 

type UnimplementedEvaluationServiceServer struct {
}

UnimplementedEvaluationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEvaluationServiceServer) CreateEvaluation added in v1.10.0 

func (*UnimplementedEvaluationServiceServer) CreateEvaluation(context.Context, *CreateEvaluationRequest) (*longrunningpb.Operation, error)

func (*UnimplementedEvaluationServiceServer) GetEvaluation added in v1.10.0 

func (*UnimplementedEvaluationServiceServer) GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)

func (*UnimplementedEvaluationServiceServer) ListEvaluationResults added in v1.10.0 

func (*UnimplementedEvaluationServiceServer) ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)

func (*UnimplementedEvaluationServiceServer) ListEvaluations added in v1.10.0 

func (*UnimplementedEvaluationServiceServer) ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)

type UnimplementedGroundedGenerationServiceServer added in v1.7.0 

type UnimplementedGroundedGenerationServiceServer struct {
}

UnimplementedGroundedGenerationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedGroundedGenerationServiceServer) CheckGrounding added in v1.7.0 

func (*UnimplementedGroundedGenerationServiceServer) CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)

type UnimplementedProjectServiceServer added in v1.8.0 

type UnimplementedProjectServiceServer struct {
}

UnimplementedProjectServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedProjectServiceServer) ProvisionProject added in v1.8.0 

func (*UnimplementedProjectServiceServer) ProvisionProject(context.Context, *ProvisionProjectRequest) (*longrunningpb.Operation, error)

type UnimplementedRankServiceServer added in v1.7.0 

type UnimplementedRankServiceServer struct {
}

UnimplementedRankServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRankServiceServer) Rank added in v1.7.0 

func (*UnimplementedRankServiceServer) Rank(context.Context, *RankRequest) (*RankResponse, error)

type UnimplementedRecommendationServiceServer 

type UnimplementedRecommendationServiceServer struct {
}

UnimplementedRecommendationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecommendationServiceServer) Recommend 

func (*UnimplementedRecommendationServiceServer) Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)

type UnimplementedSampleQueryServiceServer added in v1.10.0 

type UnimplementedSampleQueryServiceServer struct {
}

UnimplementedSampleQueryServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSampleQueryServiceServer) CreateSampleQuery added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) CreateSampleQuery(context.Context, *CreateSampleQueryRequest) (*SampleQuery, error)

func (*UnimplementedSampleQueryServiceServer) DeleteSampleQuery added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) DeleteSampleQuery(context.Context, *DeleteSampleQueryRequest) (*emptypb.Empty, error)

func (*UnimplementedSampleQueryServiceServer) GetSampleQuery added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) GetSampleQuery(context.Context, *GetSampleQueryRequest) (*SampleQuery, error)

func (*UnimplementedSampleQueryServiceServer) ImportSampleQueries added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) ImportSampleQueries(context.Context, *ImportSampleQueriesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSampleQueryServiceServer) ListSampleQueries added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) ListSampleQueries(context.Context, *ListSampleQueriesRequest) (*ListSampleQueriesResponse, error)

func (*UnimplementedSampleQueryServiceServer) UpdateSampleQuery added in v1.10.0 

func (*UnimplementedSampleQueryServiceServer) UpdateSampleQuery(context.Context, *UpdateSampleQueryRequest) (*SampleQuery, error)

type UnimplementedSampleQuerySetServiceServer added in v1.10.0 

type UnimplementedSampleQuerySetServiceServer struct {
}

UnimplementedSampleQuerySetServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSampleQuerySetServiceServer) CreateSampleQuerySet added in v1.10.0 

func (*UnimplementedSampleQuerySetServiceServer) CreateSampleQuerySet(context.Context, *CreateSampleQuerySetRequest) (*SampleQuerySet, error)

func (*UnimplementedSampleQuerySetServiceServer) DeleteSampleQuerySet added in v1.10.0 

func (*UnimplementedSampleQuerySetServiceServer) DeleteSampleQuerySet(context.Context, *DeleteSampleQuerySetRequest) (*emptypb.Empty, error)

func (*UnimplementedSampleQuerySetServiceServer) GetSampleQuerySet added in v1.10.0 

func (*UnimplementedSampleQuerySetServiceServer) GetSampleQuerySet(context.Context, *GetSampleQuerySetRequest) (*SampleQuerySet, error)

func (*UnimplementedSampleQuerySetServiceServer) ListSampleQuerySets added in v1.10.0 

func (*UnimplementedSampleQuerySetServiceServer) ListSampleQuerySets(context.Context, *ListSampleQuerySetsRequest) (*ListSampleQuerySetsResponse, error)

func (*UnimplementedSampleQuerySetServiceServer) UpdateSampleQuerySet added in v1.10.0 

func (*UnimplementedSampleQuerySetServiceServer) UpdateSampleQuerySet(context.Context, *UpdateSampleQuerySetRequest) (*SampleQuerySet, error)

type UnimplementedSchemaServiceServer added in v0.3.0 

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSchemaServiceServer) CreateSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSchemaServiceServer) DeleteSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSchemaServiceServer) GetSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)

func (*UnimplementedSchemaServiceServer) ListSchemas added in v0.3.0 

func (*UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)

func (*UnimplementedSchemaServiceServer) UpdateSchema added in v0.3.0 

func (*UnimplementedSchemaServiceServer) UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)

type UnimplementedSearchServiceServer added in v0.3.0 

type UnimplementedSearchServiceServer struct {
}

UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchServiceServer) Search added in v0.3.0 

func (*UnimplementedSearchServiceServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)

type UnimplementedSearchTuningServiceServer added in v1.6.0 

type UnimplementedSearchTuningServiceServer struct {
}

UnimplementedSearchTuningServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchTuningServiceServer) ListCustomModels added in v1.8.0 

func (*UnimplementedSearchTuningServiceServer) ListCustomModels(context.Context, *ListCustomModelsRequest) (*ListCustomModelsResponse, error)

func (*UnimplementedSearchTuningServiceServer) TrainCustomModel added in v1.6.0 

func (*UnimplementedSearchTuningServiceServer) TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)

type UnimplementedServingConfigServiceServer added in v1.5.0 

type UnimplementedServingConfigServiceServer struct {
}

UnimplementedServingConfigServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedServingConfigServiceServer) GetServingConfig added in v1.5.0 

func (*UnimplementedServingConfigServiceServer) GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)

func (*UnimplementedServingConfigServiceServer) ListServingConfigs added in v1.5.0 

func (*UnimplementedServingConfigServiceServer) ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig added in v1.5.0 

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)

type UnimplementedSiteSearchEngineServiceServer added in v1.5.0 

type UnimplementedSiteSearchEngineServiceServer struct {
}

UnimplementedSiteSearchEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites(context.Context, *BatchVerifyTargetSitesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch(context.Context, *DisableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch(context.Context, *EnableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus(context.Context, *FetchDomainVerificationStatusRequest) (*FetchDomainVerificationStatusResponse, error)

func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)

func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)

func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)

func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris(context.Context, *RecrawlUrisRequest) (*longrunningpb.Operation, error)

func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite added in v1.5.0 

func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)

type UnimplementedUserEventServiceServer 

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent 

func (*UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)

func (*UnimplementedUserEventServiceServer) ImportUserEvents 

func (*UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) PurgeUserEvents added in v1.11.0 

func (*UnimplementedUserEventServiceServer) PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) WriteUserEvent 

func (*UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)

type UpdateControlRequest added in v1.8.0 

type UpdateControlRequest struct {

	// Required. The Control to update.
	Control *Control `protobuf:"bytes,1,opt,name=control,proto3" json:"control,omitempty"`
	// Optional. Indicates which fields in the provided
	// [Control][google.cloud.discoveryengine.v1beta.Control] to update. The
	// following are NOT supported:
	//
	// * [Control.name][google.cloud.discoveryengine.v1beta.Control.name]
	// * [Control.solution_type][google.cloud.discoveryengine.v1beta.Control.solution_type]
	//
	// 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 UpdateControl method.

func (*UpdateControlRequest) Descriptor deprecated added in v1.8.0 

func (*UpdateControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateControlRequest.ProtoReflect.Descriptor instead.

func (*UpdateControlRequest) GetControl added in v1.8.0 

func (x *UpdateControlRequest) GetControl() *Control

func (*UpdateControlRequest) GetUpdateMask added in v1.8.0 

func (x *UpdateControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateControlRequest) ProtoMessage added in v1.8.0 

func (*UpdateControlRequest) ProtoMessage()

func (*UpdateControlRequest) ProtoReflect added in v1.8.0 

func (x *UpdateControlRequest) ProtoReflect() protoreflect.Message

func (*UpdateControlRequest) Reset added in v1.8.0 

func (x *UpdateControlRequest) Reset()

func (*UpdateControlRequest) String added in v1.8.0 

func (x *UpdateControlRequest) String() string

type UpdateConversationRequest added in v1.1.0 

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.v1beta.Conversation] to update.
	// The following are NOT supported:
	//
	// * [Conversation.name][google.cloud.discoveryengine.v1beta.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 added in v1.1.0 

func (*UpdateConversationRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateConversationRequest.ProtoReflect.Descriptor instead.

func (*UpdateConversationRequest) GetConversation added in v1.1.0 

func (x *UpdateConversationRequest) GetConversation() *Conversation

func (*UpdateConversationRequest) GetUpdateMask added in v1.1.0 

func (x *UpdateConversationRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateConversationRequest) ProtoMessage added in v1.1.0 

func (*UpdateConversationRequest) ProtoMessage()

func (*UpdateConversationRequest) ProtoReflect added in v1.1.0 

func (x *UpdateConversationRequest) ProtoReflect() protoreflect.Message

func (*UpdateConversationRequest) Reset added in v1.1.0 

func (x *UpdateConversationRequest) Reset()

func (*UpdateConversationRequest) String added in v1.1.0 

func (x *UpdateConversationRequest) String() string

type UpdateDataStoreRequest added in v1.5.0 

type UpdateDataStoreRequest struct {

	// Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
	// update.
	//
	// If the caller does not have permission to update the
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.DataStoreService.UpdateDataStore] method.

func (*UpdateDataStoreRequest) Descriptor deprecated added in v1.5.0 

func (*UpdateDataStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataStoreRequest) GetDataStore added in v1.5.0 

func (x *UpdateDataStoreRequest) GetDataStore() *DataStore

func (*UpdateDataStoreRequest) GetUpdateMask added in v1.5.0 

func (x *UpdateDataStoreRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDataStoreRequest) ProtoMessage added in v1.5.0 

func (*UpdateDataStoreRequest) ProtoMessage()

func (*UpdateDataStoreRequest) ProtoReflect added in v1.5.0 

func (x *UpdateDataStoreRequest) ProtoReflect() protoreflect.Message

func (*UpdateDataStoreRequest) Reset added in v1.5.0 

func (x *UpdateDataStoreRequest) Reset()

func (*UpdateDataStoreRequest) String added in v1.5.0 

func (x *UpdateDataStoreRequest) String() string

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {

	// Required. The document to update/create.
	//
	// If the caller does not have permission to update the
	// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
	// does not exist and
	// [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
	// is not set, a `NOT_FOUND` error is returned.
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// If set to `true` and the
	// [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
	// new [Document][google.cloud.discoveryengine.v1beta.Document] is 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, by default updates 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.v1beta.DocumentService.UpdateDocument] method.

func (*UpdateDocumentRequest) Descriptor deprecated 

func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentRequest) GetAllowMissing 

func (x *UpdateDocumentRequest) GetAllowMissing() bool

func (*UpdateDocumentRequest) GetDocument 

func (x *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) GetUpdateMask added in v1.7.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 added in v1.5.0 

type UpdateEngineRequest struct {

	// Required. The [Engine][google.cloud.discoveryengine.v1beta.Engine] to
	// update.
	//
	// If the caller does not have permission to update the
	// [Engine][google.cloud.discoveryengine.v1beta.Engine], regardless of whether
	// or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.EngineService.UpdateEngine] method.

func (*UpdateEngineRequest) Descriptor deprecated added in v1.5.0 

func (*UpdateEngineRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateEngineRequest.ProtoReflect.Descriptor instead.

func (*UpdateEngineRequest) GetEngine added in v1.5.0 

func (x *UpdateEngineRequest) GetEngine() *Engine

func (*UpdateEngineRequest) GetUpdateMask added in v1.5.0 

func (x *UpdateEngineRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateEngineRequest) ProtoMessage added in v1.5.0 

func (*UpdateEngineRequest) ProtoMessage()

func (*UpdateEngineRequest) ProtoReflect added in v1.5.0 

func (x *UpdateEngineRequest) ProtoReflect() protoreflect.Message

func (*UpdateEngineRequest) Reset added in v1.5.0 

func (x *UpdateEngineRequest) Reset()

func (*UpdateEngineRequest) String added in v1.5.0 

func (x *UpdateEngineRequest) String() string

type UpdateSampleQueryRequest added in v1.10.0 

type UpdateSampleQueryRequest struct {

	// Required. The simple query to update.
	//
	// If the caller does not have permission to update the
	// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
	// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to
	// update does not exist a `NOT_FOUND` error is returned.
	SampleQuery *SampleQuery `protobuf:"bytes,1,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
	// Indicates which fields in the provided imported 'simple query' to update.
	// If not set, will by default update all fields.
	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 [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] method.

func (*UpdateSampleQueryRequest) Descriptor deprecated added in v1.10.0 

func (*UpdateSampleQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*UpdateSampleQueryRequest) GetSampleQuery added in v1.10.0 

func (x *UpdateSampleQueryRequest) GetSampleQuery() *SampleQuery

func (*UpdateSampleQueryRequest) GetUpdateMask added in v1.10.0 

func (x *UpdateSampleQueryRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*UpdateSampleQueryRequest) ProtoMessage()

func (*UpdateSampleQueryRequest) ProtoReflect added in v1.10.0 

func (x *UpdateSampleQueryRequest) ProtoReflect() protoreflect.Message

func (*UpdateSampleQueryRequest) Reset added in v1.10.0 

func (x *UpdateSampleQueryRequest) Reset()

func (*UpdateSampleQueryRequest) String added in v1.10.0 

func (x *UpdateSampleQueryRequest) String() string

type UpdateSampleQuerySetRequest added in v1.10.0 

type UpdateSampleQuerySetRequest struct {

	// Required. The sample query set to update.
	//
	// If the caller does not have permission to update the
	// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
	// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
	// returned.
	//
	// If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
	// to update does not exist a `NOT_FOUND` error is returned.
	SampleQuerySet *SampleQuerySet `protobuf:"bytes,1,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
	// Indicates which fields in the provided imported 'sample query set' to
	// update. If not set, will by default update all fields.
	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 [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] method.

func (*UpdateSampleQuerySetRequest) Descriptor deprecated added in v1.10.0 

func (*UpdateSampleQuerySetRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*UpdateSampleQuerySetRequest) GetSampleQuerySet added in v1.10.0 

func (x *UpdateSampleQuerySetRequest) GetSampleQuerySet() *SampleQuerySet

func (*UpdateSampleQuerySetRequest) GetUpdateMask added in v1.10.0 

func (x *UpdateSampleQuerySetRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*UpdateSampleQuerySetRequest) ProtoMessage()

func (*UpdateSampleQuerySetRequest) ProtoReflect added in v1.10.0 

func (x *UpdateSampleQuerySetRequest) ProtoReflect() protoreflect.Message

func (*UpdateSampleQuerySetRequest) Reset added in v1.10.0 

func (x *UpdateSampleQuerySetRequest) Reset()

func (*UpdateSampleQuerySetRequest) String added in v1.10.0 

func (x *UpdateSampleQuerySetRequest) String() string

type UpdateSchemaMetadata added in v0.3.0 

type UpdateSchemaMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for UpdateSchema LRO.

func (*UpdateSchemaMetadata) Descriptor deprecated added in v0.3.0 

func (*UpdateSchemaMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*UpdateSchemaMetadata) GetCreateTime added in v0.3.0 

func (x *UpdateSchemaMetadata) GetCreateTime() *timestamppb.Timestamp

func (*UpdateSchemaMetadata) GetUpdateTime added in v0.3.0 

func (x *UpdateSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*UpdateSchemaMetadata) ProtoMessage added in v0.3.0 

func (*UpdateSchemaMetadata) ProtoMessage()

func (*UpdateSchemaMetadata) ProtoReflect added in v0.3.0 

func (x *UpdateSchemaMetadata) ProtoReflect() protoreflect.Message

func (*UpdateSchemaMetadata) Reset added in v0.3.0 

func (x *UpdateSchemaMetadata) Reset()

func (*UpdateSchemaMetadata) String added in v0.3.0 

func (x *UpdateSchemaMetadata) String() string

type UpdateSchemaRequest added in v0.3.0 

type UpdateSchemaRequest struct {

	// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
	// update.
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	// If set to true, and the
	// [Schema][google.cloud.discoveryengine.v1beta.Schema] is not found, a new
	// [Schema][google.cloud.discoveryengine.v1beta.Schema] is created. In this
	// situation, `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.

func (*UpdateSchemaRequest) Descriptor deprecated added in v0.3.0 

func (*UpdateSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSchemaRequest.ProtoReflect.Descriptor instead.

func (*UpdateSchemaRequest) GetAllowMissing added in v0.3.0 

func (x *UpdateSchemaRequest) GetAllowMissing() bool

func (*UpdateSchemaRequest) GetSchema added in v0.3.0 

func (x *UpdateSchemaRequest) GetSchema() *Schema

func (*UpdateSchemaRequest) ProtoMessage added in v0.3.0 

func (*UpdateSchemaRequest) ProtoMessage()

func (*UpdateSchemaRequest) ProtoReflect added in v0.3.0 

func (x *UpdateSchemaRequest) ProtoReflect() protoreflect.Message

func (*UpdateSchemaRequest) Reset added in v0.3.0 

func (x *UpdateSchemaRequest) Reset()

func (*UpdateSchemaRequest) String added in v0.3.0 

func (x *UpdateSchemaRequest) String() string

type UpdateServingConfigRequest added in v1.5.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.v1beta.ServingConfig] to
	// update. The following are NOT supported:
	//
	// * [ServingConfig.name][google.cloud.discoveryengine.v1beta.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.5.0 

func (*UpdateServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateServingConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateServingConfigRequest) GetServingConfig added in v1.5.0 

func (x *UpdateServingConfigRequest) GetServingConfig() *ServingConfig

func (*UpdateServingConfigRequest) GetUpdateMask added in v1.5.0 

func (x *UpdateServingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateServingConfigRequest) ProtoMessage added in v1.5.0 

func (*UpdateServingConfigRequest) ProtoMessage()

func (*UpdateServingConfigRequest) ProtoReflect added in v1.5.0 

func (x *UpdateServingConfigRequest) ProtoReflect() protoreflect.Message

func (*UpdateServingConfigRequest) Reset added in v1.5.0 

func (x *UpdateServingConfigRequest) Reset()

func (*UpdateServingConfigRequest) String added in v1.5.0 

func (x *UpdateServingConfigRequest) String() string

type UpdateSessionRequest added in v1.7.0 

type UpdateSessionRequest struct {

	// Required. The Session to update.
	Session *Session `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// Indicates which fields in the provided
	// [Session][google.cloud.discoveryengine.v1beta.Session] to update. The
	// following are NOT supported:
	//
	// * [Session.name][google.cloud.discoveryengine.v1beta.Session.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 UpdateSession method.

func (*UpdateSessionRequest) Descriptor deprecated added in v1.7.0 

func (*UpdateSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSessionRequest.ProtoReflect.Descriptor instead.

func (*UpdateSessionRequest) GetSession added in v1.7.0 

func (x *UpdateSessionRequest) GetSession() *Session

func (*UpdateSessionRequest) GetUpdateMask added in v1.7.0 

func (x *UpdateSessionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSessionRequest) ProtoMessage added in v1.7.0 

func (*UpdateSessionRequest) ProtoMessage()

func (*UpdateSessionRequest) ProtoReflect added in v1.7.0 

func (x *UpdateSessionRequest) ProtoReflect() protoreflect.Message

func (*UpdateSessionRequest) Reset added in v1.7.0 

func (x *UpdateSessionRequest) Reset()

func (*UpdateSessionRequest) String added in v1.7.0 

func (x *UpdateSessionRequest) String() string

type UpdateTargetSiteMetadata added in v1.5.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.v1beta.SiteSearchEngineService.UpdateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*UpdateTargetSiteMetadata) Descriptor deprecated added in v1.5.0 

func (*UpdateTargetSiteMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*UpdateTargetSiteMetadata) GetCreateTime added in v1.5.0 

func (x *UpdateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestamp

func (*UpdateTargetSiteMetadata) GetUpdateTime added in v1.5.0 

func (x *UpdateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*UpdateTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*UpdateTargetSiteMetadata) ProtoMessage()

func (*UpdateTargetSiteMetadata) ProtoReflect added in v1.5.0 

func (x *UpdateTargetSiteMetadata) ProtoReflect() protoreflect.Message

func (*UpdateTargetSiteMetadata) Reset added in v1.5.0 

func (x *UpdateTargetSiteMetadata) Reset()

func (*UpdateTargetSiteMetadata) String added in v1.5.0 

func (x *UpdateTargetSiteMetadata) String() string

type UpdateTargetSiteRequest added in v1.5.0 

type UpdateTargetSiteRequest struct {

	// Required. The target site to update.
	// If the caller does not have permission to update the
	// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [TargetSite][google.cloud.discoveryengine.v1beta.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.v1beta.SiteSearchEngineService.UpdateTargetSite] method.

func (*UpdateTargetSiteRequest) Descriptor deprecated added in v1.5.0 

func (*UpdateTargetSiteRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*UpdateTargetSiteRequest) GetTargetSite added in v1.5.0 

func (x *UpdateTargetSiteRequest) GetTargetSite() *TargetSite

func (*UpdateTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*UpdateTargetSiteRequest) ProtoMessage()

func (*UpdateTargetSiteRequest) ProtoReflect added in v1.5.0 

func (x *UpdateTargetSiteRequest) ProtoReflect() protoreflect.Message

func (*UpdateTargetSiteRequest) Reset added in v1.5.0 

func (x *UpdateTargetSiteRequest) Reset()

func (*UpdateTargetSiteRequest) String added in v1.5.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"`
	// The [Engine][google.cloud.discoveryengine.v1beta.Engine] resource name, in
	// the form of
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
	//
	// Optional. Only required for
	// [Engine][google.cloud.discoveryengine.v1beta.Engine] produced user events.
	// For example, user events from blended search.
	Engine string `protobuf:"bytes,19,opt,name=engine,proto3" json:"engine,omitempty"`
	// The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] resource
	// full name, of the form
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	//
	// Optional. Only required for user events whose data store can't by
	// determined by
	// [UserEvent.engine][google.cloud.discoveryengine.v1beta.UserEvent.engine] or
	// [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents].
	// If data store is set in the parent of write/import/collect user event
	// requests, this field can be omitted.
	DataStore string `protobuf:"bytes,20,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Only required for
	// [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
	// method. Timestamp of when the user event happened.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// Information about the end user.
	UserInfo *UserInfo `protobuf:"bytes,4,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// Should set to true if the request is made directly from the end user, in
	// which case the
	// [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
	// can be populated from the HTTP request.
	//
	// This flag should be set only if the API request is made directly from the
	// end user such as a mobile app (and not if a gateway or a server is
	// processing and pushing the user events).
	//
	// This should not be set when using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent].
	DirectUserRequest bool `protobuf:"varint,5,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
	// A unique identifier for tracking a visitor session with a length limit of
	// 128 bytes. A session is an aggregation of an end user behavior in a time
	// span.
	//
	// A general guideline to populate the session_id:
	//
	// 1. If user has no activity for 30 min, a new session_id should be assigned.
	// 2. The session_id should be unique across users, suggest use uuid or add
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
	// as prefix.
	SessionId string `protobuf:"bytes,6,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// Page metadata such as categories and other critical information for certain
	// event types such as `view-category-page`.
	PageInfo *PageInfo `protobuf:"bytes,7,opt,name=page_info,json=pageInfo,proto3" json:"page_info,omitempty"`
	// Token to attribute an API response to user action(s) to trigger the event.
	//
	// Highly recommended for user events that are the result of
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
	// This field enables accurate attribution of recommendation model
	// performance.
	//
	// The value must be one of:
	//
	// * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
	// * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search].
	//
	// 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.v1beta.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.v1beta.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.v1beta.SearchRequest] may
	// contain a filter expression in
	// [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
	// conforming to https://google.aip.dev/160#filtering.
	//
	// Similarly, for `view-item-list` events that are generated from a
	// [RecommendRequest][google.cloud.discoveryengine.v1beta.RecommendRequest],
	// this field may be populated directly from
	// [RecommendRequest.filter][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.UserEvent.documents]
	// is desired.
	Documents []*DocumentInfo `protobuf:"bytes,10,rep,name=documents,proto3" json:"documents,omitempty"`
	// Panel metadata associated with this user event.
	Panel *PanelInfo `protobuf:"bytes,11,opt,name=panel,proto3" json:"panel,omitempty"`
	// [SearchService.Search][google.cloud.discoveryengine.v1beta.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.v1beta.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.
	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 your 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) GetDataStore added in v1.8.0 

func (x *UserEvent) GetDataStore() string

func (*UserEvent) GetDirectUserRequest 

func (x *UserEvent) GetDirectUserRequest() bool

func (*UserEvent) GetDocuments 

func (x *UserEvent) GetDocuments() []*DocumentInfo

func (*UserEvent) GetEngine added in v1.8.0 

func (x *UserEvent) GetEngine() string

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.

func NewUserEventServiceClient 

func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClient

type UserEventServiceServer 

type UserEventServiceServer interface {
	// Writes a single user event.
	WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a 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.v1beta.UserEventService.CollectUserEvent]
	// or if
	// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
	// is set.
	UserAgent string `protobuf:"bytes,2,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// contains filtered or unexported fields
}

Information of an end user.

func (*UserInfo) Descriptor deprecated 

func (*UserInfo) Descriptor() ([]byte, []int)

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetUserAgent 

func (x *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId 

func (x *UserInfo) GetUserId() string

func (*UserInfo) ProtoMessage 

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect 

func (x *UserInfo) ProtoReflect() protoreflect.Message

func (*UserInfo) Reset 

func (x *UserInfo) Reset()

func (*UserInfo) String 

func (x *UserInfo) String() string

type WriteUserEventRequest 

type WriteUserEventRequest struct {

	// Required. The parent resource name.
	// If the write user event action is applied in
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] level, the
	// format is:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	// If the write user event action is applied in [Location][] level, for
	// example, the event with
	// [Document][google.cloud.discoveryengine.v1beta.Document] across multiple
	// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], the format is:
	// `projects/{project}/locations/{location}`.
	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"`
	// If set to true, the user event is written asynchronously after
	// validation, and the API responds without waiting for the write.
	WriteAsync bool `protobuf:"varint,3,opt,name=write_async,json=writeAsync,proto3" json:"write_async,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) GetWriteAsync added in v1.8.0 

func (x *WriteUserEventRequest) GetWriteAsync() bool

func (*WriteUserEventRequest) ProtoMessage 

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) ProtoReflect 

func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Message

func (*WriteUserEventRequest) Reset 

func (x *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String 

func (x *WriteUserEventRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.