Variables
Answer_State_name, Answer_State_value
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.
Answer_AnswerSkippedReason_name, Answer_AnswerSkippedReason_value
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",
}
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,
}
)
Enum value maps for Answer_AnswerSkippedReason.
Answer_Step_State_name, Answer_Step_State_value
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.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name, Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value
var (
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ADVERSARIAL_QUERY",
2: "NON_ANSWER_SEEKING_QUERY",
}
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
}
)
Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.
IndustryVertical_name, IndustryVertical_value
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.
SolutionType_name, SolutionType_value
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.
SearchTier_name, SearchTier_value
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.
SearchAddOn_name, SearchAddOn_value
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.
SuggestionDenyListEntry_MatchOperator_name, SuggestionDenyListEntry_MatchOperator_value
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.
Conversation_State_name, Conversation_State_value
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.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value
var (
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ADVERSARIAL_QUERY",
2: "NON_ANSWER_SEEKING_QUERY",
}
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
}
)
Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.
DataStore_ContentConfig_name, DataStore_ContentConfig_value
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.
BigtableOptions_Type_name, BigtableOptions_Type_value
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.
BigtableOptions_Encoding_name, BigtableOptions_Encoding_value
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.
ImportDocumentsRequest_ReconciliationMode_name, ImportDocumentsRequest_ReconciliationMode_value
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.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value
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.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value
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.
SearchRequest_QueryExpansionSpec_Condition_name, SearchRequest_QueryExpansionSpec_Condition_value
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.
SearchRequest_SpellCorrectionSpec_Mode_name, SearchRequest_SpellCorrectionSpec_Mode_value
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.
SearchResponse_Summary_SummarySkippedReason_name, SearchResponse_Summary_SummarySkippedReason_value
var (
SearchResponse_Summary_SummarySkippedReason_name = map[int32]string{
0: "SUMMARY_SKIPPED_REASON_UNSPECIFIED",
1: "ADVERSARIAL_QUERY_IGNORED",
2: "NON_SUMMARY_SEEKING_QUERY_IGNORED",
3: "OUT_OF_DOMAIN_QUERY_IGNORED",
4: "POTENTIAL_POLICY_VIOLATION",
5: "LLM_ADDON_NOT_ENABLED",
}
SearchResponse_Summary_SummarySkippedReason_value = map[string]int32{
"SUMMARY_SKIPPED_REASON_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY_IGNORED": 1,
"NON_SUMMARY_SEEKING_QUERY_IGNORED": 2,
"OUT_OF_DOMAIN_QUERY_IGNORED": 3,
"POTENTIAL_POLICY_VIOLATION": 4,
"LLM_ADDON_NOT_ENABLED": 5,
}
)
Enum value maps for SearchResponse_Summary_SummarySkippedReason.
Session_State_name, Session_State_value
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.
TargetSite_Type_name, TargetSite_Type_value
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.
TargetSite_IndexingStatus_name, TargetSite_IndexingStatus_value
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.
SiteVerificationInfo_SiteVerificationState_name, SiteVerificationInfo_SiteVerificationState_value
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.
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name, RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value
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.
File_google_cloud_discoveryengine_v1beta_answer_proto
var File_google_cloud_discoveryengine_v1beta_answer_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_common_proto
var File_google_cloud_discoveryengine_v1beta_common_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_completion_proto
var File_google_cloud_discoveryengine_v1beta_completion_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_completion_service_proto
var File_google_cloud_discoveryengine_v1beta_completion_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_conversation_proto
var File_google_cloud_discoveryengine_v1beta_conversation_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_conversational_search_service_proto
var File_google_cloud_discoveryengine_v1beta_conversational_search_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_data_store_proto
var File_google_cloud_discoveryengine_v1beta_data_store_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_data_store_service_proto
var File_google_cloud_discoveryengine_v1beta_data_store_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_document_processing_config_proto
var File_google_cloud_discoveryengine_v1beta_document_processing_config_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_document_proto
var File_google_cloud_discoveryengine_v1beta_document_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_document_service_proto
var File_google_cloud_discoveryengine_v1beta_document_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_engine_proto
var File_google_cloud_discoveryengine_v1beta_engine_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_engine_service_proto
var File_google_cloud_discoveryengine_v1beta_engine_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_grounded_generation_service_proto
var File_google_cloud_discoveryengine_v1beta_grounded_generation_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_grounding_proto
var File_google_cloud_discoveryengine_v1beta_grounding_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_import_config_proto
var File_google_cloud_discoveryengine_v1beta_import_config_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_purge_config_proto
var File_google_cloud_discoveryengine_v1beta_purge_config_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_rank_service_proto
var File_google_cloud_discoveryengine_v1beta_rank_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_recommendation_service_proto
var File_google_cloud_discoveryengine_v1beta_recommendation_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_schema_proto
var File_google_cloud_discoveryengine_v1beta_schema_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_schema_service_proto
var File_google_cloud_discoveryengine_v1beta_schema_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_search_service_proto
var File_google_cloud_discoveryengine_v1beta_search_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_search_tuning_service_proto
var File_google_cloud_discoveryengine_v1beta_search_tuning_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_serving_config_proto
var File_google_cloud_discoveryengine_v1beta_serving_config_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_serving_config_service_proto
var File_google_cloud_discoveryengine_v1beta_serving_config_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_session_proto
var File_google_cloud_discoveryengine_v1beta_session_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_site_search_engine_proto
var File_google_cloud_discoveryengine_v1beta_site_search_engine_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_site_search_engine_service_proto
var File_google_cloud_discoveryengine_v1beta_site_search_engine_service_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_user_event_proto
var File_google_cloud_discoveryengine_v1beta_user_event_proto protoreflect.FileDescriptor
File_google_cloud_discoveryengine_v1beta_user_event_service_proto
var File_google_cloud_discoveryengine_v1beta_user_event_service_proto protoreflect.FileDescriptor
Functions
func RegisterCompletionServiceServer
func RegisterCompletionServiceServer(s *grpc.Server, srv CompletionServiceServer)
func RegisterConversationalSearchServiceServer
func RegisterConversationalSearchServiceServer(s *grpc.Server, srv ConversationalSearchServiceServer)
func RegisterDataStoreServiceServer
func RegisterDataStoreServiceServer(s *grpc.Server, srv DataStoreServiceServer)
func RegisterDocumentServiceServer
func RegisterDocumentServiceServer(s *grpc.Server, srv DocumentServiceServer)
func RegisterEngineServiceServer
func RegisterEngineServiceServer(s *grpc.Server, srv EngineServiceServer)
func RegisterGroundedGenerationServiceServer
func RegisterGroundedGenerationServiceServer(s *grpc.Server, srv GroundedGenerationServiceServer)
func RegisterRankServiceServer
func RegisterRankServiceServer(s *grpc.Server, srv RankServiceServer)
func RegisterRecommendationServiceServer
func RegisterRecommendationServiceServer(s *grpc.Server, srv RecommendationServiceServer)
func RegisterSchemaServiceServer
func RegisterSchemaServiceServer(s *grpc.Server, srv SchemaServiceServer)
func RegisterSearchServiceServer
func RegisterSearchServiceServer(s *grpc.Server, srv SearchServiceServer)
func RegisterSearchTuningServiceServer
func RegisterSearchTuningServiceServer(s *grpc.Server, srv SearchTuningServiceServer)
func RegisterServingConfigServiceServer
func RegisterServingConfigServiceServer(s *grpc.Server, srv ServingConfigServiceServer)
func RegisterSiteSearchEngineServiceServer
func RegisterSiteSearchEngineServiceServer(s *grpc.Server, srv SiteSearchEngineServiceServer)
func RegisterUserEventServiceServer
func RegisterUserEventServiceServer(s *grpc.Server, srv UserEventServiceServer)
Answer
type Answer struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
State Answer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_State" json:"state,omitempty"`
AnswerText string `protobuf:"bytes,3,opt,name=answer_text,json=answerText,proto3" json:"answer_text,omitempty"`
Citations []*Answer_Citation `protobuf:"bytes,4,rep,name=citations,proto3" json:"citations,omitempty"`
References []*Answer_Reference `protobuf:"bytes,5,rep,name=references,proto3" json:"references,omitempty"`
RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
Steps []*Answer_Step `protobuf:"bytes,7,rep,name=steps,proto3" json:"steps,omitempty"`
QueryUnderstandingInfo *Answer_QueryUnderstandingInfo "" /* 130 byte string literal not displayed */
AnswerSkippedReasons []Answer_AnswerSkippedReason "" /* 200 byte string literal not displayed */
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
CompleteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
}
Defines an answer.
func (*Answer) Descriptor
Deprecated: Use Answer.ProtoReflect.Descriptor instead.
func (*Answer) GetAnswerSkippedReasons
func (x *Answer) GetAnswerSkippedReasons() []Answer_AnswerSkippedReason
func (*Answer) GetAnswerText
func (*Answer) GetCitations
func (x *Answer) GetCitations() []*Answer_Citation
func (*Answer) GetCompleteTime
func (x *Answer) GetCompleteTime() *timestamppb.Timestamp
func (*Answer) GetCreateTime
func (x *Answer) GetCreateTime() *timestamppb.Timestamp
func (*Answer) GetName
func (*Answer) GetQueryUnderstandingInfo
func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfo
func (*Answer) GetReferences
func (x *Answer) GetReferences() []*Answer_Reference
func (*Answer) GetRelatedQuestions
func (*Answer) GetState
func (x *Answer) GetState() Answer_State
func (*Answer) GetSteps
func (x *Answer) GetSteps() []*Answer_Step
func (*Answer) ProtoMessage
func (*Answer) ProtoMessage()
func (*Answer) ProtoReflect
func (x *Answer) ProtoReflect() protoreflect.Message
func (*Answer) Reset
func (x *Answer) Reset()
func (*Answer) String
AnswerQueryRequest
type AnswerQueryRequest struct {
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
AnswerGenerationSpec *AnswerQueryRequest_AnswerGenerationSpec `protobuf:"bytes,7,opt,name=answer_generation_spec,json=answerGenerationSpec,proto3" json:"answer_generation_spec,omitempty"`
SearchSpec *AnswerQueryRequest_SearchSpec `protobuf:"bytes,8,opt,name=search_spec,json=searchSpec,proto3" json:"search_spec,omitempty"`
QueryUnderstandingSpec *AnswerQueryRequest_QueryUnderstandingSpec "" /* 129 byte string literal not displayed */
AsynchronousMode bool `protobuf:"varint,10,opt,name=asynchronous_mode,json=asynchronousMode,proto3" json:"asynchronous_mode,omitempty"`
UserPseudoId string `protobuf:"bytes,12,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
}
Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
func (*AnswerQueryRequest) Descriptor
func (*AnswerQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest) GetAnswerGenerationSpec
func (x *AnswerQueryRequest) GetAnswerGenerationSpec() *AnswerQueryRequest_AnswerGenerationSpec
func (*AnswerQueryRequest) GetAsynchronousMode
func (x *AnswerQueryRequest) GetAsynchronousMode() bool
func (*AnswerQueryRequest) GetQuery
func (x *AnswerQueryRequest) GetQuery() *Query
func (*AnswerQueryRequest) GetQueryUnderstandingSpec
func (x *AnswerQueryRequest) GetQueryUnderstandingSpec() *AnswerQueryRequest_QueryUnderstandingSpec
func (*AnswerQueryRequest) GetRelatedQuestionsSpec
func (x *AnswerQueryRequest) GetRelatedQuestionsSpec() *AnswerQueryRequest_RelatedQuestionsSpec
func (*AnswerQueryRequest) GetSafetySpec
func (x *AnswerQueryRequest) GetSafetySpec() *AnswerQueryRequest_SafetySpec
func (*AnswerQueryRequest) GetSearchSpec
func (x *AnswerQueryRequest) GetSearchSpec() *AnswerQueryRequest_SearchSpec
func (*AnswerQueryRequest) GetServingConfig
func (x *AnswerQueryRequest) GetServingConfig() string
func (*AnswerQueryRequest) GetSession
func (x *AnswerQueryRequest) GetSession() string
func (*AnswerQueryRequest) GetUserPseudoId
func (x *AnswerQueryRequest) GetUserPseudoId() string
func (*AnswerQueryRequest) ProtoMessage
func (*AnswerQueryRequest) ProtoMessage()
func (*AnswerQueryRequest) ProtoReflect
func (x *AnswerQueryRequest) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest) Reset
func (x *AnswerQueryRequest) Reset()
func (*AnswerQueryRequest) String
func (x *AnswerQueryRequest) String() string
AnswerQueryRequest_AnswerGenerationSpec
type AnswerQueryRequest_AnswerGenerationSpec struct {
ModelSpec *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec `protobuf:"bytes,1,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
PromptSpec *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec `protobuf:"bytes,2,opt,name=prompt_spec,json=promptSpec,proto3" json:"prompt_spec,omitempty"`
IncludeCitations bool `protobuf:"varint,3,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
AnswerLanguageCode string `protobuf:"bytes,4,opt,name=answer_language_code,json=answerLanguageCode,proto3" json:"answer_language_code,omitempty"`
IgnoreAdversarialQuery bool "" /* 130 byte string literal not displayed */
IgnoreNonAnswerSeekingQuery bool "" /* 149 byte string literal not displayed */
}
Answer generation specification.
func (*AnswerQueryRequest_AnswerGenerationSpec) Descriptor
func (*AnswerQueryRequest_AnswerGenerationSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode() string
func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery() bool
func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery() bool
func (*AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations() bool
func (*AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec() *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec
func (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec() *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec
func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage()
func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_AnswerGenerationSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec) Reset()
func (*AnswerQueryRequest_AnswerGenerationSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec) String() string
AnswerQueryRequest_AnswerGenerationSpec_ModelSpec
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
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion() string
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage()
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset()
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String() string
AnswerQueryRequest_AnswerGenerationSpec_PromptSpec
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
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble() string
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage()
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset()
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String() string
AnswerQueryRequest_QueryUnderstandingSpec
type AnswerQueryRequest_QueryUnderstandingSpec struct {
QueryClassificationSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec "" /* 132 byte string literal not displayed */
QueryRephraserSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec `protobuf:"bytes,2,opt,name=query_rephraser_spec,json=queryRephraserSpec,proto3" json:"query_rephraser_spec,omitempty"`
}
Query understanding specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec
func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec
func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec
func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec
func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage()
func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_QueryUnderstandingSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec) Reset()
func (*AnswerQueryRequest_QueryUnderstandingSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec) String() string
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec
type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {
Types []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type "" /* 183 byte string literal not displayed */
}
Query classification specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes() []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage()
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset()
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String() string
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type
type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type int32
Query classification types.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY
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
)
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor() protoreflect.EnumDescriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number() protoreflect.EnumNumber
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String() string
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type() protoreflect.EnumType
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec
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 10 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
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable() bool
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps() int32
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage()
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset()
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String() string
AnswerQueryRequest_RelatedQuestionsSpec
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
func (*AnswerQueryRequest_RelatedQuestionsSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_RelatedQuestionsSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_RelatedQuestionsSpec) GetEnable
func (x *AnswerQueryRequest_RelatedQuestionsSpec) GetEnable() bool
func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage
func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage()
func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect
func (x *AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_RelatedQuestionsSpec) Reset
func (x *AnswerQueryRequest_RelatedQuestionsSpec) Reset()
func (*AnswerQueryRequest_RelatedQuestionsSpec) String
func (x *AnswerQueryRequest_RelatedQuestionsSpec) String() string
AnswerQueryRequest_SafetySpec
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
func (*AnswerQueryRequest_SafetySpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SafetySpec) GetEnable
func (x *AnswerQueryRequest_SafetySpec) GetEnable() bool
func (*AnswerQueryRequest_SafetySpec) ProtoMessage
func (*AnswerQueryRequest_SafetySpec) ProtoMessage()
func (*AnswerQueryRequest_SafetySpec) ProtoReflect
func (x *AnswerQueryRequest_SafetySpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SafetySpec) Reset
func (x *AnswerQueryRequest_SafetySpec) Reset()
func (*AnswerQueryRequest_SafetySpec) String
func (x *AnswerQueryRequest_SafetySpec) String() string
AnswerQueryRequest_SearchSpec
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
func (*AnswerQueryRequest_SearchSpec) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_SearchSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec) GetInput
func (m *AnswerQueryRequest_SearchSpec) GetInput() isAnswerQueryRequest_SearchSpec_Input
func (*AnswerQueryRequest_SearchSpec) GetSearchParams
func (x *AnswerQueryRequest_SearchSpec) GetSearchParams() *AnswerQueryRequest_SearchSpec_SearchParams
func (*AnswerQueryRequest_SearchSpec) GetSearchResultList
func (x *AnswerQueryRequest_SearchSpec) GetSearchResultList() *AnswerQueryRequest_SearchSpec_SearchResultList
func (*AnswerQueryRequest_SearchSpec) ProtoMessage
func (*AnswerQueryRequest_SearchSpec) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec) Reset
func (x *AnswerQueryRequest_SearchSpec) Reset()
func (*AnswerQueryRequest_SearchSpec) String
func (x *AnswerQueryRequest_SearchSpec) String() string
AnswerQueryRequest_SearchSpec_SearchParams
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"`
// contains filtered or unexported fields
}
Search parameters.
func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec() *SearchRequest_BoostSpec
func (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetFilter() string
func (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32
func (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy() string
func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchParams) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchParams) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchParams) String
func (x *AnswerQueryRequest_SearchSpec_SearchParams) String() string
AnswerQueryRequest_SearchSpec_SearchParams_
type AnswerQueryRequest_SearchSpec_SearchParams_ struct {
// Search parameters.
SearchParams *AnswerQueryRequest_SearchSpec_SearchParams `protobuf:"bytes,1,opt,name=search_params,json=searchParams,proto3,oneof"`
}
AnswerQueryRequest_SearchSpec_SearchResultList
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
func (*AnswerQueryRequest_SearchSpec_SearchResultList) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult
func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_
type AnswerQueryRequest_SearchSpec_SearchResultList_ struct {
// Search result list.
SearchResultList *AnswerQueryRequest_SearchSpec_SearchResultList `protobuf:"bytes,2,opt,name=search_result_list,json=searchResultList,proto3,oneof"`
}
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult
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
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent
func (m *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent() isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo
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
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
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_
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"`
}
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo
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
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
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_
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"`
}
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext
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
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
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer
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
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Descriptor
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
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String() string
AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment
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
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Descriptor
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
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier() string
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect() protoreflect.Message
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset()
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String() string
AnswerQueryResponse
type AnswerQueryResponse struct {
// Answer resource object.
// If [AnswerQueryRequest.StepSpec.max_step_count][] 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"`
// contains filtered or unexported fields
}
Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
func (*AnswerQueryResponse) Descriptor
func (*AnswerQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use AnswerQueryResponse.ProtoReflect.Descriptor instead.
func (*AnswerQueryResponse) GetAnswer
func (x *AnswerQueryResponse) GetAnswer() *Answer
func (*AnswerQueryResponse) GetSession
func (x *AnswerQueryResponse) GetSession() *Session
func (*AnswerQueryResponse) ProtoMessage
func (*AnswerQueryResponse) ProtoMessage()
func (*AnswerQueryResponse) ProtoReflect
func (x *AnswerQueryResponse) ProtoReflect() protoreflect.Message
func (*AnswerQueryResponse) Reset
func (x *AnswerQueryResponse) Reset()
func (*AnswerQueryResponse) String
func (x *AnswerQueryResponse) String() string
Answer_AnswerSkippedReason
type Answer_AnswerSkippedReason int32
An enum for answer skipped reasons.
Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED, Answer_ADVERSARIAL_QUERY_IGNORED, Answer_NON_ANSWER_SEEKING_QUERY_IGNORED, Answer_OUT_OF_DOMAIN_QUERY_IGNORED, Answer_POTENTIAL_POLICY_VIOLATION
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
)
func (Answer_AnswerSkippedReason) Descriptor
func (Answer_AnswerSkippedReason) Descriptor() protoreflect.EnumDescriptor
func (Answer_AnswerSkippedReason) Enum
func (x Answer_AnswerSkippedReason) Enum() *Answer_AnswerSkippedReason
func (Answer_AnswerSkippedReason) EnumDescriptor
func (Answer_AnswerSkippedReason) EnumDescriptor() ([]byte, []int)
Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.
func (Answer_AnswerSkippedReason) Number
func (x Answer_AnswerSkippedReason) Number() protoreflect.EnumNumber
func (Answer_AnswerSkippedReason) String
func (x Answer_AnswerSkippedReason) String() string
func (Answer_AnswerSkippedReason) Type
func (Answer_AnswerSkippedReason) Type() protoreflect.EnumType
Answer_Citation
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
func (*Answer_Citation) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.
func (*Answer_Citation) GetEndIndex
func (x *Answer_Citation) GetEndIndex() int64
func (*Answer_Citation) GetSources
func (x *Answer_Citation) GetSources() []*Answer_CitationSource
func (*Answer_Citation) GetStartIndex
func (x *Answer_Citation) GetStartIndex() int64
func (*Answer_Citation) ProtoMessage
func (*Answer_Citation) ProtoMessage()
func (*Answer_Citation) ProtoReflect
func (x *Answer_Citation) ProtoReflect() protoreflect.Message
func (*Answer_Citation) Reset
func (x *Answer_Citation) Reset()
func (*Answer_Citation) String
func (x *Answer_Citation) String() string
Answer_CitationSource
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
func (*Answer_CitationSource) Descriptor() ([]byte, []int)
Deprecated: Use Answer_CitationSource.ProtoReflect.Descriptor instead.
func (*Answer_CitationSource) GetReferenceId
func (x *Answer_CitationSource) GetReferenceId() string
func (*Answer_CitationSource) ProtoMessage
func (*Answer_CitationSource) ProtoMessage()
func (*Answer_CitationSource) ProtoReflect
func (x *Answer_CitationSource) ProtoReflect() protoreflect.Message
func (*Answer_CitationSource) Reset
func (x *Answer_CitationSource) Reset()
func (*Answer_CitationSource) String
func (x *Answer_CitationSource) String() string
Answer_QueryUnderstandingInfo
type Answer_QueryUnderstandingInfo struct {
QueryClassificationInfo []*Answer_QueryUnderstandingInfo_QueryClassificationInfo "" /* 132 byte string literal not displayed */
}
Query understanding information.
func (*Answer_QueryUnderstandingInfo) Descriptor
func (*Answer_QueryUnderstandingInfo) Descriptor() ([]byte, []int)
Deprecated: Use Answer_QueryUnderstandingInfo.ProtoReflect.Descriptor instead.
func (*Answer_QueryUnderstandingInfo) GetQueryClassificationInfo
func (x *Answer_QueryUnderstandingInfo) GetQueryClassificationInfo() []*Answer_QueryUnderstandingInfo_QueryClassificationInfo
func (*Answer_QueryUnderstandingInfo) ProtoMessage
func (*Answer_QueryUnderstandingInfo) ProtoMessage()
func (*Answer_QueryUnderstandingInfo) ProtoReflect
func (x *Answer_QueryUnderstandingInfo) ProtoReflect() protoreflect.Message
func (*Answer_QueryUnderstandingInfo) Reset
func (x *Answer_QueryUnderstandingInfo) Reset()
func (*Answer_QueryUnderstandingInfo) String
func (x *Answer_QueryUnderstandingInfo) String() string
Answer_QueryUnderstandingInfo_QueryClassificationInfo
type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {
Type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type "" /* 162 byte string literal not displayed */
Positive bool `protobuf:"varint,2,opt,name=positive,proto3" json:"positive,omitempty"`
}
Query classification information.
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor() ([]byte, []int)
Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive() bool
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType() Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage()
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect() protoreflect.Message
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset()
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) String
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) String() string
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type
type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type int32
Query classification types.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED, Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY, Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY
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
)
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor() protoreflect.EnumDescriptor
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum() *Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number() protoreflect.EnumNumber
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String() string
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type
Answer_Reference
type Answer_Reference struct {
// Search result content.
//
// Types that are assignable to Content:
//
// *Answer_Reference_UnstructuredDocumentInfo_
// *Answer_Reference_ChunkInfo_
Content isAnswer_Reference_Content `protobuf_oneof:"content"`
// contains filtered or unexported fields
}
Reference.
func (*Answer_Reference) Descriptor
func (*Answer_Reference) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Reference.ProtoReflect.Descriptor instead.
func (*Answer_Reference) GetChunkInfo
func (x *Answer_Reference) GetChunkInfo() *Answer_Reference_ChunkInfo
func (*Answer_Reference) GetContent
func (m *Answer_Reference) GetContent() isAnswer_Reference_Content
func (*Answer_Reference) GetUnstructuredDocumentInfo
func (x *Answer_Reference) GetUnstructuredDocumentInfo() *Answer_Reference_UnstructuredDocumentInfo
func (*Answer_Reference) ProtoMessage
func (*Answer_Reference) ProtoMessage()
func (*Answer_Reference) ProtoReflect
func (x *Answer_Reference) ProtoReflect() protoreflect.Message
func (*Answer_Reference) Reset
func (x *Answer_Reference) Reset()
func (*Answer_Reference) String
func (x *Answer_Reference) String() string
Answer_Reference_ChunkInfo
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"`
// Relevance score.
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
func (*Answer_Reference_ChunkInfo) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_ChunkInfo) GetChunk
func (x *Answer_Reference_ChunkInfo) GetChunk() string
func (*Answer_Reference_ChunkInfo) GetContent
func (x *Answer_Reference_ChunkInfo) GetContent() string
func (*Answer_Reference_ChunkInfo) GetDocumentMetadata
func (x *Answer_Reference_ChunkInfo) GetDocumentMetadata() *Answer_Reference_ChunkInfo_DocumentMetadata
func (*Answer_Reference_ChunkInfo) GetRelevanceScore
func (x *Answer_Reference_ChunkInfo) GetRelevanceScore() float32
func (*Answer_Reference_ChunkInfo) ProtoMessage
func (*Answer_Reference_ChunkInfo) ProtoMessage()
func (*Answer_Reference_ChunkInfo) ProtoReflect
func (x *Answer_Reference_ChunkInfo) ProtoReflect() protoreflect.Message
func (*Answer_Reference_ChunkInfo) Reset
func (x *Answer_Reference_ChunkInfo) Reset()
func (*Answer_Reference_ChunkInfo) String
func (x *Answer_Reference_ChunkInfo) String() string
Answer_Reference_ChunkInfo_
type Answer_Reference_ChunkInfo_ struct {
// Chunk information.
ChunkInfo *Answer_Reference_ChunkInfo `protobuf:"bytes,2,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}
Answer_Reference_ChunkInfo_DocumentMetadata
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"`
// contains filtered or unexported fields
}
Document metadata.
func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor
func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument() string
func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() string
func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle() string
func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetUri() string
func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage
func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage()
func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect() protoreflect.Message
func (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) Reset()
func (*Answer_Reference_ChunkInfo_DocumentMetadata) String
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) String() string
Answer_Reference_UnstructuredDocumentInfo
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"`
// contains filtered or unexported fields
}
Unstructured document information.
func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor
func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents
func (x *Answer_Reference_UnstructuredDocumentInfo) GetChunkContents() []*Answer_Reference_UnstructuredDocumentInfo_ChunkContent
func (*Answer_Reference_UnstructuredDocumentInfo) GetDocument
func (x *Answer_Reference_UnstructuredDocumentInfo) GetDocument() string
func (*Answer_Reference_UnstructuredDocumentInfo) GetTitle
func (x *Answer_Reference_UnstructuredDocumentInfo) GetTitle() string
func (*Answer_Reference_UnstructuredDocumentInfo) GetUri
func (x *Answer_Reference_UnstructuredDocumentInfo) GetUri() string
func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage
func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage()
func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect
func (x *Answer_Reference_UnstructuredDocumentInfo) ProtoReflect() protoreflect.Message
func (*Answer_Reference_UnstructuredDocumentInfo) Reset
func (x *Answer_Reference_UnstructuredDocumentInfo) Reset()
func (*Answer_Reference_UnstructuredDocumentInfo) String
func (x *Answer_Reference_UnstructuredDocumentInfo) String() string
Answer_Reference_UnstructuredDocumentInfo_
type Answer_Reference_UnstructuredDocumentInfo_ struct {
// Unstructured document information.
UnstructuredDocumentInfo *Answer_Reference_UnstructuredDocumentInfo `protobuf:"bytes,1,opt,name=unstructured_document_info,json=unstructuredDocumentInfo,proto3,oneof"`
}
Answer_Reference_UnstructuredDocumentInfo_ChunkContent
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"`
// contains filtered or unexported fields
}
Chunk content.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() string
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier() string
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage()
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect() protoreflect.Message
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset()
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String() string
Answer_State
type Answer_State int32
Enumeration of the state of the answer generation.
Answer_STATE_UNSPECIFIED, Answer_IN_PROGRESS, Answer_FAILED, Answer_SUCCEEDED
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
func (Answer_State) Descriptor() protoreflect.EnumDescriptor
func (Answer_State) Enum
func (x Answer_State) Enum() *Answer_State
func (Answer_State) EnumDescriptor
func (Answer_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Answer_State.Descriptor instead.
func (Answer_State) Number
func (x Answer_State) Number() protoreflect.EnumNumber
func (Answer_State) String
func (x Answer_State) String() string
func (Answer_State) Type
func (Answer_State) Type() protoreflect.EnumType
Answer_Step
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
func (*Answer_Step) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Step.ProtoReflect.Descriptor instead.
func (*Answer_Step) GetActions
func (x *Answer_Step) GetActions() []*Answer_Step_Action
func (*Answer_Step) GetDescription
func (x *Answer_Step) GetDescription() string
func (*Answer_Step) GetState
func (x *Answer_Step) GetState() Answer_Step_State
func (*Answer_Step) GetThought
func (x *Answer_Step) GetThought() string
func (*Answer_Step) ProtoMessage
func (*Answer_Step) ProtoMessage()
func (*Answer_Step) ProtoReflect
func (x *Answer_Step) ProtoReflect() protoreflect.Message
func (*Answer_Step) Reset
func (x *Answer_Step) Reset()
func (*Answer_Step) String
func (x *Answer_Step) String() string
Answer_Step_Action
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
func (*Answer_Step_Action) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Step_Action.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action) GetAction
func (m *Answer_Step_Action) GetAction() isAnswer_Step_Action_Action
func (*Answer_Step_Action) GetObservation
func (x *Answer_Step_Action) GetObservation() *Answer_Step_Action_Observation
func (*Answer_Step_Action) GetSearchAction
func (x *Answer_Step_Action) GetSearchAction() *Answer_Step_Action_SearchAction
func (*Answer_Step_Action) ProtoMessage
func (*Answer_Step_Action) ProtoMessage()
func (*Answer_Step_Action) ProtoReflect
func (x *Answer_Step_Action) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action) Reset
func (x *Answer_Step_Action) Reset()
func (*Answer_Step_Action) String
func (x *Answer_Step_Action) String() string
Answer_Step_Action_Observation
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
func (*Answer_Step_Action_Observation) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Step_Action_Observation.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_Observation) GetSearchResults
func (x *Answer_Step_Action_Observation) GetSearchResults() []*Answer_Step_Action_Observation_SearchResult
func (*Answer_Step_Action_Observation) ProtoMessage
func (*Answer_Step_Action_Observation) ProtoMessage()
func (*Answer_Step_Action_Observation) ProtoReflect
func (x *Answer_Step_Action_Observation) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action_Observation) Reset
func (x *Answer_Step_Action_Observation) Reset()
func (*Answer_Step_Action_Observation) String
func (x *Answer_Step_Action_Observation) String() string
Answer_Step_Action_Observation_SearchResult
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"`
// contains filtered or unexported fields
}
func (*Answer_Step_Action_Observation_SearchResult) Descriptor
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
func (x *Answer_Step_Action_Observation_SearchResult) GetChunkInfo() []*Answer_Step_Action_Observation_SearchResult_ChunkInfo
func (*Answer_Step_Action_Observation_SearchResult) GetDocument
func (x *Answer_Step_Action_Observation_SearchResult) GetDocument() string
func (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo
func (x *Answer_Step_Action_Observation_SearchResult) GetSnippetInfo() []*Answer_Step_Action_Observation_SearchResult_SnippetInfo
func (*Answer_Step_Action_Observation_SearchResult) GetTitle
func (x *Answer_Step_Action_Observation_SearchResult) GetTitle() string
func (*Answer_Step_Action_Observation_SearchResult) GetUri
func (x *Answer_Step_Action_Observation_SearchResult) GetUri() string
func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage()
func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action_Observation_SearchResult) Reset
func (x *Answer_Step_Action_Observation_SearchResult) Reset()
func (*Answer_Step_Action_Observation_SearchResult) String
func (x *Answer_Step_Action_Observation_SearchResult) String() string
Answer_Step_Action_Observation_SearchResult_ChunkInfo
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"`
// Relevance score.
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
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
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk() string
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent() string
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore() float32
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage()
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset()
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) String
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) String() string
Answer_Step_Action_Observation_SearchResult_SnippetInfo
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
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
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet() string
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus() string
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage()
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset()
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) String
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) String() string
Answer_Step_Action_SearchAction
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
func (*Answer_Step_Action_SearchAction) Descriptor() ([]byte, []int)
Deprecated: Use Answer_Step_Action_SearchAction.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_SearchAction) GetQuery
func (x *Answer_Step_Action_SearchAction) GetQuery() string
func (*Answer_Step_Action_SearchAction) ProtoMessage
func (*Answer_Step_Action_SearchAction) ProtoMessage()
func (*Answer_Step_Action_SearchAction) ProtoReflect
func (x *Answer_Step_Action_SearchAction) ProtoReflect() protoreflect.Message
func (*Answer_Step_Action_SearchAction) Reset
func (x *Answer_Step_Action_SearchAction) Reset()
func (*Answer_Step_Action_SearchAction) String
func (x *Answer_Step_Action_SearchAction) String() string
Answer_Step_Action_SearchAction_
type Answer_Step_Action_SearchAction_ struct {
// Search action.
SearchAction *Answer_Step_Action_SearchAction `protobuf:"bytes,2,opt,name=search_action,json=searchAction,proto3,oneof"`
}
Answer_Step_State
type Answer_Step_State int32
Enumeration of the state of the step.
Answer_Step_STATE_UNSPECIFIED, Answer_Step_IN_PROGRESS, Answer_Step_FAILED, Answer_Step_SUCCEEDED
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
func (Answer_Step_State) Descriptor() protoreflect.EnumDescriptor
func (Answer_Step_State) Enum
func (x Answer_Step_State) Enum() *Answer_Step_State
func (Answer_Step_State) EnumDescriptor
func (Answer_Step_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Answer_Step_State.Descriptor instead.
func (Answer_Step_State) Number
func (x Answer_Step_State) Number() protoreflect.EnumNumber
func (Answer_Step_State) String
func (x Answer_Step_State) String() string
func (Answer_Step_State) Type
func (Answer_Step_State) Type() protoreflect.EnumType
BatchCreateTargetSiteMetadata
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
func (*BatchCreateTargetSiteMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSiteMetadata) GetCreateTime
func (x *BatchCreateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestamp
func (*BatchCreateTargetSiteMetadata) GetUpdateTime
func (x *BatchCreateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*BatchCreateTargetSiteMetadata) ProtoMessage
func (*BatchCreateTargetSiteMetadata) ProtoMessage()
func (*BatchCreateTargetSiteMetadata) ProtoReflect
func (x *BatchCreateTargetSiteMetadata) ProtoReflect() protoreflect.Message
func (*BatchCreateTargetSiteMetadata) Reset
func (x *BatchCreateTargetSiteMetadata) Reset()
func (*BatchCreateTargetSiteMetadata) String
func (x *BatchCreateTargetSiteMetadata) String() string
BatchCreateTargetSitesRequest
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
func (*BatchCreateTargetSitesRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSitesRequest) GetParent
func (x *BatchCreateTargetSitesRequest) GetParent() string
func (*BatchCreateTargetSitesRequest) GetRequests
func (x *BatchCreateTargetSitesRequest) GetRequests() []*CreateTargetSiteRequest
func (*BatchCreateTargetSitesRequest) ProtoMessage
func (*BatchCreateTargetSitesRequest) ProtoMessage()
func (*BatchCreateTargetSitesRequest) ProtoReflect
func (x *BatchCreateTargetSitesRequest) ProtoReflect() protoreflect.Message
func (*BatchCreateTargetSitesRequest) Reset
func (x *BatchCreateTargetSitesRequest) Reset()
func (*BatchCreateTargetSitesRequest) String
func (x *BatchCreateTargetSitesRequest) String() string
BatchCreateTargetSitesResponse
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
func (*BatchCreateTargetSitesResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSitesResponse) GetTargetSites
func (x *BatchCreateTargetSitesResponse) GetTargetSites() []*TargetSite
func (*BatchCreateTargetSitesResponse) ProtoMessage
func (*BatchCreateTargetSitesResponse) ProtoMessage()
func (*BatchCreateTargetSitesResponse) ProtoReflect
func (x *BatchCreateTargetSitesResponse) ProtoReflect() protoreflect.Message
func (*BatchCreateTargetSitesResponse) Reset
func (x *BatchCreateTargetSitesResponse) Reset()
func (*BatchCreateTargetSitesResponse) String
func (x *BatchCreateTargetSitesResponse) String() string
BatchVerifyTargetSitesMetadata
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
func (*BatchVerifyTargetSitesMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesMetadata) GetCreateTime
func (x *BatchVerifyTargetSitesMetadata) GetCreateTime() *timestamppb.Timestamp
func (*BatchVerifyTargetSitesMetadata) GetUpdateTime
func (x *BatchVerifyTargetSitesMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*BatchVerifyTargetSitesMetadata) ProtoMessage
func (*BatchVerifyTargetSitesMetadata) ProtoMessage()
func (*BatchVerifyTargetSitesMetadata) ProtoReflect
func (x *BatchVerifyTargetSitesMetadata) ProtoReflect() protoreflect.Message
func (*BatchVerifyTargetSitesMetadata) Reset
func (x *BatchVerifyTargetSitesMetadata) Reset()
func (*BatchVerifyTargetSitesMetadata) String
func (x *BatchVerifyTargetSitesMetadata) String() string
BatchVerifyTargetSitesRequest
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
func (*BatchVerifyTargetSitesRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesRequest) GetParent
func (x *BatchVerifyTargetSitesRequest) GetParent() string
func (*BatchVerifyTargetSitesRequest) ProtoMessage
func (*BatchVerifyTargetSitesRequest) ProtoMessage()
func (*BatchVerifyTargetSitesRequest) ProtoReflect
func (x *BatchVerifyTargetSitesRequest) ProtoReflect() protoreflect.Message
func (*BatchVerifyTargetSitesRequest) Reset
func (x *BatchVerifyTargetSitesRequest) Reset()
func (*BatchVerifyTargetSitesRequest) String
func (x *BatchVerifyTargetSitesRequest) String() string
BatchVerifyTargetSitesResponse
type BatchVerifyTargetSitesResponse struct {
// contains filtered or unexported fields
}
Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.
func (*BatchVerifyTargetSitesResponse) Descriptor
func (*BatchVerifyTargetSitesResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesResponse) ProtoMessage
func (*BatchVerifyTargetSitesResponse) ProtoMessage()
func (*BatchVerifyTargetSitesResponse) ProtoReflect
func (x *BatchVerifyTargetSitesResponse) ProtoReflect() protoreflect.Message
func (*BatchVerifyTargetSitesResponse) Reset
func (x *BatchVerifyTargetSitesResponse) Reset()
func (*BatchVerifyTargetSitesResponse) String
func (x *BatchVerifyTargetSitesResponse) String() string
BigQuerySource
type BigQuerySource struct {
// BigQuery table partition info. Leave this empty if the BigQuery table
// is not partitioned.
//
// Types that are assignable to Partition:
//
// *BigQuerySource_PartitionDate
Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
// The project ID (can be project # or ID) that the BigQuery source is in with
// a length limit of 128 characters. If not specified, inherits the project
// ID from the parent request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The BigQuery data set to copy the data from with a length limit
// of 1,024 characters.
DatasetId string `protobuf:"bytes,2,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
// Required. The BigQuery table to copy the data from with a length limit of
// 1,024 characters.
TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// BigQuery export to a specific Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// The schema to use when parsing the data from the source.
//
// Supported values for user event imports:
//
// * `user_event` (default): One
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per row.
//
// Supported values for document imports:
//
// * `document` (default): One
// [Document][google.cloud.discoveryengine.v1beta.Document] format per
//
// row. Each document must have a valid
// [Document.id][google.cloud.discoveryengine.v1beta.Document.id] and one of
// [Document.json_data][google.cloud.discoveryengine.v1beta.Document.json_data]
// or
// [Document.struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data].
// - `custom`: One custom data per row in arbitrary format that conforms 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
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
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"`
}
BigtableOptions
type BigtableOptions struct {
KeyFieldName string `protobuf:"bytes,1,opt,name=key_field_name,json=keyFieldName,proto3" json:"key_field_name,omitempty"`
Families map[string]*BigtableOptions_BigtableColumnFamily "" /* 157 byte string literal not displayed */
}
The Bigtable Options object that contains information to support the import.
func (*BigtableOptions) Descriptor
func (*BigtableOptions) Descriptor() ([]byte, []int)
Deprecated: Use BigtableOptions.ProtoReflect.Descriptor instead.
func (*BigtableOptions) GetFamilies
func (x *BigtableOptions) GetFamilies() map[string]*BigtableOptions_BigtableColumnFamily
func (*BigtableOptions) GetKeyFieldName
func (x *BigtableOptions) GetKeyFieldName() string
func (*BigtableOptions) ProtoMessage
func (*BigtableOptions) ProtoMessage()
func (*BigtableOptions) ProtoReflect
func (x *BigtableOptions) ProtoReflect() protoreflect.Message
func (*BigtableOptions) Reset
func (x *BigtableOptions) Reset()
func (*BigtableOptions) String
func (x *BigtableOptions) String() string
BigtableOptions_BigtableColumn
type BigtableOptions_BigtableColumn struct {
Qualifier []byte `protobuf:"bytes,1,opt,name=qualifier,proto3" json:"qualifier,omitempty"`
FieldName string `protobuf:"bytes,2,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
Encoding BigtableOptions_Encoding "" /* 136 byte string literal not displayed */
Type BigtableOptions_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
}
The column of the Bigtable.
func (*BigtableOptions_BigtableColumn) Descriptor
func (*BigtableOptions_BigtableColumn) Descriptor() ([]byte, []int)
Deprecated: Use BigtableOptions_BigtableColumn.ProtoReflect.Descriptor instead.
func (*BigtableOptions_BigtableColumn) GetEncoding
func (x *BigtableOptions_BigtableColumn) GetEncoding() BigtableOptions_Encoding
func (*BigtableOptions_BigtableColumn) GetFieldName
func (x *BigtableOptions_BigtableColumn) GetFieldName() string
func (*BigtableOptions_BigtableColumn) GetQualifier
func (x *BigtableOptions_BigtableColumn) GetQualifier() []byte
func (*BigtableOptions_BigtableColumn) GetType
func (x *BigtableOptions_BigtableColumn) GetType() BigtableOptions_Type
func (*BigtableOptions_BigtableColumn) ProtoMessage
func (*BigtableOptions_BigtableColumn) ProtoMessage()
func (*BigtableOptions_BigtableColumn) ProtoReflect
func (x *BigtableOptions_BigtableColumn) ProtoReflect() protoreflect.Message
func (*BigtableOptions_BigtableColumn) Reset
func (x *BigtableOptions_BigtableColumn) Reset()
func (*BigtableOptions_BigtableColumn) String
func (x *BigtableOptions_BigtableColumn) String() string
BigtableOptions_BigtableColumnFamily
type BigtableOptions_BigtableColumnFamily struct {
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
Encoding BigtableOptions_Encoding "" /* 136 byte string literal not displayed */
Type BigtableOptions_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
Columns []*BigtableOptions_BigtableColumn `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
}
The column family of the Bigtable.
func (*BigtableOptions_BigtableColumnFamily) Descriptor
func (*BigtableOptions_BigtableColumnFamily) Descriptor() ([]byte, []int)
Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.
func (*BigtableOptions_BigtableColumnFamily) GetColumns
func (x *BigtableOptions_BigtableColumnFamily) GetColumns() []*BigtableOptions_BigtableColumn
func (*BigtableOptions_BigtableColumnFamily) GetEncoding
func (x *BigtableOptions_BigtableColumnFamily) GetEncoding() BigtableOptions_Encoding
func (*BigtableOptions_BigtableColumnFamily) GetFieldName
func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() string
func (*BigtableOptions_BigtableColumnFamily) GetType
func (x *BigtableOptions_BigtableColumnFamily) GetType() BigtableOptions_Type
func (*BigtableOptions_BigtableColumnFamily) ProtoMessage
func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()
func (*BigtableOptions_BigtableColumnFamily) ProtoReflect
func (x *BigtableOptions_BigtableColumnFamily) ProtoReflect() protoreflect.Message
func (*BigtableOptions_BigtableColumnFamily) Reset
func (x *BigtableOptions_BigtableColumnFamily) Reset()
func (*BigtableOptions_BigtableColumnFamily) String
func (x *BigtableOptions_BigtableColumnFamily) String() string
BigtableOptions_Encoding
type BigtableOptions_Encoding int32
The encoding mode of a Bigtable column or column family.
BigtableOptions_ENCODING_UNSPECIFIED, BigtableOptions_TEXT, BigtableOptions_BINARY
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
func (BigtableOptions_Encoding) Descriptor() protoreflect.EnumDescriptor
func (BigtableOptions_Encoding) Enum
func (x BigtableOptions_Encoding) Enum() *BigtableOptions_Encoding
func (BigtableOptions_Encoding) EnumDescriptor
func (BigtableOptions_Encoding) EnumDescriptor() ([]byte, []int)
Deprecated: Use BigtableOptions_Encoding.Descriptor instead.
func (BigtableOptions_Encoding) Number
func (x BigtableOptions_Encoding) Number() protoreflect.EnumNumber
func (BigtableOptions_Encoding) String
func (x BigtableOptions_Encoding) String() string
func (BigtableOptions_Encoding) Type
func (BigtableOptions_Encoding) Type() protoreflect.EnumType
BigtableOptions_Type
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
function when the encoding value is set to BINARY
.
BigtableOptions_TYPE_UNSPECIFIED, BigtableOptions_STRING, BigtableOptions_NUMBER, BigtableOptions_INTEGER, BigtableOptions_VAR_INTEGER, BigtableOptions_BIG_NUMERIC, BigtableOptions_BOOLEAN, BigtableOptions_JSON
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
func (BigtableOptions_Type) Descriptor() protoreflect.EnumDescriptor
func (BigtableOptions_Type) Enum
func (x BigtableOptions_Type) Enum() *BigtableOptions_Type
func (BigtableOptions_Type) EnumDescriptor
func (BigtableOptions_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use BigtableOptions_Type.Descriptor instead.
func (BigtableOptions_Type) Number
func (x BigtableOptions_Type) Number() protoreflect.EnumNumber
func (BigtableOptions_Type) String
func (x BigtableOptions_Type) String() string
func (BigtableOptions_Type) Type
func (BigtableOptions_Type) Type() protoreflect.EnumType
BigtableSource
type BigtableSource struct {
// The project ID that the Bigtable 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 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
func (*BigtableSource) Descriptor() ([]byte, []int)
Deprecated: Use BigtableSource.ProtoReflect.Descriptor instead.
func (*BigtableSource) GetBigtableOptions
func (x *BigtableSource) GetBigtableOptions() *BigtableOptions
func (*BigtableSource) GetInstanceId
func (x *BigtableSource) GetInstanceId() string
func (*BigtableSource) GetProjectId
func (x *BigtableSource) GetProjectId() string
func (*BigtableSource) GetTableId
func (x *BigtableSource) GetTableId() string
func (*BigtableSource) ProtoMessage
func (*BigtableSource) ProtoMessage()
func (*BigtableSource) ProtoReflect
func (x *BigtableSource) ProtoReflect() protoreflect.Message
func (*BigtableSource) Reset
func (x *BigtableSource) Reset()
func (*BigtableSource) String
func (x *BigtableSource) String() string
CheckGroundingRequest
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.
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"`
// contains filtered or unexported fields
}
Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
func (*CheckGroundingRequest) Descriptor
func (*CheckGroundingRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckGroundingRequest.ProtoReflect.Descriptor instead.
func (*CheckGroundingRequest) GetAnswerCandidate
func (x *CheckGroundingRequest) GetAnswerCandidate() string
func (*CheckGroundingRequest) GetFacts
func (x *CheckGroundingRequest) GetFacts() []*GroundingFact
func (*CheckGroundingRequest) GetGroundingConfig
func (x *CheckGroundingRequest) GetGroundingConfig() string
func (*CheckGroundingRequest) GetGroundingSpec
func (x *CheckGroundingRequest) GetGroundingSpec() *CheckGroundingSpec
func (*CheckGroundingRequest) ProtoMessage
func (*CheckGroundingRequest) ProtoMessage()
func (*CheckGroundingRequest) ProtoReflect
func (x *CheckGroundingRequest) ProtoReflect() protoreflect.Message
func (*CheckGroundingRequest) Reset
func (x *CheckGroundingRequest) Reset()
func (*CheckGroundingRequest) String
func (x *CheckGroundingRequest) String() string
CheckGroundingResponse
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
func (*CheckGroundingResponse) Descriptor() ([]byte, []int)
Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse) GetCitedChunks
func (x *CheckGroundingResponse) GetCitedChunks() []*FactChunk
func (*CheckGroundingResponse) GetClaims
func (x *CheckGroundingResponse) GetClaims() []*CheckGroundingResponse_Claim
func (*CheckGroundingResponse) GetSupportScore
func (x *CheckGroundingResponse) GetSupportScore() float32
func (*CheckGroundingResponse) ProtoMessage
func (*CheckGroundingResponse) ProtoMessage()
func (*CheckGroundingResponse) ProtoReflect
func (x *CheckGroundingResponse) ProtoReflect() protoreflect.Message
func (*CheckGroundingResponse) Reset
func (x *CheckGroundingResponse) Reset()
func (*CheckGroundingResponse) String
func (x *CheckGroundingResponse) String() string
CheckGroundingResponse_Claim
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"`
// contains filtered or unexported fields
}
Text and citation info for a claim in the answer candidate.
func (*CheckGroundingResponse_Claim) Descriptor
func (*CheckGroundingResponse_Claim) Descriptor() ([]byte, []int)
Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse_Claim) GetCitationIndices
func (x *CheckGroundingResponse_Claim) GetCitationIndices() []int32
func (*CheckGroundingResponse_Claim) GetClaimText
func (x *CheckGroundingResponse_Claim) GetClaimText() string
func (*CheckGroundingResponse_Claim) GetEndPos
func (x *CheckGroundingResponse_Claim) GetEndPos() int32
func (*CheckGroundingResponse_Claim) GetStartPos
func (x *CheckGroundingResponse_Claim) GetStartPos() int32
func (*CheckGroundingResponse_Claim) ProtoMessage
func (*CheckGroundingResponse_Claim) ProtoMessage()
func (*CheckGroundingResponse_Claim) ProtoReflect
func (x *CheckGroundingResponse_Claim) ProtoReflect() protoreflect.Message
func (*CheckGroundingResponse_Claim) Reset
func (x *CheckGroundingResponse_Claim) Reset()
func (*CheckGroundingResponse_Claim) String
func (x *CheckGroundingResponse_Claim) String() string
CheckGroundingSpec
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
func (*CheckGroundingSpec) Descriptor() ([]byte, []int)
Deprecated: Use CheckGroundingSpec.ProtoReflect.Descriptor instead.
func (*CheckGroundingSpec) GetCitationThreshold
func (x *CheckGroundingSpec) GetCitationThreshold() float64
func (*CheckGroundingSpec) ProtoMessage
func (*CheckGroundingSpec) ProtoMessage()
func (*CheckGroundingSpec) ProtoReflect
func (x *CheckGroundingSpec) ProtoReflect() protoreflect.Message
func (*CheckGroundingSpec) Reset
func (x *CheckGroundingSpec) Reset()
func (*CheckGroundingSpec) String
func (x *CheckGroundingSpec) String() string
CloudSqlSource
type CloudSqlSource 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 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
func (*CloudSqlSource) Descriptor() ([]byte, []int)
Deprecated: Use CloudSqlSource.ProtoReflect.Descriptor instead.
func (*CloudSqlSource) GetDatabaseId
func (x *CloudSqlSource) GetDatabaseId() string
func (*CloudSqlSource) GetGcsStagingDir
func (x *CloudSqlSource) GetGcsStagingDir() string
func (*CloudSqlSource) GetInstanceId
func (x *CloudSqlSource) GetInstanceId() string
func (*CloudSqlSource) GetOffload
func (x *CloudSqlSource) GetOffload() bool
func (*CloudSqlSource) GetProjectId
func (x *CloudSqlSource) GetProjectId() string
func (*CloudSqlSource) GetTableId
func (x *CloudSqlSource) GetTableId() string
func (*CloudSqlSource) ProtoMessage
func (*CloudSqlSource) ProtoMessage()
func (*CloudSqlSource) ProtoReflect
func (x *CloudSqlSource) ProtoReflect() protoreflect.Message
func (*CloudSqlSource) Reset
func (x *CloudSqlSource) Reset()
func (*CloudSqlSource) String
func (x *CloudSqlSource) String() string
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
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
CompleteQueryRequest
type CompleteQueryRequest struct {
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
QueryModel string `protobuf:"bytes,3,opt,name=query_model,json=queryModel,proto3" json:"query_model,omitempty"`
UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
IncludeTailSuggestions bool "" /* 130 byte string literal not displayed */
}
Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
func (*CompleteQueryRequest) Descriptor
func (*CompleteQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.
func (*CompleteQueryRequest) GetDataStore
func (x *CompleteQueryRequest) GetDataStore() string
func (*CompleteQueryRequest) GetIncludeTailSuggestions
func (x *CompleteQueryRequest) GetIncludeTailSuggestions() bool
func (*CompleteQueryRequest) GetQuery
func (x *CompleteQueryRequest) GetQuery() string
func (*CompleteQueryRequest) GetQueryModel
func (x *CompleteQueryRequest) GetQueryModel() string
func (*CompleteQueryRequest) GetUserPseudoId
func (x *CompleteQueryRequest) GetUserPseudoId() string
func (*CompleteQueryRequest) ProtoMessage
func (*CompleteQueryRequest) ProtoMessage()
func (*CompleteQueryRequest) ProtoReflect
func (x *CompleteQueryRequest) ProtoReflect() protoreflect.Message
func (*CompleteQueryRequest) Reset
func (x *CompleteQueryRequest) Reset()
func (*CompleteQueryRequest) String
func (x *CompleteQueryRequest) String() string
CompleteQueryResponse
type CompleteQueryResponse struct {
// Results of the matched query suggestions. The result list is ordered and
// the first result is a top suggestion.
QuerySuggestions []*CompleteQueryResponse_QuerySuggestion `protobuf:"bytes,1,rep,name=query_suggestions,json=querySuggestions,proto3" json:"query_suggestions,omitempty"`
// True if the returned suggestions are all tail suggestions.
//
// For tail matching to be triggered, include_tail_suggestions in the request
// must be true and there must be no suggestions that match the full query.
TailMatchTriggered bool `protobuf:"varint,2,opt,name=tail_match_triggered,json=tailMatchTriggered,proto3" json:"tail_match_triggered,omitempty"`
// contains filtered or unexported fields
}
Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
func (*CompleteQueryResponse) Descriptor
func (*CompleteQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse) GetQuerySuggestions
func (x *CompleteQueryResponse) GetQuerySuggestions() []*CompleteQueryResponse_QuerySuggestion
func (*CompleteQueryResponse) GetTailMatchTriggered
func (x *CompleteQueryResponse) GetTailMatchTriggered() bool
func (*CompleteQueryResponse) ProtoMessage
func (*CompleteQueryResponse) ProtoMessage()
func (*CompleteQueryResponse) ProtoReflect
func (x *CompleteQueryResponse) ProtoReflect() protoreflect.Message
func (*CompleteQueryResponse) Reset
func (x *CompleteQueryResponse) Reset()
func (*CompleteQueryResponse) String
func (x *CompleteQueryResponse) String() string
CompleteQueryResponse_QuerySuggestion
type CompleteQueryResponse_QuerySuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The unique document field paths that serve as the source of this
// suggestion if it was generated from completable fields.
//
// This field is only populated for the document-completable model.
CompletableFieldPaths []string `protobuf:"bytes,2,rep,name=completable_field_paths,json=completableFieldPaths,proto3" json:"completable_field_paths,omitempty"`
// contains filtered or unexported fields
}
Suggestions as search queries.
func (*CompleteQueryResponse_QuerySuggestion) Descriptor
func (*CompleteQueryResponse_QuerySuggestion) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths
func (x *CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths() []string
func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion
func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string
func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage
func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()
func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect
func (x *CompleteQueryResponse_QuerySuggestion) ProtoReflect() protoreflect.Message
func (*CompleteQueryResponse_QuerySuggestion) Reset
func (x *CompleteQueryResponse_QuerySuggestion) Reset()
func (*CompleteQueryResponse_QuerySuggestion) String
func (x *CompleteQueryResponse_QuerySuggestion) String() string
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
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
CompletionServiceClient
type CompletionServiceClient interface {
// Completes the specified user input with keyword suggestions.
CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
// Imports all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.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)
}
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
func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient
CompletionServiceServer
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)
}
CompletionServiceServer is the server API for CompletionService service.
Conversation
type Conversation struct {
// Immutable. Fully qualified name
// `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
// or
// `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The state of the Conversation.
State Conversation_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.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
func (*Conversation) Descriptor() ([]byte, []int)
Deprecated: Use Conversation.ProtoReflect.Descriptor instead.
func (*Conversation) GetEndTime
func (x *Conversation) GetEndTime() *timestamppb.Timestamp
func (*Conversation) GetMessages
func (x *Conversation) GetMessages() []*ConversationMessage
func (*Conversation) GetName
func (x *Conversation) GetName() string
func (*Conversation) GetStartTime
func (x *Conversation) GetStartTime() *timestamppb.Timestamp
func (*Conversation) GetState
func (x *Conversation) GetState() Conversation_State
func (*Conversation) GetUserPseudoId
func (x *Conversation) GetUserPseudoId() string
func (*Conversation) ProtoMessage
func (*Conversation) ProtoMessage()
func (*Conversation) ProtoReflect
func (x *Conversation) ProtoReflect() protoreflect.Message
func (*Conversation) Reset
func (x *Conversation) Reset()
func (*Conversation) String
func (x *Conversation) String() string
ConversationContext
type ConversationContext struct {
// The current list of documents the user is seeing.
// It contains the document resource references.
ContextDocuments []string `protobuf:"bytes,1,rep,name=context_documents,json=contextDocuments,proto3" json:"context_documents,omitempty"`
// The current active document the user opened.
// It contains the document resource reference.
ActiveDocument string `protobuf:"bytes,2,opt,name=active_document,json=activeDocument,proto3" json:"active_document,omitempty"`
// contains filtered or unexported fields
}
Defines context of the conversation
func (*ConversationContext) Descriptor
func (*ConversationContext) Descriptor() ([]byte, []int)
Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.
func (*ConversationContext) GetActiveDocument
func (x *ConversationContext) GetActiveDocument() string
func (*ConversationContext) GetContextDocuments
func (x *ConversationContext) GetContextDocuments() []string
func (*ConversationContext) ProtoMessage
func (*ConversationContext) ProtoMessage()
func (*ConversationContext) ProtoReflect
func (x *ConversationContext) ProtoReflect() protoreflect.Message
func (*ConversationContext) Reset
func (x *ConversationContext) Reset()
func (*ConversationContext) String
func (x *ConversationContext) String() string
ConversationMessage
type ConversationMessage struct {
// Types that are assignable to Message:
//
// *ConversationMessage_UserInput
// *ConversationMessage_Reply
Message isConversationMessage_Message `protobuf_oneof:"message"`
// Output only. Message creation timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
Defines a conversation message.
func (*ConversationMessage) Descriptor
func (*ConversationMessage) Descriptor() ([]byte, []int)
Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.
func (*ConversationMessage) GetCreateTime
func (x *ConversationMessage) GetCreateTime() *timestamppb.Timestamp
func (*ConversationMessage) GetMessage
func (m *ConversationMessage) GetMessage() isConversationMessage_Message
func (*ConversationMessage) GetReply
func (x *ConversationMessage) GetReply() *Reply
func (*ConversationMessage) GetUserInput
func (x *ConversationMessage) GetUserInput() *TextInput
func (*ConversationMessage) ProtoMessage
func (*ConversationMessage) ProtoMessage()
func (*ConversationMessage) ProtoReflect
func (x *ConversationMessage) ProtoReflect() protoreflect.Message
func (*ConversationMessage) Reset
func (x *ConversationMessage) Reset()
func (*ConversationMessage) String
func (x *ConversationMessage) String() string
ConversationMessage_Reply
type ConversationMessage_Reply struct {
// Search reply.
Reply *Reply `protobuf:"bytes,2,opt,name=reply,proto3,oneof"`
}
ConversationMessage_UserInput
type ConversationMessage_UserInput struct {
// User text input.
UserInput *TextInput `protobuf:"bytes,1,opt,name=user_input,json=userInput,proto3,oneof"`
}
Conversation_State
type Conversation_State int32
Enumeration of the state of the conversation.
Conversation_STATE_UNSPECIFIED, Conversation_IN_PROGRESS, Conversation_COMPLETED
const (
// Unknown.
Conversation_STATE_UNSPECIFIED Conversation_State = 0
// Conversation is currently open.
Conversation_IN_PROGRESS Conversation_State = 1
// Conversation has been completed.
Conversation_COMPLETED Conversation_State = 2
)
func (Conversation_State) Descriptor
func (Conversation_State) Descriptor() protoreflect.EnumDescriptor
func (Conversation_State) Enum
func (x Conversation_State) Enum() *Conversation_State
func (Conversation_State) EnumDescriptor
func (Conversation_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Conversation_State.Descriptor instead.
func (Conversation_State) Number
func (x Conversation_State) Number() protoreflect.EnumNumber
func (Conversation_State) String
func (x Conversation_State) String() string
func (Conversation_State) Type
func (Conversation_State) Type() protoreflect.EnumType
ConversationalSearchServiceClient
type ConversationalSearchServiceClient interface {
// Converses a conversation.
ConverseConversation(ctx context.Context, in *ConverseConversationRequest, opts ...grpc.CallOption) (*ConverseConversationResponse, error)
// Creates a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.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
func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClient
ConversationalSearchServiceServer
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.
ConverseConversationRequest
type ConverseConversationRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Query *TextInput `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
ServingConfig string `protobuf:"bytes,3,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
Conversation *Conversation `protobuf:"bytes,5,opt,name=conversation,proto3" json:"conversation,omitempty"`
SafeSearch bool `protobuf:"varint,6,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
UserLabels map[string]string "" /* 179 byte string literal not displayed */
SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,8,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
}
Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
func (*ConverseConversationRequest) Descriptor
func (*ConverseConversationRequest) Descriptor() ([]byte, []int)
Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.
func (*ConverseConversationRequest) GetBoostSpec
func (x *ConverseConversationRequest) GetBoostSpec() *SearchRequest_BoostSpec
func (*ConverseConversationRequest) GetConversation
func (x *ConverseConversationRequest) GetConversation() *Conversation
func (*ConverseConversationRequest) GetFilter
func (x *ConverseConversationRequest) GetFilter() string
func (*ConverseConversationRequest) GetName
func (x *ConverseConversationRequest) GetName() string
func (*ConverseConversationRequest) GetQuery
func (x *ConverseConversationRequest) GetQuery() *TextInput
func (*ConverseConversationRequest) GetSafeSearch
func (x *ConverseConversationRequest) GetSafeSearch() bool
func (*ConverseConversationRequest) GetServingConfig
func (x *ConverseConversationRequest) GetServingConfig() string
func (*ConverseConversationRequest) GetSummarySpec
func (x *ConverseConversationRequest) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec
func (*ConverseConversationRequest) GetUserLabels
func (x *ConverseConversationRequest) GetUserLabels() map[string]string
func (*ConverseConversationRequest) ProtoMessage
func (*ConverseConversationRequest) ProtoMessage()
func (*ConverseConversationRequest) ProtoReflect
func (x *ConverseConversationRequest) ProtoReflect() protoreflect.Message
func (*ConverseConversationRequest) Reset
func (x *ConverseConversationRequest) Reset()
func (*ConverseConversationRequest) String
func (x *ConverseConversationRequest) String() string
ConverseConversationResponse
type ConverseConversationResponse struct {
// Answer to the current query.
Reply *Reply `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
// Updated conversation including the answer.
Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Suggested related questions.
RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
// Search Results.
SearchResults []*SearchResponse_SearchResult `protobuf:"bytes,3,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// contains filtered or unexported fields
}
Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
func (*ConverseConversationResponse) Descriptor
func (*ConverseConversationResponse) Descriptor() ([]byte, []int)
Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.
func (*ConverseConversationResponse) GetConversation
func (x *ConverseConversationResponse) GetConversation() *Conversation
func (*ConverseConversationResponse) GetRelatedQuestions
func (x *ConverseConversationResponse) GetRelatedQuestions() []string
func (*ConverseConversationResponse) GetReply
func (x *ConverseConversationResponse) GetReply() *Reply
func (*ConverseConversationResponse) GetSearchResults
func (x *ConverseConversationResponse) GetSearchResults() []*SearchResponse_SearchResult
func (*ConverseConversationResponse) ProtoMessage
func (*ConverseConversationResponse) ProtoMessage()
func (*ConverseConversationResponse) ProtoReflect
func (x *ConverseConversationResponse) ProtoReflect() protoreflect.Message
func (*ConverseConversationResponse) Reset
func (x *ConverseConversationResponse) Reset()
func (*ConverseConversationResponse) String
func (x *ConverseConversationResponse) String() string
CreateConversationRequest
type CreateConversationRequest struct {
// Required. Full resource name of parent data store. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The conversation to create.
Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
// contains filtered or unexported fields
}
Request for CreateConversation method.
func (*CreateConversationRequest) Descriptor
func (*CreateConversationRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.
func (*CreateConversationRequest) GetConversation
func (x *CreateConversationRequest) GetConversation() *Conversation
func (*CreateConversationRequest) GetParent
func (x *CreateConversationRequest) GetParent() string
func (*CreateConversationRequest) ProtoMessage
func (*CreateConversationRequest) ProtoMessage()
func (*CreateConversationRequest) ProtoReflect
func (x *CreateConversationRequest) ProtoReflect() protoreflect.Message
func (*CreateConversationRequest) Reset
func (x *CreateConversationRequest) Reset()
func (*CreateConversationRequest) String
func (x *CreateConversationRequest) String() string
CreateDataStoreMetadata
type CreateDataStoreMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateDataStoreMetadata) Descriptor
func (*CreateDataStoreMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.
func (*CreateDataStoreMetadata) GetCreateTime
func (x *CreateDataStoreMetadata) GetCreateTime() *timestamppb.Timestamp
func (*CreateDataStoreMetadata) GetUpdateTime
func (x *CreateDataStoreMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*CreateDataStoreMetadata) ProtoMessage
func (*CreateDataStoreMetadata) ProtoMessage()
func (*CreateDataStoreMetadata) ProtoReflect
func (x *CreateDataStoreMetadata) ProtoReflect() protoreflect.Message
func (*CreateDataStoreMetadata) Reset
func (x *CreateDataStoreMetadata) Reset()
func (*CreateDataStoreMetadata) String
func (x *CreateDataStoreMetadata) String() string
CreateDataStoreRequest
type CreateDataStoreRequest struct {
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
CreateAdvancedSiteSearch bool "" /* 138 byte string literal not displayed */
}
Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] method.
func (*CreateDataStoreRequest) Descriptor
func (*CreateDataStoreRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.
func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch
func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() bool
func (*CreateDataStoreRequest) GetDataStore
func (x *CreateDataStoreRequest) GetDataStore() *DataStore
func (*CreateDataStoreRequest) GetDataStoreId
func (x *CreateDataStoreRequest) GetDataStoreId() string
func (*CreateDataStoreRequest) GetParent
func (x *CreateDataStoreRequest) GetParent() string
func (*CreateDataStoreRequest) ProtoMessage
func (*CreateDataStoreRequest) ProtoMessage()
func (*CreateDataStoreRequest) ProtoReflect
func (x *CreateDataStoreRequest) ProtoReflect() protoreflect.Message
func (*CreateDataStoreRequest) Reset
func (x *CreateDataStoreRequest) Reset()
func (*CreateDataStoreRequest) String
func (x *CreateDataStoreRequest) String() string
CreateDocumentRequest
type CreateDocumentRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
// create.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// Required. The ID to use for the
// [Document][google.cloud.discoveryengine.v1beta.Document], which will become
// the final component of the
// [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
//
// If the caller does not have permission to create the
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// This field must be unique among all
// [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
// [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
// contains filtered or unexported fields
}
Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.
func (*CreateDocumentRequest) Descriptor
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
CreateEngineMetadata
type CreateEngineMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateEngineMetadata) Descriptor
func (*CreateEngineMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.
func (*CreateEngineMetadata) GetCreateTime
func (x *CreateEngineMetadata) GetCreateTime() *timestamppb.Timestamp
func (*CreateEngineMetadata) GetUpdateTime
func (x *CreateEngineMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*CreateEngineMetadata) ProtoMessage
func (*CreateEngineMetadata) ProtoMessage()
func (*CreateEngineMetadata) ProtoReflect
func (x *CreateEngineMetadata) ProtoReflect() protoreflect.Message
func (*CreateEngineMetadata) Reset
func (x *CreateEngineMetadata) Reset()
func (*CreateEngineMetadata) String
func (x *CreateEngineMetadata) String() string
CreateEngineRequest
type CreateEngineRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Engine][google.cloud.discoveryengine.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
func (*CreateEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.
func (*CreateEngineRequest) GetEngine
func (x *CreateEngineRequest) GetEngine() *Engine
func (*CreateEngineRequest) GetEngineId
func (x *CreateEngineRequest) GetEngineId() string
func (*CreateEngineRequest) GetParent
func (x *CreateEngineRequest) GetParent() string
func (*CreateEngineRequest) ProtoMessage
func (*CreateEngineRequest) ProtoMessage()
func (*CreateEngineRequest) ProtoReflect
func (x *CreateEngineRequest) ProtoReflect() protoreflect.Message
func (*CreateEngineRequest) Reset
func (x *CreateEngineRequest) Reset()
func (*CreateEngineRequest) String
func (x *CreateEngineRequest) String() string
CreateSchemaMetadata
type CreateSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata for Create Schema LRO.
func (*CreateSchemaMetadata) Descriptor
func (*CreateSchemaMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.
func (*CreateSchemaMetadata) GetCreateTime
func (x *CreateSchemaMetadata) GetCreateTime() *timestamppb.Timestamp
func (*CreateSchemaMetadata) GetUpdateTime
func (x *CreateSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*CreateSchemaMetadata) ProtoMessage
func (*CreateSchemaMetadata) ProtoMessage()
func (*CreateSchemaMetadata) ProtoReflect
func (x *CreateSchemaMetadata) ProtoReflect() protoreflect.Message
func (*CreateSchemaMetadata) Reset
func (x *CreateSchemaMetadata) Reset()
func (*CreateSchemaMetadata) String
func (x *CreateSchemaMetadata) String() string
CreateSchemaRequest
type CreateSchemaRequest struct {
// Required. The parent data store resource name, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
// create.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// Required. The ID to use for the
// [Schema][google.cloud.discoveryengine.v1beta.Schema], which will become the
// final component of the
// [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name].
//
// This field should conform to
// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
// limit of 63 characters.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// contains filtered or unexported fields
}
Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.
func (*CreateSchemaRequest) Descriptor
func (*CreateSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.
func (*CreateSchemaRequest) GetParent
func (x *CreateSchemaRequest) GetParent() string
func (*CreateSchemaRequest) GetSchema
func (x *CreateSchemaRequest) GetSchema() *Schema
func (*CreateSchemaRequest) GetSchemaId
func (x *CreateSchemaRequest) GetSchemaId() string
func (*CreateSchemaRequest) ProtoMessage
func (*CreateSchemaRequest) ProtoMessage()
func (*CreateSchemaRequest) ProtoReflect
func (x *CreateSchemaRequest) ProtoReflect() protoreflect.Message
func (*CreateSchemaRequest) Reset
func (x *CreateSchemaRequest) Reset()
func (*CreateSchemaRequest) String
func (x *CreateSchemaRequest) String() string
CreateSessionRequest
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
func (*CreateSessionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.
func (*CreateSessionRequest) GetParent
func (x *CreateSessionRequest) GetParent() string
func (*CreateSessionRequest) GetSession
func (x *CreateSessionRequest) GetSession() *Session
func (*CreateSessionRequest) ProtoMessage
func (*CreateSessionRequest) ProtoMessage()
func (*CreateSessionRequest) ProtoReflect
func (x *CreateSessionRequest) ProtoReflect() protoreflect.Message
func (*CreateSessionRequest) Reset
func (x *CreateSessionRequest) Reset()
func (*CreateSessionRequest) String
func (x *CreateSessionRequest) String() string
CreateTargetSiteMetadata
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
func (*CreateTargetSiteMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*CreateTargetSiteMetadata) GetCreateTime
func (x *CreateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestamp
func (*CreateTargetSiteMetadata) GetUpdateTime
func (x *CreateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*CreateTargetSiteMetadata) ProtoMessage
func (*CreateTargetSiteMetadata) ProtoMessage()
func (*CreateTargetSiteMetadata) ProtoReflect
func (x *CreateTargetSiteMetadata) ProtoReflect() protoreflect.Message
func (*CreateTargetSiteMetadata) Reset
func (x *CreateTargetSiteMetadata) Reset()
func (*CreateTargetSiteMetadata) String
func (x *CreateTargetSiteMetadata) String() string
CreateTargetSiteRequest
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
func (*CreateTargetSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*CreateTargetSiteRequest) GetParent
func (x *CreateTargetSiteRequest) GetParent() string
func (*CreateTargetSiteRequest) GetTargetSite
func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSite
func (*CreateTargetSiteRequest) ProtoMessage
func (*CreateTargetSiteRequest) ProtoMessage()
func (*CreateTargetSiteRequest) ProtoReflect
func (x *CreateTargetSiteRequest) ProtoReflect() protoreflect.Message
func (*CreateTargetSiteRequest) Reset
func (x *CreateTargetSiteRequest) Reset()
func (*CreateTargetSiteRequest) String
func (x *CreateTargetSiteRequest) String() string
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
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
DataStore
type DataStore struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
IndustryVertical IndustryVertical "" /* 168 byte string literal not displayed */
SolutionTypes []SolutionType "" /* 162 byte string literal not displayed */
DefaultSchemaId string `protobuf:"bytes,7,opt,name=default_schema_id,json=defaultSchemaId,proto3" json:"default_schema_id,omitempty"`
ContentConfig DataStore_ContentConfig "" /* 166 byte string literal not displayed */
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
DocumentProcessingConfig *DocumentProcessingConfig "" /* 136 byte string literal not displayed */
StartingSchema *Schema `protobuf:"bytes,28,opt,name=starting_schema,json=startingSchema,proto3" json:"starting_schema,omitempty"`
}
DataStore captures global settings and configs at the DataStore level.
func (*DataStore) Descriptor
Deprecated: Use DataStore.ProtoReflect.Descriptor instead.
func (*DataStore) GetContentConfig
func (x *DataStore) GetContentConfig() DataStore_ContentConfig
func (*DataStore) GetCreateTime
func (x *DataStore) GetCreateTime() *timestamppb.Timestamp
func (*DataStore) GetDefaultSchemaId
func (*DataStore) GetDisplayName
func (*DataStore) GetDocumentProcessingConfig
func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig
func (*DataStore) GetIndustryVertical
func (x *DataStore) GetIndustryVertical() IndustryVertical
func (*DataStore) GetName
func (*DataStore) GetSolutionTypes
func (x *DataStore) GetSolutionTypes() []SolutionType
func (*DataStore) GetStartingSchema
func (*DataStore) ProtoMessage
func (*DataStore) ProtoMessage()
func (*DataStore) ProtoReflect
func (x *DataStore) ProtoReflect() protoreflect.Message
func (*DataStore) Reset
func (x *DataStore) Reset()
func (*DataStore) String
DataStoreServiceClient
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
func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClient
DataStoreServiceServer
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.
DataStore_ContentConfig
type DataStore_ContentConfig int32
Content config of the data store.
DataStore_CONTENT_CONFIG_UNSPECIFIED, DataStore_NO_CONTENT, DataStore_CONTENT_REQUIRED, DataStore_PUBLIC_WEBSITE
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
func (DataStore_ContentConfig) Descriptor() protoreflect.EnumDescriptor
func (DataStore_ContentConfig) Enum
func (x DataStore_ContentConfig) Enum() *DataStore_ContentConfig
func (DataStore_ContentConfig) EnumDescriptor
func (DataStore_ContentConfig) EnumDescriptor() ([]byte, []int)
Deprecated: Use DataStore_ContentConfig.Descriptor instead.
func (DataStore_ContentConfig) Number
func (x DataStore_ContentConfig) Number() protoreflect.EnumNumber
func (DataStore_ContentConfig) String
func (x DataStore_ContentConfig) String() string
func (DataStore_ContentConfig) Type
func (DataStore_ContentConfig) Type() protoreflect.EnumType
DeleteConversationRequest
type DeleteConversationRequest struct {
// Required. The resource name of the Conversation to delete. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for DeleteConversation method.
func (*DeleteConversationRequest) Descriptor
func (*DeleteConversationRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.
func (*DeleteConversationRequest) GetName
func (x *DeleteConversationRequest) GetName() string
func (*DeleteConversationRequest) ProtoMessage
func (*DeleteConversationRequest) ProtoMessage()
func (*DeleteConversationRequest) ProtoReflect
func (x *DeleteConversationRequest) ProtoReflect() protoreflect.Message
func (*DeleteConversationRequest) Reset
func (x *DeleteConversationRequest) Reset()
func (*DeleteConversationRequest) String
func (x *DeleteConversationRequest) String() string
DeleteDataStoreMetadata
type DeleteDataStoreMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteDataStoreMetadata) Descriptor
func (*DeleteDataStoreMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.
func (*DeleteDataStoreMetadata) GetCreateTime
func (x *DeleteDataStoreMetadata) GetCreateTime() *timestamppb.Timestamp
func (*DeleteDataStoreMetadata) GetUpdateTime
func (x *DeleteDataStoreMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*DeleteDataStoreMetadata) ProtoMessage
func (*DeleteDataStoreMetadata) ProtoMessage()
func (*DeleteDataStoreMetadata) ProtoReflect
func (x *DeleteDataStoreMetadata) ProtoReflect() protoreflect.Message
func (*DeleteDataStoreMetadata) Reset
func (x *DeleteDataStoreMetadata) Reset()
func (*DeleteDataStoreMetadata) String
func (x *DeleteDataStoreMetadata) String() string
DeleteDataStoreRequest
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
func (*DeleteDataStoreRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.
func (*DeleteDataStoreRequest) GetName
func (x *DeleteDataStoreRequest) GetName() string
func (*DeleteDataStoreRequest) ProtoMessage
func (*DeleteDataStoreRequest) ProtoMessage()
func (*DeleteDataStoreRequest) ProtoReflect
func (x *DeleteDataStoreRequest) ProtoReflect() protoreflect.Message
func (*DeleteDataStoreRequest) Reset
func (x *DeleteDataStoreRequest) Reset()
func (*DeleteDataStoreRequest) String
func (x *DeleteDataStoreRequest) String() string
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
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
DeleteEngineMetadata
type DeleteEngineMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteEngineMetadata) Descriptor
func (*DeleteEngineMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.
func (*DeleteEngineMetadata) GetCreateTime
func (x *DeleteEngineMetadata) GetCreateTime() *timestamppb.Timestamp
func (*DeleteEngineMetadata) GetUpdateTime
func (x *DeleteEngineMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*DeleteEngineMetadata) ProtoMessage
func (*DeleteEngineMetadata) ProtoMessage()
func (*DeleteEngineMetadata) ProtoReflect
func (x *DeleteEngineMetadata) ProtoReflect() protoreflect.Message
func (*DeleteEngineMetadata) Reset
func (x *DeleteEngineMetadata) Reset()
func (*DeleteEngineMetadata) String
func (x *DeleteEngineMetadata) String() string
DeleteEngineRequest
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
func (*DeleteEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.
func (*DeleteEngineRequest) GetName
func (x *DeleteEngineRequest) GetName() string
func (*DeleteEngineRequest) ProtoMessage
func (*DeleteEngineRequest) ProtoMessage()
func (*DeleteEngineRequest) ProtoReflect
func (x *DeleteEngineRequest) ProtoReflect() protoreflect.Message
func (*DeleteEngineRequest) Reset
func (x *DeleteEngineRequest) Reset()
func (*DeleteEngineRequest) String
func (x *DeleteEngineRequest) String() string
DeleteSchemaMetadata
type DeleteSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata for DeleteSchema LRO.
func (*DeleteSchemaMetadata) Descriptor
func (*DeleteSchemaMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.
func (*DeleteSchemaMetadata) GetCreateTime
func (x *DeleteSchemaMetadata) GetCreateTime() *timestamppb.Timestamp
func (*DeleteSchemaMetadata) GetUpdateTime
func (x *DeleteSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*DeleteSchemaMetadata) ProtoMessage
func (*DeleteSchemaMetadata) ProtoMessage()
func (*DeleteSchemaMetadata) ProtoReflect
func (x *DeleteSchemaMetadata) ProtoReflect() protoreflect.Message
func (*DeleteSchemaMetadata) Reset
func (x *DeleteSchemaMetadata) Reset()
func (*DeleteSchemaMetadata) String
func (x *DeleteSchemaMetadata) String() string
DeleteSchemaRequest
type DeleteSchemaRequest struct {
// Required. The full resource name of the schema, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.
func (*DeleteSchemaRequest) Descriptor
func (*DeleteSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.
func (*DeleteSchemaRequest) GetName
func (x *DeleteSchemaRequest) GetName() string
func (*DeleteSchemaRequest) ProtoMessage
func (*DeleteSchemaRequest) ProtoMessage()
func (*DeleteSchemaRequest) ProtoReflect
func (x *DeleteSchemaRequest) ProtoReflect() protoreflect.Message
func (*DeleteSchemaRequest) Reset
func (x *DeleteSchemaRequest) Reset()
func (*DeleteSchemaRequest) String
func (x *DeleteSchemaRequest) String() string
DeleteSessionRequest
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
func (*DeleteSessionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSessionRequest.ProtoReflect.Descriptor instead.
func (*DeleteSessionRequest) GetName
func (x *DeleteSessionRequest) GetName() string
func (*DeleteSessionRequest) ProtoMessage
func (*DeleteSessionRequest) ProtoMessage()
func (*DeleteSessionRequest) ProtoReflect
func (x *DeleteSessionRequest) ProtoReflect() protoreflect.Message
func (*DeleteSessionRequest) Reset
func (x *DeleteSessionRequest) Reset()
func (*DeleteSessionRequest) String
func (x *DeleteSessionRequest) String() string
DeleteTargetSiteMetadata
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
func (*DeleteTargetSiteMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTargetSiteMetadata) GetCreateTime
func (x *DeleteTargetSiteMetadata) GetCreateTime() *timestamppb.Timestamp
func (*DeleteTargetSiteMetadata) GetUpdateTime
func (x *DeleteTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*DeleteTargetSiteMetadata) ProtoMessage
func (*DeleteTargetSiteMetadata) ProtoMessage()
func (*DeleteTargetSiteMetadata) ProtoReflect
func (x *DeleteTargetSiteMetadata) ProtoReflect() protoreflect.Message
func (*DeleteTargetSiteMetadata) Reset
func (x *DeleteTargetSiteMetadata) Reset()
func (*DeleteTargetSiteMetadata) String
func (x *DeleteTargetSiteMetadata) String() string
DeleteTargetSiteRequest
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
func (*DeleteTargetSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*DeleteTargetSiteRequest) GetName
func (x *DeleteTargetSiteRequest) GetName() string
func (*DeleteTargetSiteRequest) ProtoMessage
func (*DeleteTargetSiteRequest) ProtoMessage()
func (*DeleteTargetSiteRequest) ProtoReflect
func (x *DeleteTargetSiteRequest) ProtoReflect() protoreflect.Message
func (*DeleteTargetSiteRequest) Reset
func (x *DeleteTargetSiteRequest) Reset()
func (*DeleteTargetSiteRequest) String
func (x *DeleteTargetSiteRequest) String() string
DisableAdvancedSiteSearchMetadata
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
func (*DisableAdvancedSiteSearchMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchMetadata) GetCreateTime
func (x *DisableAdvancedSiteSearchMetadata) GetCreateTime() *timestamppb.Timestamp
func (*DisableAdvancedSiteSearchMetadata) GetUpdateTime
func (x *DisableAdvancedSiteSearchMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*DisableAdvancedSiteSearchMetadata) ProtoMessage
func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()
func (*DisableAdvancedSiteSearchMetadata) ProtoReflect
func (x *DisableAdvancedSiteSearchMetadata) ProtoReflect() protoreflect.Message
func (*DisableAdvancedSiteSearchMetadata) Reset
func (x *DisableAdvancedSiteSearchMetadata) Reset()
func (*DisableAdvancedSiteSearchMetadata) String
func (x *DisableAdvancedSiteSearchMetadata) String() string
DisableAdvancedSiteSearchRequest
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
func (*DisableAdvancedSiteSearchRequest) Descriptor() ([]byte, []int)
Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine
func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() string
func (*DisableAdvancedSiteSearchRequest) ProtoMessage
func (*DisableAdvancedSiteSearchRequest) ProtoMessage()
func (*DisableAdvancedSiteSearchRequest) ProtoReflect
func (x *DisableAdvancedSiteSearchRequest) ProtoReflect() protoreflect.Message
func (*DisableAdvancedSiteSearchRequest) Reset
func (x *DisableAdvancedSiteSearchRequest) Reset()
func (*DisableAdvancedSiteSearchRequest) String
func (x *DisableAdvancedSiteSearchRequest) String() string
DisableAdvancedSiteSearchResponse
type DisableAdvancedSiteSearchResponse struct {
// contains filtered or unexported fields
}
Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
func (*DisableAdvancedSiteSearchResponse) Descriptor
func (*DisableAdvancedSiteSearchResponse) Descriptor() ([]byte, []int)
Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchResponse) ProtoMessage
func (*DisableAdvancedSiteSearchResponse) ProtoMessage()
func (*DisableAdvancedSiteSearchResponse) ProtoReflect
func (x *DisableAdvancedSiteSearchResponse) ProtoReflect() protoreflect.Message
func (*DisableAdvancedSiteSearchResponse) Reset
func (x *DisableAdvancedSiteSearchResponse) Reset()
func (*DisableAdvancedSiteSearchResponse) String
func (x *DisableAdvancedSiteSearchResponse) String() string
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"`
// contains filtered or unexported fields
}
Document captures all raw metadata information of items to be recommended or searched.
func (*Document) Descriptor
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (*Document) GetContent
func (x *Document) GetContent() *Document_Content
func (*Document) GetData
func (m *Document) GetData() isDocument_Data
func (*Document) GetDerivedStructData
func (*Document) GetId
func (*Document) GetIndexTime
func (x *Document) GetIndexTime() *timestamppb.Timestamp
func (*Document) GetJsonData
func (*Document) GetName
func (*Document) GetParentDocumentId
func (*Document) GetSchemaId
func (*Document) GetStructData
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
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 will be 2 if two quantities of the same Document
// are involved in a `add-to-cart` event.
//
// Required for events of the following event types:
//
// * `add-to-cart`
// * `purchase`
Quantity *int32 `protobuf:"varint,3,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
// The promotion IDs associated with this Document.
// Currently, this field is restricted to at most one ID.
PromotionIds []string `protobuf:"bytes,4,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
// contains filtered or unexported fields
}
Detailed document information associated with a user event.
func (*DocumentInfo) Descriptor
func (*DocumentInfo) Descriptor() ([]byte, []int)
Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.
func (*DocumentInfo) GetDocumentDescriptor
func (m *DocumentInfo) GetDocumentDescriptor() isDocumentInfo_DocumentDescriptor
func (*DocumentInfo) GetId
func (x *DocumentInfo) GetId() string
func (*DocumentInfo) GetName
func (x *DocumentInfo) GetName() string
func (*DocumentInfo) GetPromotionIds
func (x *DocumentInfo) GetPromotionIds() []string
func (*DocumentInfo) GetQuantity
func (x *DocumentInfo) GetQuantity() int32
func (*DocumentInfo) GetUri
func (x *DocumentInfo) GetUri() string
func (*DocumentInfo) ProtoMessage
func (*DocumentInfo) ProtoMessage()
func (*DocumentInfo) ProtoReflect
func (x *DocumentInfo) ProtoReflect() protoreflect.Message
func (*DocumentInfo) Reset
func (x *DocumentInfo) Reset()
func (*DocumentInfo) String
func (x *DocumentInfo) String() string
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"`
}
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"`
}
DocumentInfo_Uri
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"`
}
DocumentProcessingConfig
type DocumentProcessingConfig struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DefaultParsingConfig *DocumentProcessingConfig_ParsingConfig `protobuf:"bytes,4,opt,name=default_parsing_config,json=defaultParsingConfig,proto3" json:"default_parsing_config,omitempty"`
ParsingConfigOverrides map[string]*DocumentProcessingConfig_ParsingConfig "" /* 217 byte string literal not displayed */
}
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
func (*DocumentProcessingConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig) GetDefaultParsingConfig
func (x *DocumentProcessingConfig) GetDefaultParsingConfig() *DocumentProcessingConfig_ParsingConfig
func (*DocumentProcessingConfig) GetName
func (x *DocumentProcessingConfig) GetName() string
func (*DocumentProcessingConfig) GetParsingConfigOverrides
func (x *DocumentProcessingConfig) GetParsingConfigOverrides() map[string]*DocumentProcessingConfig_ParsingConfig
func (*DocumentProcessingConfig) ProtoMessage
func (*DocumentProcessingConfig) ProtoMessage()
func (*DocumentProcessingConfig) ProtoReflect
func (x *DocumentProcessingConfig) ProtoReflect() protoreflect.Message
func (*DocumentProcessingConfig) Reset
func (x *DocumentProcessingConfig) Reset()
func (*DocumentProcessingConfig) String
func (x *DocumentProcessingConfig) String() string
DocumentProcessingConfig_ParsingConfig
type DocumentProcessingConfig_ParsingConfig struct {
// Configs for document processing types.
//
// Types that are assignable to TypeDedicatedConfig:
//
// *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_
// *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_
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
func (*DocumentProcessingConfig_ParsingConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig
func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig
func (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig
func (m *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig
func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage()
func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig) ProtoReflect() protoreflect.Message
func (*DocumentProcessingConfig_ParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig) Reset()
func (*DocumentProcessingConfig_ParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig) String() string
DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig
type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig struct {
// contains filtered or unexported fields
}
The digital parsing configurations for documents.
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage()
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect() protoreflect.Message
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset()
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String() string
DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_
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"`
}
DocumentProcessingConfig_ParsingConfig_OcrParsingConfig
type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {
EnhancedDocumentElements []string "" /* 135 byte string literal not displayed */
UseNativeText bool `protobuf:"varint,2,opt,name=use_native_text,json=useNativeText,proto3" json:"use_native_text,omitempty"`
}
The OCR parsing configurations for documents.
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetEnhancedDocumentElements
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
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText() bool
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage()
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect() protoreflect.Message
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset()
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String() string
DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_
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"`
}
DocumentServiceClient
type DocumentServiceClient interface {
// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
// processing may be synchronous. Non-existing items will be created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
// successfully updated.
ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(ctx context.Context, in *PurgeDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}
DocumentServiceClient is the client API for DocumentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDocumentServiceClient
func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient
DocumentServiceServer
type DocumentServiceServer interface {
// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
// processing may be synchronous. Non-existing items will be created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
// successfully updated.
ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
}
DocumentServiceServer is the server API for DocumentService service.
Document_Content
type Document_Content struct {
// Types that are assignable to Content:
//
// *Document_Content_RawBytes
// *Document_Content_Uri
Content isDocument_Content_Content `protobuf_oneof:"content"`
// The MIME type of the content. Supported types:
//
// * `application/pdf` (PDF, only native PDFs are supported for now)
// * `text/html` (HTML)
// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
// * `text/plain` (TXT)
//
// See https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}
Unstructured data linked to this document.
func (*Document_Content) Descriptor
func (*Document_Content) Descriptor() ([]byte, []int)
Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.
func (*Document_Content) GetContent
func (m *Document_Content) GetContent() isDocument_Content_Content
func (*Document_Content) GetMimeType
func (x *Document_Content) GetMimeType() string
func (*Document_Content) GetRawBytes
func (x *Document_Content) GetRawBytes() []byte
func (*Document_Content) GetUri
func (x *Document_Content) GetUri() string
func (*Document_Content) ProtoMessage
func (*Document_Content) ProtoMessage()
func (*Document_Content) ProtoReflect
func (x *Document_Content) ProtoReflect() protoreflect.Message
func (*Document_Content) Reset
func (x *Document_Content) Reset()
func (*Document_Content) String
func (x *Document_Content) String() string
Document_Content_RawBytes
type Document_Content_RawBytes struct {
// The content represented as a stream of bytes. The maximum length is
// 1,000,000 bytes (1 MB / ~0.95 MiB).
//
// Note: As with all `bytes` fields, this field is represented as pure
// binary in Protocol Buffers and base64-encoded string in JSON. For
// example, `abc123!?$*&()'-=@~` should be represented as
// `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
// https://developers.google.com/protocol-buffers/docs/proto3#json.
RawBytes []byte `protobuf:"bytes,2,opt,name=raw_bytes,json=rawBytes,proto3,oneof"`
}
Document_Content_Uri
type Document_Content_Uri struct {
// The URI of the content. Only Cloud Storage URIs (e.g.
// `gs://bucket-name/path/to/file`) are supported. The maximum file size
// is 2.5 MB for text-based formats, 100 MB for other formats.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3,oneof"`
}
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"`
}
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"`
}
DoubleList
type DoubleList struct {
// Double values.
Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
Double list.
func (*DoubleList) Descriptor
func (*DoubleList) Descriptor() ([]byte, []int)
Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.
func (*DoubleList) GetValues
func (x *DoubleList) GetValues() []float64
func (*DoubleList) ProtoMessage
func (*DoubleList) ProtoMessage()
func (*DoubleList) ProtoReflect
func (x *DoubleList) ProtoReflect() protoreflect.Message
func (*DoubleList) Reset
func (x *DoubleList) Reset()
func (*DoubleList) String
func (x *DoubleList) String() string
EmbeddingConfig
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
func (*EmbeddingConfig) Descriptor() ([]byte, []int)
Deprecated: Use EmbeddingConfig.ProtoReflect.Descriptor instead.
func (*EmbeddingConfig) GetFieldPath
func (x *EmbeddingConfig) GetFieldPath() string
func (*EmbeddingConfig) ProtoMessage
func (*EmbeddingConfig) ProtoMessage()
func (*EmbeddingConfig) ProtoReflect
func (x *EmbeddingConfig) ProtoReflect() protoreflect.Message
func (*EmbeddingConfig) Reset
func (x *EmbeddingConfig) Reset()
func (*EmbeddingConfig) String
func (x *EmbeddingConfig) String() string
EnableAdvancedSiteSearchMetadata
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
func (*EnableAdvancedSiteSearchMetadata) Descriptor() ([]byte, []int)
Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchMetadata) GetCreateTime
func (x *EnableAdvancedSiteSearchMetadata) GetCreateTime() *timestamppb.Timestamp
func (*EnableAdvancedSiteSearchMetadata) GetUpdateTime
func (x *EnableAdvancedSiteSearchMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*EnableAdvancedSiteSearchMetadata) ProtoMessage
func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()
func (*EnableAdvancedSiteSearchMetadata) ProtoReflect
func (x *EnableAdvancedSiteSearchMetadata) ProtoReflect() protoreflect.Message
func (*EnableAdvancedSiteSearchMetadata) Reset
func (x *EnableAdvancedSiteSearchMetadata) Reset()
func (*EnableAdvancedSiteSearchMetadata) String
func (x *EnableAdvancedSiteSearchMetadata) String() string
EnableAdvancedSiteSearchRequest
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
func (*EnableAdvancedSiteSearchRequest) Descriptor() ([]byte, []int)
Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine
func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() string
func (*EnableAdvancedSiteSearchRequest) ProtoMessage
func (*EnableAdvancedSiteSearchRequest) ProtoMessage()
func (*EnableAdvancedSiteSearchRequest) ProtoReflect
func (x *EnableAdvancedSiteSearchRequest) ProtoReflect() protoreflect.Message
func (*EnableAdvancedSiteSearchRequest) Reset
func (x *EnableAdvancedSiteSearchRequest) Reset()
func (*EnableAdvancedSiteSearchRequest) String
func (x *EnableAdvancedSiteSearchRequest) String() string
EnableAdvancedSiteSearchResponse
type EnableAdvancedSiteSearchResponse struct {
// contains filtered or unexported fields
}
Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
func (*EnableAdvancedSiteSearchResponse) Descriptor
func (*EnableAdvancedSiteSearchResponse) Descriptor() ([]byte, []int)
Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchResponse) ProtoMessage
func (*EnableAdvancedSiteSearchResponse) ProtoMessage()
func (*EnableAdvancedSiteSearchResponse) ProtoReflect
func (x *EnableAdvancedSiteSearchResponse) ProtoReflect() protoreflect.Message
func (*EnableAdvancedSiteSearchResponse) Reset
func (x *EnableAdvancedSiteSearchResponse) Reset()
func (*EnableAdvancedSiteSearchResponse) String
func (x *EnableAdvancedSiteSearchResponse) String() string
Engine
type Engine struct {
EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
EngineMetadata isEngine_EngineMetadata `protobuf_oneof:"engine_metadata"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
DataStoreIds []string `protobuf:"bytes,5,rep,name=data_store_ids,json=dataStoreIds,proto3" json:"data_store_ids,omitempty"`
SolutionType SolutionType "" /* 152 byte string literal not displayed */
IndustryVertical IndustryVertical "" /* 169 byte string literal not displayed */
CommonConfig *Engine_CommonConfig `protobuf:"bytes,15,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
}
Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1beta.Engine].
func (*Engine) Descriptor
Deprecated: Use Engine.ProtoReflect.Descriptor instead.
func (*Engine) GetChatEngineConfig
func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig
func (*Engine) GetChatEngineMetadata
func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata
func (*Engine) GetCommonConfig
func (x *Engine) GetCommonConfig() *Engine_CommonConfig
func (*Engine) GetCreateTime
func (x *Engine) GetCreateTime() *timestamppb.Timestamp
func (*Engine) GetDataStoreIds
func (*Engine) GetDisplayName
func (*Engine) GetEngineConfig
func (m *Engine) GetEngineConfig() isEngine_EngineConfig
func (*Engine) GetEngineMetadata
func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata
func (*Engine) GetIndustryVertical
func (x *Engine) GetIndustryVertical() IndustryVertical
func (*Engine) GetName
func (*Engine) GetSearchEngineConfig
func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfig
func (*Engine) GetSolutionType
func (x *Engine) GetSolutionType() SolutionType
func (*Engine) GetUpdateTime
func (x *Engine) GetUpdateTime() *timestamppb.Timestamp
func (*Engine) ProtoMessage
func (*Engine) ProtoMessage()
func (*Engine) ProtoReflect
func (x *Engine) ProtoReflect() protoreflect.Message
func (*Engine) Reset
func (x *Engine) Reset()
func (*Engine) String
EngineServiceClient
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
func NewEngineServiceClient(cc grpc.ClientConnInterface) EngineServiceClient
EngineServiceServer
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.
Engine_ChatEngineConfig
type Engine_ChatEngineConfig struct {
AgentCreationConfig *Engine_ChatEngineConfig_AgentCreationConfig `protobuf:"bytes,1,opt,name=agent_creation_config,json=agentCreationConfig,proto3" json:"agent_creation_config,omitempty"`
DialogflowAgentToLink string "" /* 128 byte string literal not displayed */
}
Configurations for a Chat Engine.
func (*Engine_ChatEngineConfig) Descriptor
func (*Engine_ChatEngineConfig) Descriptor() ([]byte, []int)
Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineConfig) GetAgentCreationConfig
func (x *Engine_ChatEngineConfig) GetAgentCreationConfig() *Engine_ChatEngineConfig_AgentCreationConfig
func (*Engine_ChatEngineConfig) GetDialogflowAgentToLink
func (x *Engine_ChatEngineConfig) GetDialogflowAgentToLink() string
func (*Engine_ChatEngineConfig) ProtoMessage
func (*Engine_ChatEngineConfig) ProtoMessage()
func (*Engine_ChatEngineConfig) ProtoReflect
func (x *Engine_ChatEngineConfig) ProtoReflect() protoreflect.Message
func (*Engine_ChatEngineConfig) Reset
func (x *Engine_ChatEngineConfig) Reset()
func (*Engine_ChatEngineConfig) String
func (x *Engine_ChatEngineConfig) String() string
Engine_ChatEngineConfig_
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"`
}
Engine_ChatEngineConfig_AgentCreationConfig
type Engine_ChatEngineConfig_AgentCreationConfig struct {
// Name of the company, organization or other entity that the agent
// represents. Used for knowledge connector LLM prompt and for knowledge
// search.
Business string `protobuf:"bytes,1,opt,name=business,proto3" json:"business,omitempty"`
// Required. The default language of the agent as a language tag.
// See [Language
// Support](https://cloud.google.com/dialogflow/docs/reference/language)
// for a list of the currently supported language codes.
DefaultLanguageCode string `protobuf:"bytes,2,opt,name=default_language_code,json=defaultLanguageCode,proto3" json:"default_language_code,omitempty"`
// Required. The time zone of the agent from the [time zone
// database](https://www.iana.org/time-zones), e.g., America/New_York,
// Europe/Paris.
TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Agent location for Agent creation, supported values: global/us/eu.
// If not provided, us Engine will create Agent using us-central-1 by
// default; eu Engine will create Agent using eu-west-1 by default.
Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}
Configurations for generating a Dialogflow agent.
Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] API after engine creation.
func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor
func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor() ([]byte, []int)
Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness() string
func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string
func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetLocation() string
func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone() string
func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage
func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage()
func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect
func (x *Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect() protoreflect.Message
func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset
func (x *Engine_ChatEngineConfig_AgentCreationConfig) Reset()
func (*Engine_ChatEngineConfig_AgentCreationConfig) String
func (x *Engine_ChatEngineConfig_AgentCreationConfig) String() string
Engine_ChatEngineMetadata
type Engine_ChatEngineMetadata struct {
// The resource name of a Dialogflow agent, that this Chat Engine refers
// to.
//
// Format: `projects/
Additional information of a Chat Engine. Fields in this message are output only.
func (*Engine_ChatEngineMetadata) Descriptor
func (*Engine_ChatEngineMetadata) Descriptor() ([]byte, []int)
Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineMetadata) GetDialogflowAgent
func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() string
func (*Engine_ChatEngineMetadata) ProtoMessage
func (*Engine_ChatEngineMetadata) ProtoMessage()
func (*Engine_ChatEngineMetadata) ProtoReflect
func (x *Engine_ChatEngineMetadata) ProtoReflect() protoreflect.Message
func (*Engine_ChatEngineMetadata) Reset
func (x *Engine_ChatEngineMetadata) Reset()
func (*Engine_ChatEngineMetadata) String
func (x *Engine_ChatEngineMetadata) String() string
Engine_ChatEngineMetadata_
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"`
}
Engine_CommonConfig
type Engine_CommonConfig struct {
// Immutable. The name of the company, business or entity that is associated
// with the engine. Setting this may help improve LLM related features.
CompanyName string `protobuf:"bytes,1,opt,name=company_name,json=companyName,proto3" json:"company_name,omitempty"`
// contains filtered or unexported fields
}
Common configurations for an Engine.
func (*Engine_CommonConfig) Descriptor
func (*Engine_CommonConfig) Descriptor() ([]byte, []int)
Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.
func (*Engine_CommonConfig) GetCompanyName
func (x *Engine_CommonConfig) GetCompanyName() string
func (*Engine_CommonConfig) ProtoMessage
func (*Engine_CommonConfig) ProtoMessage()
func (*Engine_CommonConfig) ProtoReflect
func (x *Engine_CommonConfig) ProtoReflect() protoreflect.Message
func (*Engine_CommonConfig) Reset
func (x *Engine_CommonConfig) Reset()
func (*Engine_CommonConfig) String
func (x *Engine_CommonConfig) String() string
Engine_SearchEngineConfig
type Engine_SearchEngineConfig struct {
SearchTier SearchTier "" /* 144 byte string literal not displayed */
SearchAddOns []SearchAddOn "" /* 160 byte string literal not displayed */
}
Configurations for a Search Engine.
func (*Engine_SearchEngineConfig) Descriptor
func (*Engine_SearchEngineConfig) Descriptor() ([]byte, []int)
Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_SearchEngineConfig) GetSearchAddOns
func (x *Engine_SearchEngineConfig) GetSearchAddOns() []SearchAddOn
func (*Engine_SearchEngineConfig) GetSearchTier
func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTier
func (*Engine_SearchEngineConfig) ProtoMessage
func (*Engine_SearchEngineConfig) ProtoMessage()
func (*Engine_SearchEngineConfig) ProtoReflect
func (x *Engine_SearchEngineConfig) ProtoReflect() protoreflect.Message
func (*Engine_SearchEngineConfig) Reset
func (x *Engine_SearchEngineConfig) Reset()
func (*Engine_SearchEngineConfig) String
func (x *Engine_SearchEngineConfig) String() string
Engine_SearchEngineConfig_
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"`
}
FactChunk
type FactChunk struct {
ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
SourceMetadata map[string]string "" /* 191 byte string literal not displayed */
}
Fact Chunk.
func (*FactChunk) Descriptor
Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.
func (*FactChunk) GetChunkText
func (*FactChunk) GetSource
func (*FactChunk) GetSourceMetadata
func (*FactChunk) ProtoMessage
func (*FactChunk) ProtoMessage()
func (*FactChunk) ProtoReflect
func (x *FactChunk) ProtoReflect() protoreflect.Message
func (*FactChunk) Reset
func (x *FactChunk) Reset()
func (*FactChunk) String
FetchDomainVerificationStatusRequest
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
func (*FetchDomainVerificationStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.
func (*FetchDomainVerificationStatusRequest) GetPageSize
func (x *FetchDomainVerificationStatusRequest) GetPageSize() int32
func (*FetchDomainVerificationStatusRequest) GetPageToken
func (x *FetchDomainVerificationStatusRequest) GetPageToken() string
func (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine
func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() string
func (*FetchDomainVerificationStatusRequest) ProtoMessage
func (*FetchDomainVerificationStatusRequest) ProtoMessage()
func (*FetchDomainVerificationStatusRequest) ProtoReflect
func (x *FetchDomainVerificationStatusRequest) ProtoReflect() protoreflect.Message
func (*FetchDomainVerificationStatusRequest) Reset
func (x *FetchDomainVerificationStatusRequest) Reset()
func (*FetchDomainVerificationStatusRequest) String
func (x *FetchDomainVerificationStatusRequest) String() string
FetchDomainVerificationStatusResponse
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
func (*FetchDomainVerificationStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.
func (*FetchDomainVerificationStatusResponse) GetNextPageToken
func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() string
func (*FetchDomainVerificationStatusResponse) GetTargetSites
func (x *FetchDomainVerificationStatusResponse) GetTargetSites() []*TargetSite
func (*FetchDomainVerificationStatusResponse) GetTotalSize
func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32
func (*FetchDomainVerificationStatusResponse) ProtoMessage
func (*FetchDomainVerificationStatusResponse) ProtoMessage()
func (*FetchDomainVerificationStatusResponse) ProtoReflect
func (x *FetchDomainVerificationStatusResponse) ProtoReflect() protoreflect.Message
func (*FetchDomainVerificationStatusResponse) Reset
func (x *FetchDomainVerificationStatusResponse) Reset()
func (*FetchDomainVerificationStatusResponse) String
func (x *FetchDomainVerificationStatusResponse) String() string
FhirStoreSource
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"`
// contains filtered or unexported fields
}
Cloud FhirStore source import data from.
func (*FhirStoreSource) Descriptor
func (*FhirStoreSource) Descriptor() ([]byte, []int)
Deprecated: Use FhirStoreSource.ProtoReflect.Descriptor instead.
func (*FhirStoreSource) GetFhirStore
func (x *FhirStoreSource) GetFhirStore() string
func (*FhirStoreSource) GetGcsStagingDir
func (x *FhirStoreSource) GetGcsStagingDir() string
func (*FhirStoreSource) ProtoMessage
func (*FhirStoreSource) ProtoMessage()
func (*FhirStoreSource) ProtoReflect
func (x *FhirStoreSource) ProtoReflect() protoreflect.Message
func (*FhirStoreSource) Reset
func (x *FhirStoreSource) Reset()
func (*FhirStoreSource) String
func (x *FhirStoreSource) String() string
FirestoreSource
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 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
func (*FirestoreSource) Descriptor() ([]byte, []int)
Deprecated: Use FirestoreSource.ProtoReflect.Descriptor instead.
func (*FirestoreSource) GetCollectionId
func (x *FirestoreSource) GetCollectionId() string
func (*FirestoreSource) GetDatabaseId
func (x *FirestoreSource) GetDatabaseId() string
func (*FirestoreSource) GetGcsStagingDir
func (x *FirestoreSource) GetGcsStagingDir() string
func (*FirestoreSource) GetProjectId
func (x *FirestoreSource) GetProjectId() string
func (*FirestoreSource) ProtoMessage
func (*FirestoreSource) ProtoMessage()
func (*FirestoreSource) ProtoReflect
func (x *FirestoreSource) ProtoReflect() protoreflect.Message
func (*FirestoreSource) Reset
func (x *FirestoreSource) Reset()
func (*FirestoreSource) String
func (x *FirestoreSource) String() string
GcsSource
type GcsSource struct {
// Required. Cloud Storage URIs to input files. URI can be up to
// 2000 characters long. URIs can match the full object path (for example,
// `gs://bucket/directory/object.json`) or a pattern matching one or more
// files, such as `gs://bucket/directory/*.json`.
//
// A request can contain at most 100 files (or 100,000 files if `data_schema`
// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
// `content`).
InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
// The schema to use when parsing the data from the source.
//
// Supported values for document imports:
//
// * `document` (default): One JSON
// [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
// document must
//
// have a valid
// [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
// - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
// `input_uris` 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 even imports:
//
// * `user_event` (default): One JSON
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
// contains filtered or unexported fields
}
Cloud Storage location for input content.
func (*GcsSource) Descriptor
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (*GcsSource) GetDataSchema
func (*GcsSource) GetInputUris
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
GetAnswerRequest
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
func (*GetAnswerRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAnswerRequest.ProtoReflect.Descriptor instead.
func (*GetAnswerRequest) GetName
func (x *GetAnswerRequest) GetName() string
func (*GetAnswerRequest) ProtoMessage
func (*GetAnswerRequest) ProtoMessage()
func (*GetAnswerRequest) ProtoReflect
func (x *GetAnswerRequest) ProtoReflect() protoreflect.Message
func (*GetAnswerRequest) Reset
func (x *GetAnswerRequest) Reset()
func (*GetAnswerRequest) String
func (x *GetAnswerRequest) String() string
GetConversationRequest
type GetConversationRequest struct {
// Required. The resource name of the Conversation to get. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for GetConversation method.
func (*GetConversationRequest) Descriptor
func (*GetConversationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.
func (*GetConversationRequest) GetName
func (x *GetConversationRequest) GetName() string
func (*GetConversationRequest) ProtoMessage
func (*GetConversationRequest) ProtoMessage()
func (*GetConversationRequest) ProtoReflect
func (x *GetConversationRequest) ProtoReflect() protoreflect.Message
func (*GetConversationRequest) Reset
func (x *GetConversationRequest) Reset()
func (*GetConversationRequest) String
func (x *GetConversationRequest) String() string
GetDataStoreRequest
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
func (*GetDataStoreRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDataStoreRequest.ProtoReflect.Descriptor instead.
func (*GetDataStoreRequest) GetName
func (x *GetDataStoreRequest) GetName() string
func (*GetDataStoreRequest) ProtoMessage
func (*GetDataStoreRequest) ProtoMessage()
func (*GetDataStoreRequest) ProtoReflect
func (x *GetDataStoreRequest) ProtoReflect() protoreflect.Message
func (*GetDataStoreRequest) Reset
func (x *GetDataStoreRequest) Reset()
func (*GetDataStoreRequest) String
func (x *GetDataStoreRequest) String() string
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
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
GetEngineRequest
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
func (*GetEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetEngineRequest.ProtoReflect.Descriptor instead.
func (*GetEngineRequest) GetName
func (x *GetEngineRequest) GetName() string
func (*GetEngineRequest) ProtoMessage
func (*GetEngineRequest) ProtoMessage()
func (*GetEngineRequest) ProtoReflect
func (x *GetEngineRequest) ProtoReflect() protoreflect.Message
func (*GetEngineRequest) Reset
func (x *GetEngineRequest) Reset()
func (*GetEngineRequest) String
func (x *GetEngineRequest) String() string
GetSchemaRequest
type GetSchemaRequest struct {
// Required. The full resource name of the schema, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] method.
func (*GetSchemaRequest) Descriptor
func (*GetSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.
func (*GetSchemaRequest) GetName
func (x *GetSchemaRequest) GetName() string
func (*GetSchemaRequest) ProtoMessage
func (*GetSchemaRequest) ProtoMessage()
func (*GetSchemaRequest) ProtoReflect
func (x *GetSchemaRequest) ProtoReflect() protoreflect.Message
func (*GetSchemaRequest) Reset
func (x *GetSchemaRequest) Reset()
func (*GetSchemaRequest) String
func (x *GetSchemaRequest) String() string
GetServingConfigRequest
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
func (*GetServingConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.
func (*GetServingConfigRequest) GetName
func (x *GetServingConfigRequest) GetName() string
func (*GetServingConfigRequest) ProtoMessage
func (*GetServingConfigRequest) ProtoMessage()
func (*GetServingConfigRequest) ProtoReflect
func (x *GetServingConfigRequest) ProtoReflect() protoreflect.Message
func (*GetServingConfigRequest) Reset
func (x *GetServingConfigRequest) Reset()
func (*GetServingConfigRequest) String
func (x *GetServingConfigRequest) String() string
GetSessionRequest
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
func (*GetSessionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.
func (*GetSessionRequest) GetName
func (x *GetSessionRequest) GetName() string
func (*GetSessionRequest) ProtoMessage
func (*GetSessionRequest) ProtoMessage()
func (*GetSessionRequest) ProtoReflect
func (x *GetSessionRequest) ProtoReflect() protoreflect.Message
func (*GetSessionRequest) Reset
func (x *GetSessionRequest) Reset()
func (*GetSessionRequest) String
func (x *GetSessionRequest) String() string
GetSiteSearchEngineRequest
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
func (*GetSiteSearchEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSiteSearchEngineRequest.ProtoReflect.Descriptor instead.
func (*GetSiteSearchEngineRequest) GetName
func (x *GetSiteSearchEngineRequest) GetName() string
func (*GetSiteSearchEngineRequest) ProtoMessage
func (*GetSiteSearchEngineRequest) ProtoMessage()
func (*GetSiteSearchEngineRequest) ProtoReflect
func (x *GetSiteSearchEngineRequest) ProtoReflect() protoreflect.Message
func (*GetSiteSearchEngineRequest) Reset
func (x *GetSiteSearchEngineRequest) Reset()
func (*GetSiteSearchEngineRequest) String
func (x *GetSiteSearchEngineRequest) String() string
GetTargetSiteRequest
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
func (*GetTargetSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*GetTargetSiteRequest) GetName
func (x *GetTargetSiteRequest) GetName() string
func (*GetTargetSiteRequest) ProtoMessage
func (*GetTargetSiteRequest) ProtoMessage()
func (*GetTargetSiteRequest) ProtoReflect
func (x *GetTargetSiteRequest) ProtoReflect() protoreflect.Message
func (*GetTargetSiteRequest) Reset
func (x *GetTargetSiteRequest) Reset()
func (*GetTargetSiteRequest) String
func (x *GetTargetSiteRequest) String() string
GroundedGenerationServiceClient
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
func NewGroundedGenerationServiceClient(cc grpc.ClientConnInterface) GroundedGenerationServiceClient
GroundedGenerationServiceServer
type GroundedGenerationServiceServer interface {
// Performs a grounding check.
CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
}
GroundedGenerationServiceServer is the server API for GroundedGenerationService service.
GroundingFact
type GroundingFact struct {
FactText string `protobuf:"bytes,1,opt,name=fact_text,json=factText,proto3" json:"fact_text,omitempty"`
Attributes map[string]string "" /* 161 byte string literal not displayed */
}
Grounding Fact.
func (*GroundingFact) Descriptor
func (*GroundingFact) Descriptor() ([]byte, []int)
Deprecated: Use GroundingFact.ProtoReflect.Descriptor instead.
func (*GroundingFact) GetAttributes
func (x *GroundingFact) GetAttributes() map[string]string
func (*GroundingFact) GetFactText
func (x *GroundingFact) GetFactText() string
func (*GroundingFact) ProtoMessage
func (*GroundingFact) ProtoMessage()
func (*GroundingFact) ProtoReflect
func (x *GroundingFact) ProtoReflect() protoreflect.Message
func (*GroundingFact) Reset
func (x *GroundingFact) Reset()
func (*GroundingFact) String
func (x *GroundingFact) String() string
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
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
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
ImportDocumentsRequest
type ImportDocumentsRequest struct {
Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
ReconciliationMode ImportDocumentsRequest_ReconciliationMode "" /* 199 byte string literal not displayed */
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
IdField string `protobuf:"bytes,9,opt,name=id_field,json=idField,proto3" json:"id_field,omitempty"`
}
Request message for Import methods.
func (*ImportDocumentsRequest) Descriptor
func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.
func (*ImportDocumentsRequest) GetAutoGenerateIds
func (x *ImportDocumentsRequest) GetAutoGenerateIds() bool
func (*ImportDocumentsRequest) GetBigquerySource
func (x *ImportDocumentsRequest) GetBigquerySource() *BigQuerySource
func (*ImportDocumentsRequest) GetBigtableSource
func (x *ImportDocumentsRequest) GetBigtableSource() *BigtableSource
func (*ImportDocumentsRequest) GetCloudSqlSource
func (x *ImportDocumentsRequest) GetCloudSqlSource() *CloudSqlSource
func (*ImportDocumentsRequest) GetErrorConfig
func (x *ImportDocumentsRequest) GetErrorConfig() *ImportErrorConfig
func (*ImportDocumentsRequest) GetFhirStoreSource
func (x *ImportDocumentsRequest) GetFhirStoreSource() *FhirStoreSource
func (*ImportDocumentsRequest) GetFirestoreSource
func (x *ImportDocumentsRequest) GetFirestoreSource() *FirestoreSource
func (*ImportDocumentsRequest) GetGcsSource
func (x *ImportDocumentsRequest) GetGcsSource() *GcsSource
func (*ImportDocumentsRequest) GetIdField
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
func (x *ImportDocumentsRequest) GetSpannerSource() *SpannerSource
func (*ImportDocumentsRequest) GetUpdateMask
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
ImportDocumentsRequest_BigquerySource
type ImportDocumentsRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}
ImportDocumentsRequest_BigtableSource
type ImportDocumentsRequest_BigtableSource struct {
// Cloud Bigtable input source.
BigtableSource *BigtableSource `protobuf:"bytes,15,opt,name=bigtable_source,json=bigtableSource,proto3,oneof"`
}
ImportDocumentsRequest_CloudSqlSource
type ImportDocumentsRequest_CloudSqlSource struct {
// Cloud SQL input source.
CloudSqlSource *CloudSqlSource `protobuf:"bytes,12,opt,name=cloud_sql_source,json=cloudSqlSource,proto3,oneof"`
}
ImportDocumentsRequest_FhirStoreSource
type ImportDocumentsRequest_FhirStoreSource struct {
// FhirStore input source.
FhirStoreSource *FhirStoreSource `protobuf:"bytes,10,opt,name=fhir_store_source,json=fhirStoreSource,proto3,oneof"`
}
ImportDocumentsRequest_FirestoreSource
type ImportDocumentsRequest_FirestoreSource struct {
// Firestore input source.
FirestoreSource *FirestoreSource `protobuf:"bytes,13,opt,name=firestore_source,json=firestoreSource,proto3,oneof"`
}
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"`
}
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
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
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"`
}
ImportDocumentsRequest_ReconciliationMode
type ImportDocumentsRequest_ReconciliationMode int32
Indicates how imported documents are reconciled with the existing documents created or imported before.
ImportDocumentsRequest_RECONCILIATION_MODE_UNSPECIFIED, ImportDocumentsRequest_INCREMENTAL, ImportDocumentsRequest_FULL
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
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
ImportDocumentsRequest_SpannerSource
type ImportDocumentsRequest_SpannerSource struct {
// Spanner input source.
SpannerSource *SpannerSource `protobuf:"bytes,11,opt,name=spanner_source,json=spannerSource,proto3,oneof"`
}
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
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
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
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
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"`
}
ImportSuggestionDenyListEntriesMetadata
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
func (*ImportSuggestionDenyListEntriesMetadata) Descriptor() ([]byte, []int)
Deprecated: Use ImportSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesMetadata) GetCreateTime
func (x *ImportSuggestionDenyListEntriesMetadata) GetCreateTime() *timestamppb.Timestamp
func (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime
func (x *ImportSuggestionDenyListEntriesMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage
func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage()
func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect
func (x *ImportSuggestionDenyListEntriesMetadata) ProtoReflect() protoreflect.Message
func (*ImportSuggestionDenyListEntriesMetadata) Reset
func (x *ImportSuggestionDenyListEntriesMetadata) Reset()
func (*ImportSuggestionDenyListEntriesMetadata) String
func (x *ImportSuggestionDenyListEntriesMetadata) String() string
ImportSuggestionDenyListEntriesRequest
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
func (*ImportSuggestionDenyListEntriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource
func (x *ImportSuggestionDenyListEntriesRequest) GetGcsSource() *GcsSource
func (*ImportSuggestionDenyListEntriesRequest) GetInlineSource
func (x *ImportSuggestionDenyListEntriesRequest) GetInlineSource() *ImportSuggestionDenyListEntriesRequest_InlineSource
func (*ImportSuggestionDenyListEntriesRequest) GetParent
func (x *ImportSuggestionDenyListEntriesRequest) GetParent() string
func (*ImportSuggestionDenyListEntriesRequest) GetSource
func (m *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Source
func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage
func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage()
func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect
func (x *ImportSuggestionDenyListEntriesRequest) ProtoReflect() protoreflect.Message
func (*ImportSuggestionDenyListEntriesRequest) Reset
func (x *ImportSuggestionDenyListEntriesRequest) Reset()
func (*ImportSuggestionDenyListEntriesRequest) String
func (x *ImportSuggestionDenyListEntriesRequest) String() string
ImportSuggestionDenyListEntriesRequest_GcsSource
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"`
}
ImportSuggestionDenyListEntriesRequest_InlineSource
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
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor() ([]byte, []int)
Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries() []*SuggestionDenyListEntry
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage()
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect() protoreflect.Message
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) Reset()
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) String
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) String() string
ImportSuggestionDenyListEntriesRequest_InlineSource_
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"`
}
ImportSuggestionDenyListEntriesResponse
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
func (*ImportSuggestionDenyListEntriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ImportSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesResponse) GetErrorSamples
func (x *ImportSuggestionDenyListEntriesResponse) GetErrorSamples() []*status.Status
func (*ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount
func (x *ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount() int64
func (*ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount
func (x *ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount() int64
func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage
func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage()
func (*ImportSuggestionDenyListEntriesResponse) ProtoReflect
func (x *ImportSuggestionDenyListEntriesResponse) ProtoReflect() protoreflect.Message
func (*ImportSuggestionDenyListEntriesResponse) Reset
func (x *ImportSuggestionDenyListEntriesResponse) Reset()
func (*ImportSuggestionDenyListEntriesResponse) String
func (x *ImportSuggestionDenyListEntriesResponse) String() string
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
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
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
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
ImportUserEventsRequest_BigquerySource
type ImportUserEventsRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}
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"`
}
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
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
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"`
}
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
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
IndustryVertical
type IndustryVertical int32
The industry vertical associated with the [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
IndustryVertical_INDUSTRY_VERTICAL_UNSPECIFIED, IndustryVertical_GENERIC, IndustryVertical_MEDIA, IndustryVertical_HEALTHCARE_FHIR
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
func (IndustryVertical) Descriptor() protoreflect.EnumDescriptor
func (IndustryVertical) Enum
func (x IndustryVertical) Enum() *IndustryVertical
func (IndustryVertical) EnumDescriptor
func (IndustryVertical) EnumDescriptor() ([]byte, []int)
Deprecated: Use IndustryVertical.Descriptor instead.
func (IndustryVertical) Number
func (x IndustryVertical) Number() protoreflect.EnumNumber
func (IndustryVertical) String
func (x IndustryVertical) String() string
func (IndustryVertical) Type
func (IndustryVertical) Type() protoreflect.EnumType
Interval
type Interval struct {
// The lower bound of the interval. If neither of the min fields are
// set, then the lower bound is negative infinity.
//
// This field must be not larger than max.
// Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// Types that are assignable to Min:
//
// *Interval_Minimum
// *Interval_ExclusiveMinimum
Min isInterval_Min `protobuf_oneof:"min"`
// The upper bound of the interval. If neither of the max fields are
// set, then the upper bound is positive infinity.
//
// This field must be not smaller than min.
// Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// Types that are assignable to Max:
//
// *Interval_Maximum
// *Interval_ExclusiveMaximum
Max isInterval_Max `protobuf_oneof:"max"`
// contains filtered or unexported fields
}
A floating point interval.
func (*Interval) Descriptor
Deprecated: Use Interval.ProtoReflect.Descriptor instead.
func (*Interval) GetExclusiveMaximum
func (*Interval) GetExclusiveMinimum
func (*Interval) GetMax
func (m *Interval) GetMax() isInterval_Max
func (*Interval) GetMaximum
func (*Interval) GetMin
func (m *Interval) GetMin() isInterval_Min
func (*Interval) GetMinimum
func (*Interval) ProtoMessage
func (*Interval) ProtoMessage()
func (*Interval) ProtoReflect
func (x *Interval) ProtoReflect() protoreflect.Message
func (*Interval) Reset
func (x *Interval) Reset()
func (*Interval) String
Interval_ExclusiveMaximum
type Interval_ExclusiveMaximum struct {
// Exclusive upper bound.
ExclusiveMaximum float64 `protobuf:"fixed64,4,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3,oneof"`
}
Interval_ExclusiveMinimum
type Interval_ExclusiveMinimum struct {
// Exclusive lower bound.
ExclusiveMinimum float64 `protobuf:"fixed64,2,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3,oneof"`
}
Interval_Maximum
type Interval_Maximum struct {
// Inclusive upper bound.
Maximum float64 `protobuf:"fixed64,3,opt,name=maximum,proto3,oneof"`
}
Interval_Minimum
type Interval_Minimum struct {
// Inclusive lower bound.
Minimum float64 `protobuf:"fixed64,1,opt,name=minimum,proto3,oneof"`
}
ListConversationsRequest
type ListConversationsRequest struct {
// Required. The data store resource name. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of results to return. If unspecified, defaults
// to 50. Max allowed value is 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListConversations` call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A filter to apply on the list results. The supported features are:
// user_pseudo_id, state.
//
// Example:
// "user_pseudo_id = some_id"
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// A comma-separated list of fields to order by, sorted in ascending order.
// Use "desc" after a field name for descending.
// Supported fields:
// - `update_time`
// - `create_time`
// - `conversation_name`
//
// Example:
// "update_time desc"
// "create_time"
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
Request for ListConversations method.
func (*ListConversationsRequest) Descriptor
func (*ListConversationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.
func (*ListConversationsRequest) GetFilter
func (x *ListConversationsRequest) GetFilter() string
func (*ListConversationsRequest) GetOrderBy
func (x *ListConversationsRequest) GetOrderBy() string
func (*ListConversationsRequest) GetPageSize
func (x *ListConversationsRequest) GetPageSize() int32
func (*ListConversationsRequest) GetPageToken
func (x *ListConversationsRequest) GetPageToken() string
func (*ListConversationsRequest) GetParent
func (x *ListConversationsRequest) GetParent() string
func (*ListConversationsRequest) ProtoMessage
func (*ListConversationsRequest) ProtoMessage()
func (*ListConversationsRequest) ProtoReflect
func (x *ListConversationsRequest) ProtoReflect() protoreflect.Message
func (*ListConversationsRequest) Reset
func (x *ListConversationsRequest) Reset()
func (*ListConversationsRequest) String
func (x *ListConversationsRequest) String() string
ListConversationsResponse
type ListConversationsResponse struct {
// All the Conversations for a given data store.
Conversations []*Conversation `protobuf:"bytes,1,rep,name=conversations,proto3" json:"conversations,omitempty"`
// Pagination token, if not returned indicates the last page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
Response for ListConversations method.
func (*ListConversationsResponse) Descriptor
func (*ListConversationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.
func (*ListConversationsResponse) GetConversations
func (x *ListConversationsResponse) GetConversations() []*Conversation
func (*ListConversationsResponse) GetNextPageToken
func (x *ListConversationsResponse) GetNextPageToken() string
func (*ListConversationsResponse) ProtoMessage
func (*ListConversationsResponse) ProtoMessage()
func (*ListConversationsResponse) ProtoReflect
func (x *ListConversationsResponse) ProtoReflect() protoreflect.Message
func (*ListConversationsResponse) Reset
func (x *ListConversationsResponse) Reset()
func (*ListConversationsResponse) String
func (x *ListConversationsResponse) String() string
ListDataStoresRequest
type ListDataStoresRequest struct {
// Required. The parent branch resource name, such as
// `projects/{project}/locations/{location}/collections/{collection_id}`.
//
// If the caller does not have permission to list
// [DataStore][google.cloud.discoveryengine.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
func (*ListDataStoresRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDataStoresRequest.ProtoReflect.Descriptor instead.
func (*ListDataStoresRequest) GetFilter
func (x *ListDataStoresRequest) GetFilter() string
func (*ListDataStoresRequest) GetPageSize
func (x *ListDataStoresRequest) GetPageSize() int32
func (*ListDataStoresRequest) GetPageToken
func (x *ListDataStoresRequest) GetPageToken() string
func (*ListDataStoresRequest) GetParent
func (x *ListDataStoresRequest) GetParent() string
func (*ListDataStoresRequest) ProtoMessage
func (*ListDataStoresRequest) ProtoMessage()
func (*ListDataStoresRequest) ProtoReflect
func (x *ListDataStoresRequest) ProtoReflect() protoreflect.Message
func (*ListDataStoresRequest) Reset
func (x *ListDataStoresRequest) Reset()
func (*ListDataStoresRequest) String
func (x *ListDataStoresRequest) String() string
ListDataStoresResponse
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
func (*ListDataStoresResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDataStoresResponse.ProtoReflect.Descriptor instead.
func (*ListDataStoresResponse) GetDataStores
func (x *ListDataStoresResponse) GetDataStores() []*DataStore
func (*ListDataStoresResponse) GetNextPageToken
func (x *ListDataStoresResponse) GetNextPageToken() string
func (*ListDataStoresResponse) ProtoMessage
func (*ListDataStoresResponse) ProtoMessage()
func (*ListDataStoresResponse) ProtoReflect
func (x *ListDataStoresResponse) ProtoReflect() protoreflect.Message
func (*ListDataStoresResponse) Reset
func (x *ListDataStoresResponse) Reset()
func (*ListDataStoresResponse) String
func (x *ListDataStoresResponse) String() string
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 will be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
// received from a previous
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
func (*ListDocumentsRequest) Descriptor
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
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
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
ListEnginesRequest
type ListEnginesRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Not supported.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. Not supported.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter by solution type. For example:
// solution_type=SOLUTION_TYPE_SEARCH
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] method.
func (*ListEnginesRequest) Descriptor
func (*ListEnginesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.
func (*ListEnginesRequest) GetFilter
func (x *ListEnginesRequest) GetFilter() string
func (*ListEnginesRequest) GetPageSize
func (x *ListEnginesRequest) GetPageSize() int32
func (*ListEnginesRequest) GetPageToken
func (x *ListEnginesRequest) GetPageToken() string
func (*ListEnginesRequest) GetParent
func (x *ListEnginesRequest) GetParent() string
func (*ListEnginesRequest) ProtoMessage
func (*ListEnginesRequest) ProtoMessage()
func (*ListEnginesRequest) ProtoReflect
func (x *ListEnginesRequest) ProtoReflect() protoreflect.Message
func (*ListEnginesRequest) Reset
func (x *ListEnginesRequest) Reset()
func (*ListEnginesRequest) String
func (x *ListEnginesRequest) String() string
ListEnginesResponse
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
func (*ListEnginesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.
func (*ListEnginesResponse) GetEngines
func (x *ListEnginesResponse) GetEngines() []*Engine
func (*ListEnginesResponse) GetNextPageToken
func (x *ListEnginesResponse) GetNextPageToken() string
func (*ListEnginesResponse) ProtoMessage
func (*ListEnginesResponse) ProtoMessage()
func (*ListEnginesResponse) ProtoReflect
func (x *ListEnginesResponse) ProtoReflect() protoreflect.Message
func (*ListEnginesResponse) Reset
func (x *ListEnginesResponse) Reset()
func (*ListEnginesResponse) String
func (x *ListEnginesResponse) String() string
ListSchemasRequest
type ListSchemasRequest struct {
// Required. The parent data store resource name, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of [Schema][google.cloud.discoveryengine.v1beta.Schema]s
// to return. The service may return fewer than this value.
//
// If unspecified, at most 100
// [Schema][google.cloud.discoveryengine.v1beta.Schema]s will be returned.
//
// The maximum value is 1000; values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous
// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
func (*ListSchemasRequest) Descriptor
func (*ListSchemasRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.
func (*ListSchemasRequest) GetPageSize
func (x *ListSchemasRequest) GetPageSize() int32
func (*ListSchemasRequest) GetPageToken
func (x *ListSchemasRequest) GetPageToken() string
func (*ListSchemasRequest) GetParent
func (x *ListSchemasRequest) GetParent() string
func (*ListSchemasRequest) ProtoMessage
func (*ListSchemasRequest) ProtoMessage()
func (*ListSchemasRequest) ProtoReflect
func (x *ListSchemasRequest) ProtoReflect() protoreflect.Message
func (*ListSchemasRequest) Reset
func (x *ListSchemasRequest) Reset()
func (*ListSchemasRequest) String
func (x *ListSchemasRequest) String() string
ListSchemasResponse
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
func (*ListSchemasResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.
func (*ListSchemasResponse) GetNextPageToken
func (x *ListSchemasResponse) GetNextPageToken() string
func (*ListSchemasResponse) GetSchemas
func (x *ListSchemasResponse) GetSchemas() []*Schema
func (*ListSchemasResponse) ProtoMessage
func (*ListSchemasResponse) ProtoMessage()
func (*ListSchemasResponse) ProtoReflect
func (x *ListSchemasResponse) ProtoReflect() protoreflect.Message
func (*ListSchemasResponse) Reset
func (x *ListSchemasResponse) Reset()
func (*ListSchemasResponse) String
func (x *ListSchemasResponse) String() string
ListServingConfigsRequest
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
func (*ListServingConfigsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListServingConfigsRequest.ProtoReflect.Descriptor instead.
func (*ListServingConfigsRequest) GetPageSize
func (x *ListServingConfigsRequest) GetPageSize() int32
func (*ListServingConfigsRequest) GetPageToken
func (x *ListServingConfigsRequest) GetPageToken() string
func (*ListServingConfigsRequest) GetParent
func (x *ListServingConfigsRequest) GetParent() string
func (*ListServingConfigsRequest) ProtoMessage
func (*ListServingConfigsRequest) ProtoMessage()
func (*ListServingConfigsRequest) ProtoReflect
func (x *ListServingConfigsRequest) ProtoReflect() protoreflect.Message
func (*ListServingConfigsRequest) Reset
func (x *ListServingConfigsRequest) Reset()
func (*ListServingConfigsRequest) String
func (x *ListServingConfigsRequest) String() string
ListServingConfigsResponse
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
func (*ListServingConfigsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListServingConfigsResponse.ProtoReflect.Descriptor instead.
func (*ListServingConfigsResponse) GetNextPageToken
func (x *ListServingConfigsResponse) GetNextPageToken() string
func (*ListServingConfigsResponse) GetServingConfigs
func (x *ListServingConfigsResponse) GetServingConfigs() []*ServingConfig
func (*ListServingConfigsResponse) ProtoMessage
func (*ListServingConfigsResponse) ProtoMessage()
func (*ListServingConfigsResponse) ProtoReflect
func (x *ListServingConfigsResponse) ProtoReflect() protoreflect.Message
func (*ListServingConfigsResponse) Reset
func (x *ListServingConfigsResponse) Reset()
func (*ListServingConfigsResponse) String
func (x *ListServingConfigsResponse) String() string
ListSessionsRequest
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
func (*ListSessionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSessionsRequest.ProtoReflect.Descriptor instead.
func (*ListSessionsRequest) GetFilter
func (x *ListSessionsRequest) GetFilter() string
func (*ListSessionsRequest) GetOrderBy
func (x *ListSessionsRequest) GetOrderBy() string
func (*ListSessionsRequest) GetPageSize
func (x *ListSessionsRequest) GetPageSize() int32
func (*ListSessionsRequest) GetPageToken
func (x *ListSessionsRequest) GetPageToken() string
func (*ListSessionsRequest) GetParent
func (x *ListSessionsRequest) GetParent() string
func (*ListSessionsRequest) ProtoMessage
func (*ListSessionsRequest) ProtoMessage()
func (*ListSessionsRequest) ProtoReflect
func (x *ListSessionsRequest) ProtoReflect() protoreflect.Message
func (*ListSessionsRequest) Reset
func (x *ListSessionsRequest) Reset()
func (*ListSessionsRequest) String
func (x *ListSessionsRequest) String() string
ListSessionsResponse
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
func (*ListSessionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSessionsResponse.ProtoReflect.Descriptor instead.
func (*ListSessionsResponse) GetNextPageToken
func (x *ListSessionsResponse) GetNextPageToken() string
func (*ListSessionsResponse) GetSessions
func (x *ListSessionsResponse) GetSessions() []*Session
func (*ListSessionsResponse) ProtoMessage
func (*ListSessionsResponse) ProtoMessage()
func (*ListSessionsResponse) ProtoReflect
func (x *ListSessionsResponse) ProtoReflect() protoreflect.Message
func (*ListSessionsResponse) Reset
func (x *ListSessionsResponse) Reset()
func (*ListSessionsResponse) String
func (x *ListSessionsResponse) String() string
ListTargetSitesRequest
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
func (*ListTargetSitesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*ListTargetSitesRequest) GetPageSize
func (x *ListTargetSitesRequest) GetPageSize() int32
func (*ListTargetSitesRequest) GetPageToken
func (x *ListTargetSitesRequest) GetPageToken() string
func (*ListTargetSitesRequest) GetParent
func (x *ListTargetSitesRequest) GetParent() string
func (*ListTargetSitesRequest) ProtoMessage
func (*ListTargetSitesRequest) ProtoMessage()
func (*ListTargetSitesRequest) ProtoReflect
func (x *ListTargetSitesRequest) ProtoReflect() protoreflect.Message
func (*ListTargetSitesRequest) Reset
func (x *ListTargetSitesRequest) Reset()
func (*ListTargetSitesRequest) String
func (x *ListTargetSitesRequest) String() string
ListTargetSitesResponse
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
func (*ListTargetSitesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*ListTargetSitesResponse) GetNextPageToken
func (x *ListTargetSitesResponse) GetNextPageToken() string
func (*ListTargetSitesResponse) GetTargetSites
func (x *ListTargetSitesResponse) GetTargetSites() []*TargetSite
func (*ListTargetSitesResponse) GetTotalSize
func (x *ListTargetSitesResponse) GetTotalSize() int32
func (*ListTargetSitesResponse) ProtoMessage
func (*ListTargetSitesResponse) ProtoMessage()
func (*ListTargetSitesResponse) ProtoReflect
func (x *ListTargetSitesResponse) ProtoReflect() protoreflect.Message
func (*ListTargetSitesResponse) Reset
func (x *ListTargetSitesResponse) Reset()
func (*ListTargetSitesResponse) String
func (x *ListTargetSitesResponse) String() string
MediaInfo
type MediaInfo struct {
MediaProgressDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=media_progress_duration,json=mediaProgressDuration,proto3" json:"media_progress_duration,omitempty"`
MediaProgressPercentage *float32 "" /* 140 byte string literal not displayed */
}
Media-specific user event information.
func (*MediaInfo) Descriptor
Deprecated: Use MediaInfo.ProtoReflect.Descriptor instead.
func (*MediaInfo) GetMediaProgressDuration
func (x *MediaInfo) GetMediaProgressDuration() *durationpb.Duration
func (*MediaInfo) GetMediaProgressPercentage
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
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: Use PageInfo.ProtoReflect.Descriptor instead.
func (*PageInfo) GetPageCategory
func (*PageInfo) GetPageviewId
func (*PageInfo) GetReferrerUri
func (*PageInfo) GetUri
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
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: Use PanelInfo.ProtoReflect.Descriptor instead.
func (*PanelInfo) GetDisplayName
func (*PanelInfo) GetPanelId
func (*PanelInfo) GetPanelPosition
func (*PanelInfo) GetTotalPanels
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
PauseEngineRequest
type PauseEngineRequest struct {
// Required. The name of the engine to pause.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for pausing training of an engine.
func (*PauseEngineRequest) Descriptor
func (*PauseEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use PauseEngineRequest.ProtoReflect.Descriptor instead.
func (*PauseEngineRequest) GetName
func (x *PauseEngineRequest) GetName() string
func (*PauseEngineRequest) ProtoMessage
func (*PauseEngineRequest) ProtoMessage()
func (*PauseEngineRequest) ProtoReflect
func (x *PauseEngineRequest) ProtoReflect() protoreflect.Message
func (*PauseEngineRequest) Reset
func (x *PauseEngineRequest) Reset()
func (*PauseEngineRequest) String
func (x *PauseEngineRequest) String() string
PurgeDocumentsMetadata
type PurgeDocumentsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of entries that were deleted successfully.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of entries that encountered errors while processing.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// Count of entries that were ignored as entries were not found.
IgnoredCount int64 `protobuf:"varint,5,opt,name=ignored_count,json=ignoredCount,proto3" json:"ignored_count,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*PurgeDocumentsMetadata) Descriptor
func (*PurgeDocumentsMetadata) Descriptor() ([]byte, []int)
Deprecated: Use PurgeDocumentsMetadata.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsMetadata) GetCreateTime
func (x *PurgeDocumentsMetadata) GetCreateTime() *timestamppb.Timestamp
func (*PurgeDocumentsMetadata) GetFailureCount
func (x *PurgeDocumentsMetadata) GetFailureCount() int64
func (*PurgeDocumentsMetadata) GetIgnoredCount
func (x *PurgeDocumentsMetadata) GetIgnoredCount() int64
func (*PurgeDocumentsMetadata) GetSuccessCount
func (x *PurgeDocumentsMetadata) GetSuccessCount() int64
func (*PurgeDocumentsMetadata) GetUpdateTime
func (x *PurgeDocumentsMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*PurgeDocumentsMetadata) ProtoMessage
func (*PurgeDocumentsMetadata) ProtoMessage()
func (*PurgeDocumentsMetadata) ProtoReflect
func (x *PurgeDocumentsMetadata) ProtoReflect() protoreflect.Message
func (*PurgeDocumentsMetadata) Reset
func (x *PurgeDocumentsMetadata) Reset()
func (*PurgeDocumentsMetadata) String
func (x *PurgeDocumentsMetadata) String() string
PurgeDocumentsRequest
type PurgeDocumentsRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Filter matching documents to purge. Only currently supported
// value is
// `*` (all items).
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Actually performs the purge. If `force` is set to false, return the
// expected purge count without deleting any documents.
Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
func (*PurgeDocumentsRequest) Descriptor
func (*PurgeDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsRequest) GetFilter
func (x *PurgeDocumentsRequest) GetFilter() string
func (*PurgeDocumentsRequest) GetForce
func (x *PurgeDocumentsRequest) GetForce() bool
func (*PurgeDocumentsRequest) GetParent
func (x *PurgeDocumentsRequest) GetParent() string
func (*PurgeDocumentsRequest) ProtoMessage
func (*PurgeDocumentsRequest) ProtoMessage()
func (*PurgeDocumentsRequest) ProtoReflect
func (x *PurgeDocumentsRequest) ProtoReflect() protoreflect.Message
func (*PurgeDocumentsRequest) Reset
func (x *PurgeDocumentsRequest) Reset()
func (*PurgeDocumentsRequest) String
func (x *PurgeDocumentsRequest) String() string
PurgeDocumentsResponse
type PurgeDocumentsResponse struct {
// The total count of documents purged as a result of the operation.
PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
// A sample of document names that will be deleted. Only populated if `force`
// is set to false. A max of 100 names will be returned and the names are
// chosen at random.
PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
// contains filtered or unexported fields
}
Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.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
func (*PurgeDocumentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use PurgeDocumentsResponse.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsResponse) GetPurgeCount
func (x *PurgeDocumentsResponse) GetPurgeCount() int64
func (*PurgeDocumentsResponse) GetPurgeSample
func (x *PurgeDocumentsResponse) GetPurgeSample() []string
func (*PurgeDocumentsResponse) ProtoMessage
func (*PurgeDocumentsResponse) ProtoMessage()
func (*PurgeDocumentsResponse) ProtoReflect
func (x *PurgeDocumentsResponse) ProtoReflect() protoreflect.Message
func (*PurgeDocumentsResponse) Reset
func (x *PurgeDocumentsResponse) Reset()
func (*PurgeDocumentsResponse) String
func (x *PurgeDocumentsResponse) String() string
PurgeSuggestionDenyListEntriesMetadata
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
func (*PurgeSuggestionDenyListEntriesMetadata) Descriptor() ([]byte, []int)
Deprecated: Use PurgeSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesMetadata) GetCreateTime
func (x *PurgeSuggestionDenyListEntriesMetadata) GetCreateTime() *timestamppb.Timestamp
func (*PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime
func (x *PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage
func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage()
func (*PurgeSuggestionDenyListEntriesMetadata) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesMetadata) ProtoReflect() protoreflect.Message
func (*PurgeSuggestionDenyListEntriesMetadata) Reset
func (x *PurgeSuggestionDenyListEntriesMetadata) Reset()
func (*PurgeSuggestionDenyListEntriesMetadata) String
func (x *PurgeSuggestionDenyListEntriesMetadata) String() string
PurgeSuggestionDenyListEntriesRequest
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
func (*PurgeSuggestionDenyListEntriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use PurgeSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesRequest) GetParent
func (x *PurgeSuggestionDenyListEntriesRequest) GetParent() string
func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage
func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage()
func (*PurgeSuggestionDenyListEntriesRequest) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesRequest) ProtoReflect() protoreflect.Message
func (*PurgeSuggestionDenyListEntriesRequest) Reset
func (x *PurgeSuggestionDenyListEntriesRequest) Reset()
func (*PurgeSuggestionDenyListEntriesRequest) String
func (x *PurgeSuggestionDenyListEntriesRequest) String() string
PurgeSuggestionDenyListEntriesResponse
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
func (*PurgeSuggestionDenyListEntriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use PurgeSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesResponse) GetErrorSamples
func (x *PurgeSuggestionDenyListEntriesResponse) GetErrorSamples() []*status.Status
func (*PurgeSuggestionDenyListEntriesResponse) GetPurgeCount
func (x *PurgeSuggestionDenyListEntriesResponse) GetPurgeCount() int64
func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage
func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage()
func (*PurgeSuggestionDenyListEntriesResponse) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesResponse) ProtoReflect() protoreflect.Message
func (*PurgeSuggestionDenyListEntriesResponse) Reset
func (x *PurgeSuggestionDenyListEntriesResponse) Reset()
func (*PurgeSuggestionDenyListEntriesResponse) String
func (x *PurgeSuggestionDenyListEntriesResponse) String() string
Query
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: Use Query.ProtoReflect.Descriptor instead.
func (*Query) GetContent
func (m *Query) GetContent() isQuery_Content
func (*Query) GetQueryId
func (*Query) GetText
func (*Query) ProtoMessage
func (*Query) ProtoMessage()
func (*Query) ProtoReflect
func (x *Query) ProtoReflect() protoreflect.Message
func (*Query) Reset
func (x *Query) Reset()
func (*Query) String
Query_Text
type Query_Text struct {
// Plain text.
Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}
RankRequest
type RankRequest struct {
RankingConfig string `protobuf:"bytes,1,opt,name=ranking_config,json=rankingConfig,proto3" json:"ranking_config,omitempty"`
Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
TopN int32 `protobuf:"varint,3,opt,name=top_n,json=topN,proto3" json:"top_n,omitempty"`
Query string `protobuf:"bytes,4,opt,name=query,proto3" json:"query,omitempty"`
Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
IgnoreRecordDetailsInResponse bool "" /* 155 byte string literal not displayed */
}
Request message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.
func (*RankRequest) Descriptor
func (*RankRequest) Descriptor() ([]byte, []int)
Deprecated: Use RankRequest.ProtoReflect.Descriptor instead.
func (*RankRequest) GetIgnoreRecordDetailsInResponse
func (x *RankRequest) GetIgnoreRecordDetailsInResponse() bool
func (*RankRequest) GetModel
func (x *RankRequest) GetModel() string
func (*RankRequest) GetQuery
func (x *RankRequest) GetQuery() string
func (*RankRequest) GetRankingConfig
func (x *RankRequest) GetRankingConfig() string
func (*RankRequest) GetRecords
func (x *RankRequest) GetRecords() []*RankingRecord
func (*RankRequest) GetTopN
func (x *RankRequest) GetTopN() int32
func (*RankRequest) ProtoMessage
func (*RankRequest) ProtoMessage()
func (*RankRequest) ProtoReflect
func (x *RankRequest) ProtoReflect() protoreflect.Message
func (*RankRequest) Reset
func (x *RankRequest) Reset()
func (*RankRequest) String
func (x *RankRequest) String() string
RankResponse
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
func (*RankResponse) Descriptor() ([]byte, []int)
Deprecated: Use RankResponse.ProtoReflect.Descriptor instead.
func (*RankResponse) GetRecords
func (x *RankResponse) GetRecords() []*RankingRecord
func (*RankResponse) ProtoMessage
func (*RankResponse) ProtoMessage()
func (*RankResponse) ProtoReflect
func (x *RankResponse) ProtoReflect() protoreflect.Message
func (*RankResponse) Reset
func (x *RankResponse) Reset()
func (*RankResponse) String
func (x *RankResponse) String() string
RankServiceClient
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
func NewRankServiceClient(cc grpc.ClientConnInterface) RankServiceClient
RankServiceServer
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.
RankingRecord
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
func (*RankingRecord) Descriptor() ([]byte, []int)
Deprecated: Use RankingRecord.ProtoReflect.Descriptor instead.
func (*RankingRecord) GetContent
func (x *RankingRecord) GetContent() string
func (*RankingRecord) GetId
func (x *RankingRecord) GetId() string
func (*RankingRecord) GetScore
func (x *RankingRecord) GetScore() float32
func (*RankingRecord) GetTitle
func (x *RankingRecord) GetTitle() string
func (*RankingRecord) ProtoMessage
func (*RankingRecord) ProtoMessage()
func (*RankingRecord) ProtoReflect
func (x *RankingRecord) ProtoReflect() protoreflect.Message
func (*RankingRecord) Reset
func (x *RankingRecord) Reset()
func (*RankingRecord) String
func (x *RankingRecord) String() string
RecommendRequest
type RecommendRequest struct {
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
Params map[string]*structpb.Value "" /* 153 byte string literal not displayed */
UserLabels map[string]string "" /* 179 byte string literal not displayed */
}
Request message for Recommend method.
func (*RecommendRequest) Descriptor
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
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
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
RecommendResponse_RecommendationResult
type RecommendResponse_RecommendationResult struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
Metadata map[string]*structpb.Value "" /* 157 byte string literal not displayed */
}
RecommendationResult represents a generic recommendation result with associated metadata.
func (*RecommendResponse_RecommendationResult) Descriptor
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
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
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.
RecrawlUrisMetadata
type RecrawlUrisMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Unique URIs in the request that don't match any TargetSite in the
// DataStore, only match TargetSites that haven't been fully indexed, or match
// a TargetSite with type EXCLUDE.
InvalidUris []string `protobuf:"bytes,3,rep,name=invalid_uris,json=invalidUris,proto3" json:"invalid_uris,omitempty"`
// Total number of unique URIs in the request that are not in invalid_uris.
ValidUrisCount int32 `protobuf:"varint,4,opt,name=valid_uris_count,json=validUrisCount,proto3" json:"valid_uris_count,omitempty"`
// Total number of URIs that have been crawled so far.
SuccessCount int32 `protobuf:"varint,5,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Total number of URIs that have yet to be crawled.
PendingCount int32 `protobuf:"varint,6,opt,name=pending_count,json=pendingCount,proto3" json:"pending_count,omitempty"`
// Total number of URIs that were rejected due to insufficient indexing
// resources.
QuotaExceededCount int32 `protobuf:"varint,7,opt,name=quota_exceeded_count,json=quotaExceededCount,proto3" json:"quota_exceeded_count,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*RecrawlUrisMetadata) Descriptor
func (*RecrawlUrisMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisMetadata.ProtoReflect.Descriptor instead.
func (*RecrawlUrisMetadata) GetCreateTime
func (x *RecrawlUrisMetadata) GetCreateTime() *timestamppb.Timestamp
func (*RecrawlUrisMetadata) GetInvalidUris
func (x *RecrawlUrisMetadata) GetInvalidUris() []string
func (*RecrawlUrisMetadata) GetPendingCount
func (x *RecrawlUrisMetadata) GetPendingCount() int32
func (*RecrawlUrisMetadata) GetQuotaExceededCount
func (x *RecrawlUrisMetadata) GetQuotaExceededCount() int32
func (*RecrawlUrisMetadata) GetSuccessCount
func (x *RecrawlUrisMetadata) GetSuccessCount() int32
func (*RecrawlUrisMetadata) GetUpdateTime
func (x *RecrawlUrisMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*RecrawlUrisMetadata) GetValidUrisCount
func (x *RecrawlUrisMetadata) GetValidUrisCount() int32
func (*RecrawlUrisMetadata) ProtoMessage
func (*RecrawlUrisMetadata) ProtoMessage()
func (*RecrawlUrisMetadata) ProtoReflect
func (x *RecrawlUrisMetadata) ProtoReflect() protoreflect.Message
func (*RecrawlUrisMetadata) Reset
func (x *RecrawlUrisMetadata) Reset()
func (*RecrawlUrisMetadata) String
func (x *RecrawlUrisMetadata) String() string
RecrawlUrisRequest
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
func (*RecrawlUrisRequest) Descriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisRequest.ProtoReflect.Descriptor instead.
func (*RecrawlUrisRequest) GetSiteSearchEngine
func (x *RecrawlUrisRequest) GetSiteSearchEngine() string
func (*RecrawlUrisRequest) GetUris
func (x *RecrawlUrisRequest) GetUris() []string
func (*RecrawlUrisRequest) ProtoMessage
func (*RecrawlUrisRequest) ProtoMessage()
func (*RecrawlUrisRequest) ProtoReflect
func (x *RecrawlUrisRequest) ProtoReflect() protoreflect.Message
func (*RecrawlUrisRequest) Reset
func (x *RecrawlUrisRequest) Reset()
func (*RecrawlUrisRequest) String
func (x *RecrawlUrisRequest) String() string
RecrawlUrisResponse
type RecrawlUrisResponse struct {
// Details for a sample of up to 10 `failed_uris`.
FailureSamples []*RecrawlUrisResponse_FailureInfo `protobuf:"bytes,1,rep,name=failure_samples,json=failureSamples,proto3" json:"failure_samples,omitempty"`
// URIs that were not crawled before the LRO terminated.
FailedUris []string `protobuf:"bytes,2,rep,name=failed_uris,json=failedUris,proto3" json:"failed_uris,omitempty"`
// contains filtered or unexported fields
}
Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] method.
func (*RecrawlUrisResponse) Descriptor
func (*RecrawlUrisResponse) Descriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisResponse.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse) GetFailedUris
func (x *RecrawlUrisResponse) GetFailedUris() []string
func (*RecrawlUrisResponse) GetFailureSamples
func (x *RecrawlUrisResponse) GetFailureSamples() []*RecrawlUrisResponse_FailureInfo
func (*RecrawlUrisResponse) ProtoMessage
func (*RecrawlUrisResponse) ProtoMessage()
func (*RecrawlUrisResponse) ProtoReflect
func (x *RecrawlUrisResponse) ProtoReflect() protoreflect.Message
func (*RecrawlUrisResponse) Reset
func (x *RecrawlUrisResponse) Reset()
func (*RecrawlUrisResponse) String
func (x *RecrawlUrisResponse) String() string
RecrawlUrisResponse_FailureInfo
type RecrawlUrisResponse_FailureInfo struct {
// URI that failed to be crawled.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// List of failure reasons by corpus type (e.g. desktop, mobile).
FailureReasons []*RecrawlUrisResponse_FailureInfo_FailureReason `protobuf:"bytes,2,rep,name=failure_reasons,json=failureReasons,proto3" json:"failure_reasons,omitempty"`
// contains filtered or unexported fields
}
Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
func (*RecrawlUrisResponse_FailureInfo) Descriptor
func (*RecrawlUrisResponse_FailureInfo) Descriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisResponse_FailureInfo.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse_FailureInfo) GetFailureReasons
func (x *RecrawlUrisResponse_FailureInfo) GetFailureReasons() []*RecrawlUrisResponse_FailureInfo_FailureReason
func (*RecrawlUrisResponse_FailureInfo) GetUri
func (x *RecrawlUrisResponse_FailureInfo) GetUri() string
func (*RecrawlUrisResponse_FailureInfo) ProtoMessage
func (*RecrawlUrisResponse_FailureInfo) ProtoMessage()
func (*RecrawlUrisResponse_FailureInfo) ProtoReflect
func (x *RecrawlUrisResponse_FailureInfo) ProtoReflect() protoreflect.Message
func (*RecrawlUrisResponse_FailureInfo) Reset
func (x *RecrawlUrisResponse_FailureInfo) Reset()
func (*RecrawlUrisResponse_FailureInfo) String
func (x *RecrawlUrisResponse_FailureInfo) String() string
RecrawlUrisResponse_FailureInfo_FailureReason
type RecrawlUrisResponse_FailureInfo_FailureReason struct {
CorpusType RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType "" /* 190 byte string literal not displayed */
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
}
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
func (*RecrawlUrisResponse_FailureInfo_FailureReason) Descriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType() RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType
func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage() string
func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage
func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage()
func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect() protoreflect.Message
func (*RecrawlUrisResponse_FailureInfo_FailureReason) Reset
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) Reset()
func (*RecrawlUrisResponse_FailureInfo_FailureReason) String
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) String() string
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType
type RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType int32
CorpusType for the failed crawling operation.
RecrawlUrisResponse_FailureInfo_FailureReason_CORPUS_TYPE_UNSPECIFIED, RecrawlUrisResponse_FailureInfo_FailureReason_DESKTOP, RecrawlUrisResponse_FailureInfo_FailureReason_MOBILE
const (
// Default value.
RecrawlUrisResponse_FailureInfo_FailureReason_CORPUS_TYPE_UNSPECIFIED RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 0
// Denotes a crawling attempt for the desktop version of a page.
RecrawlUrisResponse_FailureInfo_FailureReason_DESKTOP RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 1
// Denotes a crawling attempt for the mobile version of a page.
RecrawlUrisResponse_FailureInfo_FailureReason_MOBILE RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 2
)
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor() protoreflect.EnumDescriptor
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum() *RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.Descriptor instead.
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number() protoreflect.EnumNumber
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String() string
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type
Reply
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: Use Reply.ProtoReflect.Descriptor instead.
func (*Reply) GetReferences
func (x *Reply) GetReferences() []*Reply_Reference
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversation.proto.
func (*Reply) GetReply
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversation.proto.
func (*Reply) GetSummary
func (x *Reply) GetSummary() *SearchResponse_Summary
func (*Reply) ProtoMessage
func (*Reply) ProtoMessage()
func (*Reply) ProtoReflect
func (x *Reply) ProtoReflect() protoreflect.Message
func (*Reply) Reset
func (x *Reply) Reset()
func (*Reply) String
Reply_Reference (deprecated)
type Reply_Reference struct {
// URI link reference.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Anchor text.
AnchorText string `protobuf:"bytes,2,opt,name=anchor_text,json=anchorText,proto3" json:"anchor_text,omitempty"`
// Anchor text start index.
Start int32 `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`
// Anchor text end index.
End int32 `protobuf:"varint,4,opt,name=end,proto3" json:"end,omitempty"`
// contains filtered or unexported fields
}
Defines reference in reply.
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversation.proto.
func (*Reply_Reference) Descriptor (deprecated)
func (*Reply_Reference) Descriptor() ([]byte, []int)
Deprecated: Use Reply_Reference.ProtoReflect.Descriptor instead.
func (*Reply_Reference) GetAnchorText (deprecated)
func (x *Reply_Reference) GetAnchorText() string
func (*Reply_Reference) GetEnd (deprecated)
func (x *Reply_Reference) GetEnd() int32
func (*Reply_Reference) GetStart (deprecated)
func (x *Reply_Reference) GetStart() int32
func (*Reply_Reference) GetUri (deprecated)
func (x *Reply_Reference) GetUri() string
func (*Reply_Reference) ProtoMessage (deprecated)
func (*Reply_Reference) ProtoMessage()
func (*Reply_Reference) ProtoReflect (deprecated)
func (x *Reply_Reference) ProtoReflect() protoreflect.Message
func (*Reply_Reference) Reset (deprecated)
func (x *Reply_Reference) Reset()
func (*Reply_Reference) String (deprecated)
func (x *Reply_Reference) String() string
ResumeEngineRequest
type ResumeEngineRequest struct {
// Required. The name of the engine to resume.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for resuming training of an engine.
func (*ResumeEngineRequest) Descriptor
func (*ResumeEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use ResumeEngineRequest.ProtoReflect.Descriptor instead.
func (*ResumeEngineRequest) GetName
func (x *ResumeEngineRequest) GetName() string
func (*ResumeEngineRequest) ProtoMessage
func (*ResumeEngineRequest) ProtoMessage()
func (*ResumeEngineRequest) ProtoReflect
func (x *ResumeEngineRequest) ProtoReflect() protoreflect.Message
func (*ResumeEngineRequest) Reset
func (x *ResumeEngineRequest) Reset()
func (*ResumeEngineRequest) String
func (x *ResumeEngineRequest) String() string
Schema
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: Use Schema.ProtoReflect.Descriptor instead.
func (*Schema) GetJsonSchema
func (*Schema) GetName
func (*Schema) GetSchema
func (m *Schema) GetSchema() isSchema_Schema
func (*Schema) GetStructSchema
func (*Schema) ProtoMessage
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect
func (x *Schema) ProtoReflect() protoreflect.Message
func (*Schema) Reset
func (x *Schema) Reset()
func (*Schema) String
SchemaServiceClient
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
func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient
SchemaServiceServer
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.
Schema_JsonSchema
type Schema_JsonSchema struct {
// The JSON representation of the schema.
JsonSchema string `protobuf:"bytes,3,opt,name=json_schema,json=jsonSchema,proto3,oneof"`
}
Schema_StructSchema
type Schema_StructSchema struct {
// The structured representation of the schema.
StructSchema *structpb.Struct `protobuf:"bytes,2,opt,name=struct_schema,json=structSchema,proto3,oneof"`
}
SearchAddOn
type SearchAddOn int32
Add-on that provides additional functionality for search.
SearchAddOn_SEARCH_ADD_ON_UNSPECIFIED, SearchAddOn_SEARCH_ADD_ON_LLM
const (
// Default value when the enum is unspecified. This is invalid to use.
SearchAddOn_SEARCH_ADD_ON_UNSPECIFIED SearchAddOn = 0
// Large language model add-on.
SearchAddOn_SEARCH_ADD_ON_LLM SearchAddOn = 1
)
func (SearchAddOn) Descriptor
func (SearchAddOn) Descriptor() protoreflect.EnumDescriptor
func (SearchAddOn) Enum
func (x SearchAddOn) Enum() *SearchAddOn
func (SearchAddOn) EnumDescriptor
func (SearchAddOn) EnumDescriptor() ([]byte, []int)
Deprecated: Use SearchAddOn.Descriptor instead.
func (SearchAddOn) Number
func (x SearchAddOn) Number() protoreflect.EnumNumber
func (SearchAddOn) String
func (x SearchAddOn) String() string
func (SearchAddOn) Type
func (SearchAddOn) Type() protoreflect.EnumType
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
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
SearchRequest
type SearchRequest struct {
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
ImageQuery *SearchRequest_ImageQuery `protobuf:"bytes,19,opt,name=image_query,json=imageQuery,proto3" json:"image_query,omitempty"`
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,32,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
Filter string `protobuf:"bytes,7,opt,name=filter,proto3" json:"filter,omitempty"`
CanonicalFilter string `protobuf:"bytes,29,opt,name=canonical_filter,json=canonicalFilter,proto3" json:"canonical_filter,omitempty"`
OrderBy string `protobuf:"bytes,8,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
UserInfo *UserInfo `protobuf:"bytes,21,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
FacetSpecs []*SearchRequest_FacetSpec `protobuf:"bytes,9,rep,name=facet_specs,json=facetSpecs,proto3" json:"facet_specs,omitempty"`
BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
Params map[string]*structpb.Value "" /* 154 byte string literal not displayed */
QueryExpansionSpec *SearchRequest_QueryExpansionSpec `protobuf:"bytes,13,opt,name=query_expansion_spec,json=queryExpansionSpec,proto3" json:"query_expansion_spec,omitempty"`
SpellCorrectionSpec *SearchRequest_SpellCorrectionSpec `protobuf:"bytes,14,opt,name=spell_correction_spec,json=spellCorrectionSpec,proto3" json:"spell_correction_spec,omitempty"`
UserPseudoId string `protobuf:"bytes,15,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,24,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
EmbeddingSpec *SearchRequest_EmbeddingSpec `protobuf:"bytes,23,opt,name=embedding_spec,json=embeddingSpec,proto3" json:"embedding_spec,omitempty"`
RankingExpression string `protobuf:"bytes,26,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
SafeSearch bool `protobuf:"varint,20,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
UserLabels map[string]string "" /* 180 byte string literal not displayed */
}
Request message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
func (*SearchRequest) Descriptor
func (*SearchRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.
func (*SearchRequest) GetBoostSpec
func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpec
func (*SearchRequest) GetBranch
func (x *SearchRequest) GetBranch() string
func (*SearchRequest) GetCanonicalFilter
func (x *SearchRequest) GetCanonicalFilter() string
func (*SearchRequest) GetContentSearchSpec
func (x *SearchRequest) GetContentSearchSpec() *SearchRequest_ContentSearchSpec
func (*SearchRequest) GetDataStoreSpecs
func (x *SearchRequest) GetDataStoreSpecs() []*SearchRequest_DataStoreSpec
func (*SearchRequest) GetEmbeddingSpec
func (x *SearchRequest) GetEmbeddingSpec() *SearchRequest_EmbeddingSpec
func (*SearchRequest) GetFacetSpecs
func (x *SearchRequest) GetFacetSpecs() []*SearchRequest_FacetSpec
func (*SearchRequest) GetFilter
func (x *SearchRequest) GetFilter() string
func (*SearchRequest) GetImageQuery
func (x *SearchRequest) GetImageQuery() *SearchRequest_ImageQuery
func (*SearchRequest) GetOffset
func (x *SearchRequest) GetOffset() int32
func (*SearchRequest) GetOrderBy
func (x *SearchRequest) GetOrderBy() string
func (*SearchRequest) GetPageSize
func (x *SearchRequest) GetPageSize() int32
func (*SearchRequest) GetPageToken
func (x *SearchRequest) GetPageToken() string
func (*SearchRequest) GetParams
func (x *SearchRequest) GetParams() map[string]*structpb.Value
func (*SearchRequest) GetQuery
func (x *SearchRequest) GetQuery() string
func (*SearchRequest) GetQueryExpansionSpec
func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpec
func (*SearchRequest) GetRankingExpression
func (x *SearchRequest) GetRankingExpression() string
func (*SearchRequest) GetSafeSearch
func (x *SearchRequest) GetSafeSearch() bool
func (*SearchRequest) GetServingConfig
func (x *SearchRequest) GetServingConfig() string
func (*SearchRequest) GetSpellCorrectionSpec
func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpec
func (*SearchRequest) GetUserInfo
func (x *SearchRequest) GetUserInfo() *UserInfo
func (*SearchRequest) GetUserLabels
func (x *SearchRequest) GetUserLabels() map[string]string
func (*SearchRequest) GetUserPseudoId
func (x *SearchRequest) GetUserPseudoId() string
func (*SearchRequest) ProtoMessage
func (*SearchRequest) ProtoMessage()
func (*SearchRequest) ProtoReflect
func (x *SearchRequest) ProtoReflect() protoreflect.Message
func (*SearchRequest) Reset
func (x *SearchRequest) Reset()
func (*SearchRequest) String
func (x *SearchRequest) String() string
SearchRequest_BoostSpec
type SearchRequest_BoostSpec struct {
// Condition boost specifications. If a document matches multiple conditions
// in the specifictions, boost scores from these specifications are all
// applied and combined in a non-linear way. Maximum number of
// specifications is 20.
ConditionBoostSpecs []*SearchRequest_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`
// contains filtered or unexported fields
}
Boost specification to boost certain documents.
func (*SearchRequest_BoostSpec) Descriptor
func (*SearchRequest_BoostSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec) GetConditionBoostSpecs
func (x *SearchRequest_BoostSpec) GetConditionBoostSpecs() []*SearchRequest_BoostSpec_ConditionBoostSpec
func (*SearchRequest_BoostSpec) ProtoMessage
func (*SearchRequest_BoostSpec) ProtoMessage()
func (*SearchRequest_BoostSpec) ProtoReflect
func (x *SearchRequest_BoostSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_BoostSpec) Reset
func (x *SearchRequest_BoostSpec) Reset()
func (*SearchRequest_BoostSpec) String
func (x *SearchRequest_BoostSpec) String() string
SearchRequest_BoostSpec_ConditionBoostSpec
type SearchRequest_BoostSpec_ConditionBoostSpec struct {
// An expression which specifies a boost condition. The syntax and
// supported fields are the same as a filter expression. See
// [SearchRequest.filter][google.cloud.discoveryengine.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
func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32
func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec
func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition() string
func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()
func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) Reset()
func (*SearchRequest_BoostSpec_ConditionBoostSpec) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) String() string
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec struct {
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
AttributeType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType "" /* 216 byte string literal not displayed */
InterpolationType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType "" /* 232 byte string literal not displayed */
ControlPoints []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
}
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
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints() []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName() string
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage()
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset()
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String() string
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType int32
The attribute(or function) for which the custom ranking is to be applied.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS
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]]`.
// E.g. `5D`, `3DT12H30M`, `T24H`.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 2
)
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor() protoreflect.EnumDescriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor
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
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number() protoreflect.EnumNumber
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type() protoreflect.EnumType
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint
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
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
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue() string
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount() float32
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage()
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect() protoreflect.Message
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset()
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String() string
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType int32
The interpolation type to be applied. Default will be linear (Piecewise Linear).
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_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
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor
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
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number() protoreflect.EnumNumber
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String() string
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type() protoreflect.EnumType
SearchRequest_ContentSearchSpec
type SearchRequest_ContentSearchSpec struct {
// If `snippetSpec` is not specified, snippets are not included in the
// search response.
SnippetSpec *SearchRequest_ContentSearchSpec_SnippetSpec `protobuf:"bytes,1,opt,name=snippet_spec,json=snippetSpec,proto3" json:"snippet_spec,omitempty"`
// If `summarySpec` is not specified, summaries are not included in the
// search response.
SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,2,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
// If there is no extractive_content_spec provided, there will be no
// extractive answer in the search response.
ExtractiveContentSpec *SearchRequest_ContentSearchSpec_ExtractiveContentSpec `protobuf:"bytes,3,opt,name=extractive_content_spec,json=extractiveContentSpec,proto3" json:"extractive_content_spec,omitempty"`
// contains filtered or unexported fields
}
A specification for configuring the behavior of content search.
func (*SearchRequest_ContentSearchSpec) Descriptor
func (*SearchRequest_ContentSearchSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec) GetExtractiveContentSpec
func (x *SearchRequest_ContentSearchSpec) GetExtractiveContentSpec() *SearchRequest_ContentSearchSpec_ExtractiveContentSpec
func (*SearchRequest_ContentSearchSpec) GetSnippetSpec
func (x *SearchRequest_ContentSearchSpec) GetSnippetSpec() *SearchRequest_ContentSearchSpec_SnippetSpec
func (*SearchRequest_ContentSearchSpec) GetSummarySpec
func (x *SearchRequest_ContentSearchSpec) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec
func (*SearchRequest_ContentSearchSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec) Reset
func (x *SearchRequest_ContentSearchSpec) Reset()
func (*SearchRequest_ContentSearchSpec) String
func (x *SearchRequest_ContentSearchSpec) String() string
SearchRequest_ContentSearchSpec_ExtractiveContentSpec
type SearchRequest_ContentSearchSpec_ExtractiveContentSpec struct {
MaxExtractiveAnswerCount int32 "" /* 138 byte string literal not displayed */
MaxExtractiveSegmentCount int32 "" /* 141 byte string literal not displayed */
ReturnExtractiveSegmentScore bool "" /* 150 byte string literal not displayed */
NumPreviousSegments int32 `protobuf:"varint,4,opt,name=num_previous_segments,json=numPreviousSegments,proto3" json:"num_previous_segments,omitempty"`
NumNextSegments int32 `protobuf:"varint,5,opt,name=num_next_segments,json=numNextSegments,proto3" json:"num_next_segments,omitempty"`
}
A specification for configuring the extractive content in a search response.
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec_ExtractiveContentSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount() int32
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount() int32
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments() int32
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments() int32
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore() bool
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset()
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String() string
SearchRequest_ContentSearchSpec_SnippetSpec
type SearchRequest_ContentSearchSpec_SnippetSpec struct {
// [DEPRECATED] This field is deprecated. To control snippet return, use
// `return_snippet` field. For backwards compatibility, we will return
// snippet if max_snippet_count > 0.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/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
func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec_SnippetSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount() int32
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/search_service.proto.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() bool
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/search_service.proto.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet() bool
func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) Reset()
func (*SearchRequest_ContentSearchSpec_SnippetSpec) String
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) String() string
SearchRequest_ContentSearchSpec_SummarySpec
type SearchRequest_ContentSearchSpec_SummarySpec struct {
SummaryResultCount int32 `protobuf:"varint,1,opt,name=summary_result_count,json=summaryResultCount,proto3" json:"summary_result_count,omitempty"`
IncludeCitations bool `protobuf:"varint,2,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
IgnoreAdversarialQuery bool "" /* 130 byte string literal not displayed */
IgnoreNonSummarySeekingQuery bool "" /* 152 byte string literal not displayed */
ModelPromptSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec `protobuf:"bytes,5,opt,name=model_prompt_spec,json=modelPromptSpec,proto3" json:"model_prompt_spec,omitempty"`
LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
ModelSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec `protobuf:"bytes,7,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
UseSemanticChunks bool `protobuf:"varint,8,opt,name=use_semantic_chunks,json=useSemanticChunks,proto3" json:"use_semantic_chunks,omitempty"`
}
A specification for configuring a summary returned in a search response.
func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor
func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery() bool
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery() bool
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations() bool
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode() string
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount() int32
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks() bool
func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec_SummarySpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec) Reset()
func (*SearchRequest_ContentSearchSpec_SummarySpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec) String() string
SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec
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
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble() string
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset()
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String() string
SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec
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
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion() string
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage()
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset()
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String() string
SearchRequest_DataStoreSpec
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.
func (*SearchRequest_DataStoreSpec) Descriptor
func (*SearchRequest_DataStoreSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_DataStoreSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_DataStoreSpec) GetDataStore
func (x *SearchRequest_DataStoreSpec) GetDataStore() string
func (*SearchRequest_DataStoreSpec) ProtoMessage
func (*SearchRequest_DataStoreSpec) ProtoMessage()
func (*SearchRequest_DataStoreSpec) ProtoReflect
func (x *SearchRequest_DataStoreSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_DataStoreSpec) Reset
func (x *SearchRequest_DataStoreSpec) Reset()
func (*SearchRequest_DataStoreSpec) String
func (x *SearchRequest_DataStoreSpec) String() string
SearchRequest_EmbeddingSpec
type SearchRequest_EmbeddingSpec struct {
// The embedding vector used for retrieval. Limit to 1.
EmbeddingVectors []*SearchRequest_EmbeddingSpec_EmbeddingVector `protobuf:"bytes,1,rep,name=embedding_vectors,json=embeddingVectors,proto3" json:"embedding_vectors,omitempty"`
// contains filtered or unexported fields
}
The specification that uses customized query embedding vector to do semantic document retrieval.
func (*SearchRequest_EmbeddingSpec) Descriptor
func (*SearchRequest_EmbeddingSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_EmbeddingSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_EmbeddingSpec) GetEmbeddingVectors
func (x *SearchRequest_EmbeddingSpec) GetEmbeddingVectors() []*SearchRequest_EmbeddingSpec_EmbeddingVector
func (*SearchRequest_EmbeddingSpec) ProtoMessage
func (*SearchRequest_EmbeddingSpec) ProtoMessage()
func (*SearchRequest_EmbeddingSpec) ProtoReflect
func (x *SearchRequest_EmbeddingSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_EmbeddingSpec) Reset
func (x *SearchRequest_EmbeddingSpec) Reset()
func (*SearchRequest_EmbeddingSpec) String
func (x *SearchRequest_EmbeddingSpec) String() string
SearchRequest_EmbeddingSpec_EmbeddingVector
type SearchRequest_EmbeddingSpec_EmbeddingVector struct {
// Embedding field path in schema.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// Query embedding vector.
Vector []float32 `protobuf:"fixed32,2,rep,packed,name=vector,proto3" json:"vector,omitempty"`
// contains filtered or unexported fields
}
Embedding vector.
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_EmbeddingSpec_EmbeddingVector.ProtoReflect.Descriptor instead.
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath() string
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector() []float32
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage()
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect() protoreflect.Message
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Reset
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) Reset()
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) String
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) String() string
SearchRequest_FacetSpec
type SearchRequest_FacetSpec struct {
FacetKey *SearchRequest_FacetSpec_FacetKey `protobuf:"bytes,1,opt,name=facet_key,json=facetKey,proto3" json:"facet_key,omitempty"`
Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
ExcludedFilterKeys []string `protobuf:"bytes,3,rep,name=excluded_filter_keys,json=excludedFilterKeys,proto3" json:"excluded_filter_keys,omitempty"`
EnableDynamicPosition bool "" /* 127 byte string literal not displayed */
}
A facet specification to perform faceted search.
func (*SearchRequest_FacetSpec) Descriptor
func (*SearchRequest_FacetSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_FacetSpec) GetEnableDynamicPosition
func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() bool
func (*SearchRequest_FacetSpec) GetExcludedFilterKeys
func (x *SearchRequest_FacetSpec) GetExcludedFilterKeys() []string
func (*SearchRequest_FacetSpec) GetFacetKey
func (x *SearchRequest_FacetSpec) GetFacetKey() *SearchRequest_FacetSpec_FacetKey
func (*SearchRequest_FacetSpec) GetLimit
func (x *SearchRequest_FacetSpec) GetLimit() int32
func (*SearchRequest_FacetSpec) ProtoMessage
func (*SearchRequest_FacetSpec) ProtoMessage()
func (*SearchRequest_FacetSpec) ProtoReflect
func (x *SearchRequest_FacetSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_FacetSpec) Reset
func (x *SearchRequest_FacetSpec) Reset()
func (*SearchRequest_FacetSpec) String
func (x *SearchRequest_FacetSpec) String() string
SearchRequest_FacetSpec_FacetKey
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 contains the given strings. For example,
// suppose "category" has three values "Action > 2022",
// "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
// Only supported on textual fields. Maximum is 10.
Contains []string `protobuf:"bytes,5,rep,name=contains,proto3" json:"contains,omitempty"`
// True to make facet keys case insensitive when getting faceting
// values with prefixes or contains; false otherwise.
CaseInsensitive bool `protobuf:"varint,6,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"`
// The order in which documents are returned.
//
// Allowed values are:
//
// * "count desc", which means order by
// [SearchResponse.Facet.values.count][google.cloud.discoveryengine.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
func (*SearchRequest_FacetSpec_FacetKey) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.
func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive
func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() bool
func (*SearchRequest_FacetSpec_FacetKey) GetContains
func (x *SearchRequest_FacetSpec_FacetKey) GetContains() []string
func (*SearchRequest_FacetSpec_FacetKey) GetIntervals
func (x *SearchRequest_FacetSpec_FacetKey) GetIntervals() []*Interval
func (*SearchRequest_FacetSpec_FacetKey) GetKey
func (x *SearchRequest_FacetSpec_FacetKey) GetKey() string
func (*SearchRequest_FacetSpec_FacetKey) GetOrderBy
func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string
func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes
func (x *SearchRequest_FacetSpec_FacetKey) GetPrefixes() []string
func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues
func (x *SearchRequest_FacetSpec_FacetKey) GetRestrictedValues() []string
func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage
func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()
func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect
func (x *SearchRequest_FacetSpec_FacetKey) ProtoReflect() protoreflect.Message
func (*SearchRequest_FacetSpec_FacetKey) Reset
func (x *SearchRequest_FacetSpec_FacetKey) Reset()
func (*SearchRequest_FacetSpec_FacetKey) String
func (x *SearchRequest_FacetSpec_FacetKey) String() string
SearchRequest_ImageQuery
type SearchRequest_ImageQuery struct {
// Types that are assignable to Image:
//
// *SearchRequest_ImageQuery_ImageBytes
Image isSearchRequest_ImageQuery_Image `protobuf_oneof:"image"`
// contains filtered or unexported fields
}
Specifies the image query input.
func (*SearchRequest_ImageQuery) Descriptor
func (*SearchRequest_ImageQuery) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_ImageQuery.ProtoReflect.Descriptor instead.
func (*SearchRequest_ImageQuery) GetImage
func (m *SearchRequest_ImageQuery) GetImage() isSearchRequest_ImageQuery_Image
func (*SearchRequest_ImageQuery) GetImageBytes
func (x *SearchRequest_ImageQuery) GetImageBytes() string
func (*SearchRequest_ImageQuery) ProtoMessage
func (*SearchRequest_ImageQuery) ProtoMessage()
func (*SearchRequest_ImageQuery) ProtoReflect
func (x *SearchRequest_ImageQuery) ProtoReflect() protoreflect.Message
func (*SearchRequest_ImageQuery) Reset
func (x *SearchRequest_ImageQuery) Reset()
func (*SearchRequest_ImageQuery) String
func (x *SearchRequest_ImageQuery) String() string
SearchRequest_ImageQuery_ImageBytes
type SearchRequest_ImageQuery_ImageBytes struct {
// Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
// BMP.
ImageBytes string `protobuf:"bytes,1,opt,name=image_bytes,json=imageBytes,proto3,oneof"`
}
SearchRequest_QueryExpansionSpec
type SearchRequest_QueryExpansionSpec struct {
Condition SearchRequest_QueryExpansionSpec_Condition "" /* 156 byte string literal not displayed */
PinUnexpandedResults bool `protobuf:"varint,2,opt,name=pin_unexpanded_results,json=pinUnexpandedResults,proto3" json:"pin_unexpanded_results,omitempty"`
}
Specification to determine under which conditions query expansion should occur.
func (*SearchRequest_QueryExpansionSpec) Descriptor
func (*SearchRequest_QueryExpansionSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_QueryExpansionSpec) GetCondition
func (x *SearchRequest_QueryExpansionSpec) GetCondition() SearchRequest_QueryExpansionSpec_Condition
func (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults
func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() bool
func (*SearchRequest_QueryExpansionSpec) ProtoMessage
func (*SearchRequest_QueryExpansionSpec) ProtoMessage()
func (*SearchRequest_QueryExpansionSpec) ProtoReflect
func (x *SearchRequest_QueryExpansionSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_QueryExpansionSpec) Reset
func (x *SearchRequest_QueryExpansionSpec) Reset()
func (*SearchRequest_QueryExpansionSpec) String
func (x *SearchRequest_QueryExpansionSpec) String() string
SearchRequest_QueryExpansionSpec_Condition
type SearchRequest_QueryExpansionSpec_Condition int32
Enum describing under which condition query expansion should occur.
SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED, SearchRequest_QueryExpansionSpec_DISABLED, SearchRequest_QueryExpansionSpec_AUTO
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
func (SearchRequest_QueryExpansionSpec_Condition) Descriptor() protoreflect.EnumDescriptor
func (SearchRequest_QueryExpansionSpec_Condition) Enum
func (x SearchRequest_QueryExpansionSpec_Condition) Enum() *SearchRequest_QueryExpansionSpec_Condition
func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor
func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor() ([]byte, []int)
Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.
func (SearchRequest_QueryExpansionSpec_Condition) Number
func (x SearchRequest_QueryExpansionSpec_Condition) Number() protoreflect.EnumNumber
func (SearchRequest_QueryExpansionSpec_Condition) String
func (x SearchRequest_QueryExpansionSpec_Condition) String() string
func (SearchRequest_QueryExpansionSpec_Condition) Type
func (SearchRequest_QueryExpansionSpec_Condition) Type() protoreflect.EnumType
SearchRequest_SpellCorrectionSpec
type SearchRequest_SpellCorrectionSpec struct {
Mode SearchRequest_SpellCorrectionSpec_Mode "" /* 142 byte string literal not displayed */
}
The specification for query spell correction.
func (*SearchRequest_SpellCorrectionSpec) Descriptor
func (*SearchRequest_SpellCorrectionSpec) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_SpellCorrectionSpec) GetMode
func (x *SearchRequest_SpellCorrectionSpec) GetMode() SearchRequest_SpellCorrectionSpec_Mode
func (*SearchRequest_SpellCorrectionSpec) ProtoMessage
func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()
func (*SearchRequest_SpellCorrectionSpec) ProtoReflect
func (x *SearchRequest_SpellCorrectionSpec) ProtoReflect() protoreflect.Message
func (*SearchRequest_SpellCorrectionSpec) Reset
func (x *SearchRequest_SpellCorrectionSpec) Reset()
func (*SearchRequest_SpellCorrectionSpec) String
func (x *SearchRequest_SpellCorrectionSpec) String() string
SearchRequest_SpellCorrectionSpec_Mode
type SearchRequest_SpellCorrectionSpec_Mode int32
Enum describing under which mode spell correction should occur.
SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED, SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY, SearchRequest_SpellCorrectionSpec_AUTO
const (
// Unspecified spell correction mode. In this case, server behavior
// defaults to
// [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
// Search API will try to find a spell suggestion if there
// is any and put in the
// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query].
// The spell suggestion will not be used as the search query.
SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
// Automatic spell correction built by the Search API. Search will
// be based on the corrected query if found.
SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)
func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor
func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor() protoreflect.EnumDescriptor
func (SearchRequest_SpellCorrectionSpec_Mode) Enum
func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor
func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor() ([]byte, []int)
Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.
func (SearchRequest_SpellCorrectionSpec_Mode) Number
func (x SearchRequest_SpellCorrectionSpec_Mode) Number() protoreflect.EnumNumber
func (SearchRequest_SpellCorrectionSpec_Mode) String
func (x SearchRequest_SpellCorrectionSpec_Mode) String() string
func (SearchRequest_SpellCorrectionSpec_Mode) Type
func (SearchRequest_SpellCorrectionSpec_Mode) Type() protoreflect.EnumType
SearchResponse
type SearchResponse struct {
// A list of matched documents. The order represents the ranking.
Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
// Results of facets requested by user.
Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`
// Guided search result.
GuidedSearchResult *SearchResponse_GuidedSearchResult `protobuf:"bytes,8,opt,name=guided_search_result,json=guidedSearchResult,proto3" json:"guided_search_result,omitempty"`
// The estimated total count of matched items irrespective of pagination. The
// count of
// [results][google.cloud.discoveryengine.v1beta.SearchResponse.results]
// returned by pagination may be less than the
// [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size]
// that matches.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// A unique search token. This should be included in the
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
// from this search, which enables accurate attribution of search model
// performance.
AttributionToken string `protobuf:"bytes,4,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
// 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"`
// Debug information specifically related to forward geocoding issues arising
// from Geolocation Search.
GeoSearchDebugInfo []*SearchResponse_GeoSearchDebugInfo `protobuf:"bytes,16,rep,name=geo_search_debug_info,json=geoSearchDebugInfo,proto3" json:"geo_search_debug_info,omitempty"`
// Query expansion information for the returned results.
QueryExpansionInfo *SearchResponse_QueryExpansionInfo `protobuf:"bytes,14,opt,name=query_expansion_info,json=queryExpansionInfo,proto3" json:"query_expansion_info,omitempty"`
// contains filtered or unexported fields
}
Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
func (*SearchResponse) Descriptor
func (*SearchResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.
func (*SearchResponse) GetAppliedControls
func (x *SearchResponse) GetAppliedControls() []string
func (*SearchResponse) GetAttributionToken
func (x *SearchResponse) GetAttributionToken() string
func (*SearchResponse) GetCorrectedQuery
func (x *SearchResponse) GetCorrectedQuery() string
func (*SearchResponse) GetFacets
func (x *SearchResponse) GetFacets() []*SearchResponse_Facet
func (*SearchResponse) GetGeoSearchDebugInfo
func (x *SearchResponse) GetGeoSearchDebugInfo() []*SearchResponse_GeoSearchDebugInfo
func (*SearchResponse) GetGuidedSearchResult
func (x *SearchResponse) GetGuidedSearchResult() *SearchResponse_GuidedSearchResult
func (*SearchResponse) GetNextPageToken
func (x *SearchResponse) GetNextPageToken() string
func (*SearchResponse) GetQueryExpansionInfo
func (x *SearchResponse) GetQueryExpansionInfo() *SearchResponse_QueryExpansionInfo
func (*SearchResponse) GetRedirectUri
func (x *SearchResponse) GetRedirectUri() string
func (*SearchResponse) GetResults
func (x *SearchResponse) GetResults() []*SearchResponse_SearchResult
func (*SearchResponse) GetSummary
func (x *SearchResponse) GetSummary() *SearchResponse_Summary
func (*SearchResponse) GetTotalSize
func (x *SearchResponse) GetTotalSize() int32
func (*SearchResponse) ProtoMessage
func (*SearchResponse) ProtoMessage()
func (*SearchResponse) ProtoReflect
func (x *SearchResponse) ProtoReflect() protoreflect.Message
func (*SearchResponse) Reset
func (x *SearchResponse) Reset()
func (*SearchResponse) String
func (x *SearchResponse) String() string
SearchResponse_Facet
type SearchResponse_Facet struct {
// The key for this facet. E.g., "colors" or "price". It matches
// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.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
func (*SearchResponse_Facet) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.
func (*SearchResponse_Facet) GetDynamicFacet
func (x *SearchResponse_Facet) GetDynamicFacet() bool
func (*SearchResponse_Facet) GetKey
func (x *SearchResponse_Facet) GetKey() string
func (*SearchResponse_Facet) GetValues
func (x *SearchResponse_Facet) GetValues() []*SearchResponse_Facet_FacetValue
func (*SearchResponse_Facet) ProtoMessage
func (*SearchResponse_Facet) ProtoMessage()
func (*SearchResponse_Facet) ProtoReflect
func (x *SearchResponse_Facet) ProtoReflect() protoreflect.Message
func (*SearchResponse_Facet) Reset
func (x *SearchResponse_Facet) Reset()
func (*SearchResponse_Facet) String
func (x *SearchResponse_Facet) String() string
SearchResponse_Facet_FacetValue
type SearchResponse_Facet_FacetValue struct {
// A facet value which contains values.
//
// Types that are assignable to FacetValue:
//
// *SearchResponse_Facet_FacetValue_Value
// *SearchResponse_Facet_FacetValue_Interval
FacetValue isSearchResponse_Facet_FacetValue_FacetValue `protobuf_oneof:"facet_value"`
// Number of items that have this facet value.
Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
// contains filtered or unexported fields
}
A facet value which contains value names and their count.
func (*SearchResponse_Facet_FacetValue) Descriptor
func (*SearchResponse_Facet_FacetValue) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.
func (*SearchResponse_Facet_FacetValue) GetCount
func (x *SearchResponse_Facet_FacetValue) GetCount() int64
func (*SearchResponse_Facet_FacetValue) GetFacetValue
func (m *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValue
func (*SearchResponse_Facet_FacetValue) GetInterval
func (x *SearchResponse_Facet_FacetValue) GetInterval() *Interval
func (*SearchResponse_Facet_FacetValue) GetValue
func (x *SearchResponse_Facet_FacetValue) GetValue() string
func (*SearchResponse_Facet_FacetValue) ProtoMessage
func (*SearchResponse_Facet_FacetValue) ProtoMessage()
func (*SearchResponse_Facet_FacetValue) ProtoReflect
func (x *SearchResponse_Facet_FacetValue) ProtoReflect() protoreflect.Message
func (*SearchResponse_Facet_FacetValue) Reset
func (x *SearchResponse_Facet_FacetValue) Reset()
func (*SearchResponse_Facet_FacetValue) String
func (x *SearchResponse_Facet_FacetValue) String() string
SearchResponse_Facet_FacetValue_Interval
type SearchResponse_Facet_FacetValue_Interval struct {
// Interval value for a facet, such as [10, 20) for facet "price". It
// matches
// [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}
SearchResponse_Facet_FacetValue_Value
type SearchResponse_Facet_FacetValue_Value struct {
// Text value of a facet, such as "Black" for facet "colors".
Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}
SearchResponse_GeoSearchDebugInfo
type SearchResponse_GeoSearchDebugInfo struct {
// The address from which forward geocoding ingestion produced issues.
OriginalAddressQuery string `protobuf:"bytes,1,opt,name=original_address_query,json=originalAddressQuery,proto3" json:"original_address_query,omitempty"`
// The error produced.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// contains filtered or unexported fields
}
Debug information specifically related to forward geocoding issues arising from Geolocation Search.
func (*SearchResponse_GeoSearchDebugInfo) Descriptor
func (*SearchResponse_GeoSearchDebugInfo) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_GeoSearchDebugInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_GeoSearchDebugInfo) GetErrorMessage
func (x *SearchResponse_GeoSearchDebugInfo) GetErrorMessage() string
func (*SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery
func (x *SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery() string
func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage
func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage()
func (*SearchResponse_GeoSearchDebugInfo) ProtoReflect
func (x *SearchResponse_GeoSearchDebugInfo) ProtoReflect() protoreflect.Message
func (*SearchResponse_GeoSearchDebugInfo) Reset
func (x *SearchResponse_GeoSearchDebugInfo) Reset()
func (*SearchResponse_GeoSearchDebugInfo) String
func (x *SearchResponse_GeoSearchDebugInfo) String() string
SearchResponse_GuidedSearchResult
type SearchResponse_GuidedSearchResult struct {
// A list of ranked refinement attributes.
RefinementAttributes []*SearchResponse_GuidedSearchResult_RefinementAttribute `protobuf:"bytes,1,rep,name=refinement_attributes,json=refinementAttributes,proto3" json:"refinement_attributes,omitempty"`
// Suggested follow-up questions.
FollowUpQuestions []string `protobuf:"bytes,2,rep,name=follow_up_questions,json=followUpQuestions,proto3" json:"follow_up_questions,omitempty"`
// contains filtered or unexported fields
}
Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
func (*SearchResponse_GuidedSearchResult) Descriptor
func (*SearchResponse_GuidedSearchResult) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_GuidedSearchResult.ProtoReflect.Descriptor instead.
func (*SearchResponse_GuidedSearchResult) GetFollowUpQuestions
func (x *SearchResponse_GuidedSearchResult) GetFollowUpQuestions() []string
func (*SearchResponse_GuidedSearchResult) GetRefinementAttributes
func (x *SearchResponse_GuidedSearchResult) GetRefinementAttributes() []*SearchResponse_GuidedSearchResult_RefinementAttribute
func (*SearchResponse_GuidedSearchResult) ProtoMessage
func (*SearchResponse_GuidedSearchResult) ProtoMessage()
func (*SearchResponse_GuidedSearchResult) ProtoReflect
func (x *SearchResponse_GuidedSearchResult) ProtoReflect() protoreflect.Message
func (*SearchResponse_GuidedSearchResult) Reset
func (x *SearchResponse_GuidedSearchResult) Reset()
func (*SearchResponse_GuidedSearchResult) String
func (x *SearchResponse_GuidedSearchResult) String() string
SearchResponse_GuidedSearchResult_RefinementAttribute
type SearchResponse_GuidedSearchResult_RefinementAttribute struct {
// Attribute key used to refine the results e.g. 'movie_type'.
AttributeKey string `protobuf:"bytes,1,opt,name=attribute_key,json=attributeKey,proto3" json:"attribute_key,omitempty"`
// Attribute value used to refine the results e.g. 'drama'.
AttributeValue string `protobuf:"bytes,2,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
// contains filtered or unexported fields
}
Useful attribute for search result refinements.
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_GuidedSearchResult_RefinementAttribute.ProtoReflect.Descriptor instead.
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey() string
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue() string
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage()
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect() protoreflect.Message
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Reset
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) Reset()
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) String
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) String() string
SearchResponse_QueryExpansionInfo
type SearchResponse_QueryExpansionInfo struct {
// Bool describing whether query expansion has occurred.
ExpandedQuery bool `protobuf:"varint,1,opt,name=expanded_query,json=expandedQuery,proto3" json:"expanded_query,omitempty"`
// Number of pinned results. This field will only be set when expansion
// happens and
// [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.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
func (*SearchResponse_QueryExpansionInfo) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_QueryExpansionInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_QueryExpansionInfo) GetExpandedQuery
func (x *SearchResponse_QueryExpansionInfo) GetExpandedQuery() bool
func (*SearchResponse_QueryExpansionInfo) GetPinnedResultCount
func (x *SearchResponse_QueryExpansionInfo) GetPinnedResultCount() int64
func (*SearchResponse_QueryExpansionInfo) ProtoMessage
func (*SearchResponse_QueryExpansionInfo) ProtoMessage()
func (*SearchResponse_QueryExpansionInfo) ProtoReflect
func (x *SearchResponse_QueryExpansionInfo) ProtoReflect() protoreflect.Message
func (*SearchResponse_QueryExpansionInfo) Reset
func (x *SearchResponse_QueryExpansionInfo) Reset()
func (*SearchResponse_QueryExpansionInfo) String
func (x *SearchResponse_QueryExpansionInfo) String() string
SearchResponse_SearchResult
type SearchResponse_SearchResult struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
ModelScores map[string]*DoubleList "" /* 182 byte string literal not displayed */
}
Represents the search results.
func (*SearchResponse_SearchResult) Descriptor
func (*SearchResponse_SearchResult) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.
func (*SearchResponse_SearchResult) GetDocument
func (x *SearchResponse_SearchResult) GetDocument() *Document
func (*SearchResponse_SearchResult) GetId
func (x *SearchResponse_SearchResult) GetId() string
func (*SearchResponse_SearchResult) GetModelScores
func (x *SearchResponse_SearchResult) GetModelScores() map[string]*DoubleList
func (*SearchResponse_SearchResult) ProtoMessage
func (*SearchResponse_SearchResult) ProtoMessage()
func (*SearchResponse_SearchResult) ProtoReflect
func (x *SearchResponse_SearchResult) ProtoReflect() protoreflect.Message
func (*SearchResponse_SearchResult) Reset
func (x *SearchResponse_SearchResult) Reset()
func (*SearchResponse_SearchResult) String
func (x *SearchResponse_SearchResult) String() string
SearchResponse_Summary
type SearchResponse_Summary struct {
SummaryText string `protobuf:"bytes,1,opt,name=summary_text,json=summaryText,proto3" json:"summary_text,omitempty"`
SummarySkippedReasons []SearchResponse_Summary_SummarySkippedReason "" /* 219 byte string literal not displayed */
SafetyAttributes *SearchResponse_Summary_SafetyAttributes `protobuf:"bytes,3,opt,name=safety_attributes,json=safetyAttributes,proto3" json:"safety_attributes,omitempty"`
SummaryWithMetadata *SearchResponse_Summary_SummaryWithMetadata `protobuf:"bytes,4,opt,name=summary_with_metadata,json=summaryWithMetadata,proto3" json:"summary_with_metadata,omitempty"`
}
Summary of the top N search result specified by the summary spec.
func (*SearchResponse_Summary) Descriptor
func (*SearchResponse_Summary) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary) GetSafetyAttributes
func (x *SearchResponse_Summary) GetSafetyAttributes() *SearchResponse_Summary_SafetyAttributes
func (*SearchResponse_Summary) GetSummarySkippedReasons
func (x *SearchResponse_Summary) GetSummarySkippedReasons() []SearchResponse_Summary_SummarySkippedReason
func (*SearchResponse_Summary) GetSummaryText
func (x *SearchResponse_Summary) GetSummaryText() string
func (*SearchResponse_Summary) GetSummaryWithMetadata
func (x *SearchResponse_Summary) GetSummaryWithMetadata() *SearchResponse_Summary_SummaryWithMetadata
func (*SearchResponse_Summary) ProtoMessage
func (*SearchResponse_Summary) ProtoMessage()
func (*SearchResponse_Summary) ProtoReflect
func (x *SearchResponse_Summary) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary) Reset
func (x *SearchResponse_Summary) Reset()
func (*SearchResponse_Summary) String
func (x *SearchResponse_Summary) String() string
SearchResponse_Summary_Citation
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
func (*SearchResponse_Summary_Citation) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_Citation.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Citation) GetEndIndex
func (x *SearchResponse_Summary_Citation) GetEndIndex() int64
func (*SearchResponse_Summary_Citation) GetSources
func (x *SearchResponse_Summary_Citation) GetSources() []*SearchResponse_Summary_CitationSource
func (*SearchResponse_Summary_Citation) GetStartIndex
func (x *SearchResponse_Summary_Citation) GetStartIndex() int64
func (*SearchResponse_Summary_Citation) ProtoMessage
func (*SearchResponse_Summary_Citation) ProtoMessage()
func (*SearchResponse_Summary_Citation) ProtoReflect
func (x *SearchResponse_Summary_Citation) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_Citation) Reset
func (x *SearchResponse_Summary_Citation) Reset()
func (*SearchResponse_Summary_Citation) String
func (x *SearchResponse_Summary_Citation) String() string
SearchResponse_Summary_CitationMetadata
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
func (*SearchResponse_Summary_CitationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_CitationMetadata.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_CitationMetadata) GetCitations
func (x *SearchResponse_Summary_CitationMetadata) GetCitations() []*SearchResponse_Summary_Citation
func (*SearchResponse_Summary_CitationMetadata) ProtoMessage
func (*SearchResponse_Summary_CitationMetadata) ProtoMessage()
func (*SearchResponse_Summary_CitationMetadata) ProtoReflect
func (x *SearchResponse_Summary_CitationMetadata) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_CitationMetadata) Reset
func (x *SearchResponse_Summary_CitationMetadata) Reset()
func (*SearchResponse_Summary_CitationMetadata) String
func (x *SearchResponse_Summary_CitationMetadata) String() string
SearchResponse_Summary_CitationSource
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
func (*SearchResponse_Summary_CitationSource) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_CitationSource.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_CitationSource) GetReferenceIndex
func (x *SearchResponse_Summary_CitationSource) GetReferenceIndex() int64
func (*SearchResponse_Summary_CitationSource) ProtoMessage
func (*SearchResponse_Summary_CitationSource) ProtoMessage()
func (*SearchResponse_Summary_CitationSource) ProtoReflect
func (x *SearchResponse_Summary_CitationSource) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_CitationSource) Reset
func (x *SearchResponse_Summary_CitationSource) Reset()
func (*SearchResponse_Summary_CitationSource) String
func (x *SearchResponse_Summary_CitationSource) String() string
SearchResponse_Summary_Reference
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
func (*SearchResponse_Summary_Reference) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_Reference.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Reference) GetChunkContents
func (x *SearchResponse_Summary_Reference) GetChunkContents() []*SearchResponse_Summary_Reference_ChunkContent
func (*SearchResponse_Summary_Reference) GetDocument
func (x *SearchResponse_Summary_Reference) GetDocument() string
func (*SearchResponse_Summary_Reference) GetTitle
func (x *SearchResponse_Summary_Reference) GetTitle() string
func (*SearchResponse_Summary_Reference) GetUri
func (x *SearchResponse_Summary_Reference) GetUri() string
func (*SearchResponse_Summary_Reference) ProtoMessage
func (*SearchResponse_Summary_Reference) ProtoMessage()
func (*SearchResponse_Summary_Reference) ProtoReflect
func (x *SearchResponse_Summary_Reference) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_Reference) Reset
func (x *SearchResponse_Summary_Reference) Reset()
func (*SearchResponse_Summary_Reference) String
func (x *SearchResponse_Summary_Reference) String() string
SearchResponse_Summary_Reference_ChunkContent
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
func (*SearchResponse_Summary_Reference_ChunkContent) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_Reference_ChunkContent.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Reference_ChunkContent) GetContent
func (x *SearchResponse_Summary_Reference_ChunkContent) GetContent() string
func (*SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier
func (x *SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier() string
func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage
func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage()
func (*SearchResponse_Summary_Reference_ChunkContent) ProtoReflect
func (x *SearchResponse_Summary_Reference_ChunkContent) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_Reference_ChunkContent) Reset
func (x *SearchResponse_Summary_Reference_ChunkContent) Reset()
func (*SearchResponse_Summary_Reference_ChunkContent) String
func (x *SearchResponse_Summary_Reference_ChunkContent) String() string
SearchResponse_Summary_SafetyAttributes
type SearchResponse_Summary_SafetyAttributes struct {
// The display names of Safety Attribute categories associated with the
// generated content. Order matches the Scores.
Categories []string `protobuf:"bytes,1,rep,name=categories,proto3" json:"categories,omitempty"`
// The confidence scores of the each category, higher
// value means higher confidence. Order matches the Categories.
Scores []float32 `protobuf:"fixed32,2,rep,packed,name=scores,proto3" json:"scores,omitempty"`
// contains filtered or unexported fields
}
Safety Attribute categories and their associated confidence scores.
func (*SearchResponse_Summary_SafetyAttributes) Descriptor
func (*SearchResponse_Summary_SafetyAttributes) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_SafetyAttributes.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_SafetyAttributes) GetCategories
func (x *SearchResponse_Summary_SafetyAttributes) GetCategories() []string
func (*SearchResponse_Summary_SafetyAttributes) GetScores
func (x *SearchResponse_Summary_SafetyAttributes) GetScores() []float32
func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage
func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage()
func (*SearchResponse_Summary_SafetyAttributes) ProtoReflect
func (x *SearchResponse_Summary_SafetyAttributes) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_SafetyAttributes) Reset
func (x *SearchResponse_Summary_SafetyAttributes) Reset()
func (*SearchResponse_Summary_SafetyAttributes) String
func (x *SearchResponse_Summary_SafetyAttributes) String() string
SearchResponse_Summary_SummarySkippedReason
type SearchResponse_Summary_SummarySkippedReason int32
An Enum for summary-skipped reasons.
SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED, SearchResponse_Summary_ADVERSARIAL_QUERY_IGNORED, SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED, SearchResponse_Summary_OUT_OF_DOMAIN_QUERY_IGNORED, SearchResponse_Summary_POTENTIAL_POLICY_VIOLATION, SearchResponse_Summary_LLM_ADDON_NOT_ENABLED
const (
// Default value. The summary skipped reason is not specified.
SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED SearchResponse_Summary_SummarySkippedReason = 0
// The adversarial query ignored case.
//
// Only populated when
// [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.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 populated 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
)
func (SearchResponse_Summary_SummarySkippedReason) Descriptor
func (SearchResponse_Summary_SummarySkippedReason) Descriptor() protoreflect.EnumDescriptor
func (SearchResponse_Summary_SummarySkippedReason) Enum
func (x SearchResponse_Summary_SummarySkippedReason) Enum() *SearchResponse_Summary_SummarySkippedReason
func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor
func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_SummarySkippedReason.Descriptor instead.
func (SearchResponse_Summary_SummarySkippedReason) Number
func (x SearchResponse_Summary_SummarySkippedReason) Number() protoreflect.EnumNumber
func (SearchResponse_Summary_SummarySkippedReason) String
func (x SearchResponse_Summary_SummarySkippedReason) String() string
func (SearchResponse_Summary_SummarySkippedReason) Type
func (SearchResponse_Summary_SummarySkippedReason) Type() protoreflect.EnumType
SearchResponse_Summary_SummaryWithMetadata
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
func (*SearchResponse_Summary_SummaryWithMetadata) Descriptor() ([]byte, []int)
Deprecated: Use SearchResponse_Summary_SummaryWithMetadata.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata
func (x *SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata() *SearchResponse_Summary_CitationMetadata
func (*SearchResponse_Summary_SummaryWithMetadata) GetReferences
func (x *SearchResponse_Summary_SummaryWithMetadata) GetReferences() []*SearchResponse_Summary_Reference
func (*SearchResponse_Summary_SummaryWithMetadata) GetSummary
func (x *SearchResponse_Summary_SummaryWithMetadata) GetSummary() string
func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage
func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage()
func (*SearchResponse_Summary_SummaryWithMetadata) ProtoReflect
func (x *SearchResponse_Summary_SummaryWithMetadata) ProtoReflect() protoreflect.Message
func (*SearchResponse_Summary_SummaryWithMetadata) Reset
func (x *SearchResponse_Summary_SummaryWithMetadata) Reset()
func (*SearchResponse_Summary_SummaryWithMetadata) String
func (x *SearchResponse_Summary_SummaryWithMetadata) String() string
SearchServiceClient
type SearchServiceClient interface {
// Performs a search.
Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}
SearchServiceClient is the client API for SearchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewSearchServiceClient
func NewSearchServiceClient(cc grpc.ClientConnInterface) SearchServiceClient
SearchServiceServer
type SearchServiceServer interface {
// Performs a search.
Search(context.Context, *SearchRequest) (*SearchResponse, error)
}
SearchServiceServer is the server API for SearchService service.
SearchTier
type SearchTier int32
Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.
SearchTier_SEARCH_TIER_UNSPECIFIED, SearchTier_SEARCH_TIER_STANDARD, SearchTier_SEARCH_TIER_ENTERPRISE
const (
// Default value when the enum is unspecified. This is invalid to use.
SearchTier_SEARCH_TIER_UNSPECIFIED SearchTier = 0
// Standard tier.
SearchTier_SEARCH_TIER_STANDARD SearchTier = 1
// Enterprise tier.
SearchTier_SEARCH_TIER_ENTERPRISE SearchTier = 2
)
func (SearchTier) Descriptor
func (SearchTier) Descriptor() protoreflect.EnumDescriptor
func (SearchTier) Enum
func (x SearchTier) Enum() *SearchTier
func (SearchTier) EnumDescriptor
func (SearchTier) EnumDescriptor() ([]byte, []int)
Deprecated: Use SearchTier.Descriptor instead.
func (SearchTier) Number
func (x SearchTier) Number() protoreflect.EnumNumber
func (SearchTier) String
func (x SearchTier) String() string
func (SearchTier) Type
func (SearchTier) Type() protoreflect.EnumType
SearchTuningServiceClient
type SearchTuningServiceClient interface {
// Trains a custom model.
TrainCustomModel(ctx context.Context, in *TrainCustomModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}
SearchTuningServiceClient is the client API for SearchTuningService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewSearchTuningServiceClient
func NewSearchTuningServiceClient(cc grpc.ClientConnInterface) SearchTuningServiceClient
SearchTuningServiceServer
type SearchTuningServiceServer interface {
// Trains a custom model.
TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
}
SearchTuningServiceServer is the server API for SearchTuningService service.
ServingConfig
type ServingConfig struct {
VerticalConfig isServingConfig_VerticalConfig `protobuf_oneof:"vertical_config"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
SolutionType SolutionType "" /* 152 byte string literal not displayed */
ModelId string `protobuf:"bytes,4,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
DiversityLevel string `protobuf:"bytes,5,opt,name=diversity_level,json=diversityLevel,proto3" json:"diversity_level,omitempty"`
EmbeddingConfig *EmbeddingConfig `protobuf:"bytes,20,opt,name=embedding_config,json=embeddingConfig,proto3" json:"embedding_config,omitempty"`
RankingExpression string `protobuf:"bytes,21,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
FilterControlIds []string `protobuf:"bytes,11,rep,name=filter_control_ids,json=filterControlIds,proto3" json:"filter_control_ids,omitempty"`
BoostControlIds []string `protobuf:"bytes,12,rep,name=boost_control_ids,json=boostControlIds,proto3" json:"boost_control_ids,omitempty"`
RedirectControlIds []string `protobuf:"bytes,14,rep,name=redirect_control_ids,json=redirectControlIds,proto3" json:"redirect_control_ids,omitempty"`
SynonymsControlIds []string `protobuf:"bytes,15,rep,name=synonyms_control_ids,json=synonymsControlIds,proto3" json:"synonyms_control_ids,omitempty"`
OnewaySynonymsControlIds []string "" /* 138 byte string literal not displayed */
DissociateControlIds []string `protobuf:"bytes,17,rep,name=dissociate_control_ids,json=dissociateControlIds,proto3" json:"dissociate_control_ids,omitempty"`
ReplacementControlIds []string "" /* 127 byte string literal not displayed */
IgnoreControlIds []string `protobuf:"bytes,19,rep,name=ignore_control_ids,json=ignoreControlIds,proto3" json:"ignore_control_ids,omitempty"`
}
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
func (*ServingConfig) Descriptor() ([]byte, []int)
Deprecated: Use ServingConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig) GetBoostControlIds
func (x *ServingConfig) GetBoostControlIds() []string
func (*ServingConfig) GetCreateTime
func (x *ServingConfig) GetCreateTime() *timestamppb.Timestamp
func (*ServingConfig) GetDisplayName
func (x *ServingConfig) GetDisplayName() string
func (*ServingConfig) GetDissociateControlIds
func (x *ServingConfig) GetDissociateControlIds() []string
func (*ServingConfig) GetDiversityLevel
func (x *ServingConfig) GetDiversityLevel() string
func (*ServingConfig) GetEmbeddingConfig
func (x *ServingConfig) GetEmbeddingConfig() *EmbeddingConfig
func (*ServingConfig) GetFilterControlIds
func (x *ServingConfig) GetFilterControlIds() []string
func (*ServingConfig) GetGenericConfig
func (x *ServingConfig) GetGenericConfig() *ServingConfig_GenericConfig
func (*ServingConfig) GetIgnoreControlIds
func (x *ServingConfig) GetIgnoreControlIds() []string
func (*ServingConfig) GetMediaConfig
func (x *ServingConfig) GetMediaConfig() *ServingConfig_MediaConfig
func (*ServingConfig) GetModelId
func (x *ServingConfig) GetModelId() string
func (*ServingConfig) GetName
func (x *ServingConfig) GetName() string
func (*ServingConfig) GetOnewaySynonymsControlIds
func (x *ServingConfig) GetOnewaySynonymsControlIds() []string
func (*ServingConfig) GetRankingExpression
func (x *ServingConfig) GetRankingExpression() string
func (*ServingConfig) GetRedirectControlIds
func (x *ServingConfig) GetRedirectControlIds() []string
func (*ServingConfig) GetReplacementControlIds
func (x *ServingConfig) GetReplacementControlIds() []string
func (*ServingConfig) GetSolutionType
func (x *ServingConfig) GetSolutionType() SolutionType
func (*ServingConfig) GetSynonymsControlIds
func (x *ServingConfig) GetSynonymsControlIds() []string
func (*ServingConfig) GetUpdateTime
func (x *ServingConfig) GetUpdateTime() *timestamppb.Timestamp
func (*ServingConfig) GetVerticalConfig
func (m *ServingConfig) GetVerticalConfig() isServingConfig_VerticalConfig
func (*ServingConfig) ProtoMessage
func (*ServingConfig) ProtoMessage()
func (*ServingConfig) ProtoReflect
func (x *ServingConfig) ProtoReflect() protoreflect.Message
func (*ServingConfig) Reset
func (x *ServingConfig) Reset()
func (*ServingConfig) String
func (x *ServingConfig) String() string
ServingConfigServiceClient
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
func NewServingConfigServiceClient(cc grpc.ClientConnInterface) ServingConfigServiceClient
ServingConfigServiceServer
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.
ServingConfig_GenericConfig
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
func (*ServingConfig_GenericConfig) Descriptor() ([]byte, []int)
Deprecated: Use ServingConfig_GenericConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig_GenericConfig) GetContentSearchSpec
func (x *ServingConfig_GenericConfig) GetContentSearchSpec() *SearchRequest_ContentSearchSpec
func (*ServingConfig_GenericConfig) ProtoMessage
func (*ServingConfig_GenericConfig) ProtoMessage()
func (*ServingConfig_GenericConfig) ProtoReflect
func (x *ServingConfig_GenericConfig) ProtoReflect() protoreflect.Message
func (*ServingConfig_GenericConfig) Reset
func (x *ServingConfig_GenericConfig) Reset()
func (*ServingConfig_GenericConfig) String
func (x *ServingConfig_GenericConfig) String() string
ServingConfig_GenericConfig_
type ServingConfig_GenericConfig_ struct {
// The GenericConfig of the serving configuration.
GenericConfig *ServingConfig_GenericConfig `protobuf:"bytes,10,opt,name=generic_config,json=genericConfig,proto3,oneof"`
}
ServingConfig_MediaConfig
type ServingConfig_MediaConfig struct {
DemoteContentWatched isServingConfig_MediaConfig_DemoteContentWatched `protobuf_oneof:"demote_content_watched"`
DemotionEventType string `protobuf:"bytes,1,opt,name=demotion_event_type,json=demotionEventType,proto3" json:"demotion_event_type,omitempty"`
ContentFreshnessCutoffDays int32 "" /* 144 byte string literal not displayed */
}
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
func (*ServingConfig_MediaConfig) Descriptor() ([]byte, []int)
Deprecated: Use ServingConfig_MediaConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig_MediaConfig) GetContentFreshnessCutoffDays
func (x *ServingConfig_MediaConfig) GetContentFreshnessCutoffDays() int32
func (*ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold
func (x *ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold() float32
func (*ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold
func (x *ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold() float32
func (*ServingConfig_MediaConfig) GetDemoteContentWatched
func (m *ServingConfig_MediaConfig) GetDemoteContentWatched() isServingConfig_MediaConfig_DemoteContentWatched
func (*ServingConfig_MediaConfig) GetDemotionEventType
func (x *ServingConfig_MediaConfig) GetDemotionEventType() string
func (*ServingConfig_MediaConfig) ProtoMessage
func (*ServingConfig_MediaConfig) ProtoMessage()
func (*ServingConfig_MediaConfig) ProtoReflect
func (x *ServingConfig_MediaConfig) ProtoReflect() protoreflect.Message
func (*ServingConfig_MediaConfig) Reset
func (x *ServingConfig_MediaConfig) Reset()
func (*ServingConfig_MediaConfig) String
func (x *ServingConfig_MediaConfig) String() string
ServingConfig_MediaConfig_
type ServingConfig_MediaConfig_ struct {
// The MediaConfig of the serving configuration.
MediaConfig *ServingConfig_MediaConfig `protobuf:"bytes,7,opt,name=media_config,json=mediaConfig,proto3,oneof"`
}
ServingConfig_MediaConfig_ContentWatchedPercentageThreshold
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"`
}
ServingConfig_MediaConfig_ContentWatchedSecondsThreshold
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"`
}
Session
type Session struct {
// Immutable. Fully qualified name
// `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: Use Session.ProtoReflect.Descriptor instead.
func (*Session) GetEndTime
func (x *Session) GetEndTime() *timestamppb.Timestamp
func (*Session) GetName
func (*Session) GetStartTime
func (x *Session) GetStartTime() *timestamppb.Timestamp
func (*Session) GetState
func (x *Session) GetState() Session_State
func (*Session) GetTurns
func (x *Session) GetTurns() []*Session_Turn
func (*Session) GetUserPseudoId
func (*Session) ProtoMessage
func (*Session) ProtoMessage()
func (*Session) ProtoReflect
func (x *Session) ProtoReflect() protoreflect.Message
func (*Session) Reset
func (x *Session) Reset()
func (*Session) String
Session_State
type Session_State int32
Enumeration of the state of the session.
Session_STATE_UNSPECIFIED, Session_IN_PROGRESS
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
func (Session_State) Descriptor() protoreflect.EnumDescriptor
func (Session_State) Enum
func (x Session_State) Enum() *Session_State
func (Session_State) EnumDescriptor
func (Session_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Session_State.Descriptor instead.
func (Session_State) Number
func (x Session_State) Number() protoreflect.EnumNumber
func (Session_State) String
func (x Session_State) String() string
func (Session_State) Type
func (Session_State) Type() protoreflect.EnumType
Session_Turn
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.
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
func (*Session_Turn) Descriptor() ([]byte, []int)
Deprecated: Use Session_Turn.ProtoReflect.Descriptor instead.
func (*Session_Turn) GetAnswer
func (x *Session_Turn) GetAnswer() string
func (*Session_Turn) GetQuery
func (x *Session_Turn) GetQuery() *Query
func (*Session_Turn) ProtoMessage
func (*Session_Turn) ProtoMessage()
func (*Session_Turn) ProtoReflect
func (x *Session_Turn) ProtoReflect() protoreflect.Message
func (*Session_Turn) Reset
func (x *Session_Turn) Reset()
func (*Session_Turn) String
func (x *Session_Turn) String() string
SiteSearchEngine
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
func (*SiteSearchEngine) Descriptor() ([]byte, []int)
Deprecated: Use SiteSearchEngine.ProtoReflect.Descriptor instead.
func (*SiteSearchEngine) GetName
func (x *SiteSearchEngine) GetName() string
func (*SiteSearchEngine) ProtoMessage
func (*SiteSearchEngine) ProtoMessage()
func (*SiteSearchEngine) ProtoReflect
func (x *SiteSearchEngine) ProtoReflect() protoreflect.Message
func (*SiteSearchEngine) Reset
func (x *SiteSearchEngine) Reset()
func (*SiteSearchEngine) String
func (x *SiteSearchEngine) String() string
SiteSearchEngineServiceClient
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
func NewSiteSearchEngineServiceClient(cc grpc.ClientConnInterface) SiteSearchEngineServiceClient
SiteSearchEngineServiceServer
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.
SiteVerificationInfo
type SiteVerificationInfo struct {
SiteVerificationState SiteVerificationInfo_SiteVerificationState "" /* 211 byte string literal not displayed */
VerifyTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=verify_time,json=verifyTime,proto3" json:"verify_time,omitempty"`
}
Verification information for target sites in advanced site search.
func (*SiteVerificationInfo) Descriptor
func (*SiteVerificationInfo) Descriptor() ([]byte, []int)
Deprecated: Use SiteVerificationInfo.ProtoReflect.Descriptor instead.
func (*SiteVerificationInfo) GetSiteVerificationState
func (x *SiteVerificationInfo) GetSiteVerificationState() SiteVerificationInfo_SiteVerificationState
func (*SiteVerificationInfo) GetVerifyTime
func (x *SiteVerificationInfo) GetVerifyTime() *timestamppb.Timestamp
func (*SiteVerificationInfo) ProtoMessage
func (*SiteVerificationInfo) ProtoMessage()
func (*SiteVerificationInfo) ProtoReflect
func (x *SiteVerificationInfo) ProtoReflect() protoreflect.Message
func (*SiteVerificationInfo) Reset
func (x *SiteVerificationInfo) Reset()
func (*SiteVerificationInfo) String
func (x *SiteVerificationInfo) String() string
SiteVerificationInfo_SiteVerificationState
type SiteVerificationInfo_SiteVerificationState int32
Site verification state.
SiteVerificationInfo_SITE_VERIFICATION_STATE_UNSPECIFIED, SiteVerificationInfo_VERIFIED, SiteVerificationInfo_UNVERIFIED, SiteVerificationInfo_EXEMPTED
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
func (SiteVerificationInfo_SiteVerificationState) Descriptor() protoreflect.EnumDescriptor
func (SiteVerificationInfo_SiteVerificationState) Enum
func (x SiteVerificationInfo_SiteVerificationState) Enum() *SiteVerificationInfo_SiteVerificationState
func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor
func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor() ([]byte, []int)
Deprecated: Use SiteVerificationInfo_SiteVerificationState.Descriptor instead.
func (SiteVerificationInfo_SiteVerificationState) Number
func (x SiteVerificationInfo_SiteVerificationState) Number() protoreflect.EnumNumber
func (SiteVerificationInfo_SiteVerificationState) String
func (x SiteVerificationInfo_SiteVerificationState) String() string
func (SiteVerificationInfo_SiteVerificationState) Type
func (SiteVerificationInfo_SiteVerificationState) Type() protoreflect.EnumType
SolutionType
type SolutionType int32
The type of solution.
SolutionType_SOLUTION_TYPE_UNSPECIFIED, SolutionType_SOLUTION_TYPE_RECOMMENDATION, SolutionType_SOLUTION_TYPE_SEARCH, SolutionType_SOLUTION_TYPE_CHAT, SolutionType_SOLUTION_TYPE_GENERATIVE_CHAT
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
func (SolutionType) Descriptor() protoreflect.EnumDescriptor
func (SolutionType) Enum
func (x SolutionType) Enum() *SolutionType
func (SolutionType) EnumDescriptor
func (SolutionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use SolutionType.Descriptor instead.
func (SolutionType) Number
func (x SolutionType) Number() protoreflect.EnumNumber
func (SolutionType) String
func (x SolutionType) String() string
func (SolutionType) Type
func (SolutionType) Type() protoreflect.EnumType
SpannerSource
type SpannerSource struct {
// The project ID that the Spanner 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 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
func (*SpannerSource) Descriptor() ([]byte, []int)
Deprecated: Use SpannerSource.ProtoReflect.Descriptor instead.
func (*SpannerSource) GetDatabaseId
func (x *SpannerSource) GetDatabaseId() string
func (*SpannerSource) GetEnableDataBoost
func (x *SpannerSource) GetEnableDataBoost() bool
func (*SpannerSource) GetInstanceId
func (x *SpannerSource) GetInstanceId() string
func (*SpannerSource) GetProjectId
func (x *SpannerSource) GetProjectId() string
func (*SpannerSource) GetTableId
func (x *SpannerSource) GetTableId() string
func (*SpannerSource) ProtoMessage
func (*SpannerSource) ProtoMessage()
func (*SpannerSource) ProtoReflect
func (x *SpannerSource) ProtoReflect() protoreflect.Message
func (*SpannerSource) Reset
func (x *SpannerSource) Reset()
func (*SpannerSource) String
func (x *SpannerSource) String() string
SuggestionDenyListEntry
type SuggestionDenyListEntry struct {
BlockPhrase string `protobuf:"bytes,1,opt,name=block_phrase,json=blockPhrase,proto3" json:"block_phrase,omitempty"`
MatchOperator SuggestionDenyListEntry_MatchOperator "" /* 180 byte string literal not displayed */
}
Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
func (*SuggestionDenyListEntry) Descriptor
func (*SuggestionDenyListEntry) Descriptor() ([]byte, []int)
Deprecated: Use SuggestionDenyListEntry.ProtoReflect.Descriptor instead.
func (*SuggestionDenyListEntry) GetBlockPhrase
func (x *SuggestionDenyListEntry) GetBlockPhrase() string
func (*SuggestionDenyListEntry) GetMatchOperator
func (x *SuggestionDenyListEntry) GetMatchOperator() SuggestionDenyListEntry_MatchOperator
func (*SuggestionDenyListEntry) ProtoMessage
func (*SuggestionDenyListEntry) ProtoMessage()
func (*SuggestionDenyListEntry) ProtoReflect
func (x *SuggestionDenyListEntry) ProtoReflect() protoreflect.Message
func (*SuggestionDenyListEntry) Reset
func (x *SuggestionDenyListEntry) Reset()
func (*SuggestionDenyListEntry) String
func (x *SuggestionDenyListEntry) String() string
SuggestionDenyListEntry_MatchOperator
type SuggestionDenyListEntry_MatchOperator int32
Operator for matching with the generated suggestions.
SuggestionDenyListEntry_MATCH_OPERATOR_UNSPECIFIED, SuggestionDenyListEntry_EXACT_MATCH, SuggestionDenyListEntry_CONTAINS
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
func (SuggestionDenyListEntry_MatchOperator) Descriptor() protoreflect.EnumDescriptor
func (SuggestionDenyListEntry_MatchOperator) Enum
func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor
func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor() ([]byte, []int)
Deprecated: Use SuggestionDenyListEntry_MatchOperator.Descriptor instead.
func (SuggestionDenyListEntry_MatchOperator) Number
func (x SuggestionDenyListEntry_MatchOperator) Number() protoreflect.EnumNumber
func (SuggestionDenyListEntry_MatchOperator) String
func (x SuggestionDenyListEntry_MatchOperator) String() string
func (SuggestionDenyListEntry_MatchOperator) Type
func (SuggestionDenyListEntry_MatchOperator) Type() protoreflect.EnumType
TargetSite
type TargetSite struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
ProvidedUriPattern string `protobuf:"bytes,2,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
Type TargetSite_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.TargetSite_Type" json:"type,omitempty"`
ExactMatch bool `protobuf:"varint,6,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
GeneratedUriPattern string `protobuf:"bytes,4,opt,name=generated_uri_pattern,json=generatedUriPattern,proto3" json:"generated_uri_pattern,omitempty"`
SiteVerificationInfo *SiteVerificationInfo `protobuf:"bytes,7,opt,name=site_verification_info,json=siteVerificationInfo,proto3" json:"site_verification_info,omitempty"`
IndexingStatus TargetSite_IndexingStatus "" /* 171 byte string literal not displayed */
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
FailureReason *TargetSite_FailureReason `protobuf:"bytes,9,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
}
A target site for the SiteSearchEngine.
func (*TargetSite) Descriptor
func (*TargetSite) Descriptor() ([]byte, []int)
Deprecated: Use TargetSite.ProtoReflect.Descriptor instead.
func (*TargetSite) GetExactMatch
func (x *TargetSite) GetExactMatch() bool
func (*TargetSite) GetFailureReason
func (x *TargetSite) GetFailureReason() *TargetSite_FailureReason
func (*TargetSite) GetGeneratedUriPattern
func (x *TargetSite) GetGeneratedUriPattern() string
func (*TargetSite) GetIndexingStatus
func (x *TargetSite) GetIndexingStatus() TargetSite_IndexingStatus
func (*TargetSite) GetName
func (x *TargetSite) GetName() string
func (*TargetSite) GetProvidedUriPattern
func (x *TargetSite) GetProvidedUriPattern() string
func (*TargetSite) GetSiteVerificationInfo
func (x *TargetSite) GetSiteVerificationInfo() *SiteVerificationInfo
func (*TargetSite) GetType
func (x *TargetSite) GetType() TargetSite_Type
func (*TargetSite) GetUpdateTime
func (x *TargetSite) GetUpdateTime() *timestamppb.Timestamp
func (*TargetSite) ProtoMessage
func (*TargetSite) ProtoMessage()
func (*TargetSite) ProtoReflect
func (x *TargetSite) ProtoReflect() protoreflect.Message
func (*TargetSite) Reset
func (x *TargetSite) Reset()
func (*TargetSite) String
func (x *TargetSite) String() string
TargetSite_FailureReason
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
func (*TargetSite_FailureReason) Descriptor() ([]byte, []int)
Deprecated: Use TargetSite_FailureReason.ProtoReflect.Descriptor instead.
func (*TargetSite_FailureReason) GetFailure
func (m *TargetSite_FailureReason) GetFailure() isTargetSite_FailureReason_Failure
func (*TargetSite_FailureReason) GetQuotaFailure
func (x *TargetSite_FailureReason) GetQuotaFailure() *TargetSite_FailureReason_QuotaFailure
func (*TargetSite_FailureReason) ProtoMessage
func (*TargetSite_FailureReason) ProtoMessage()
func (*TargetSite_FailureReason) ProtoReflect
func (x *TargetSite_FailureReason) ProtoReflect() protoreflect.Message
func (*TargetSite_FailureReason) Reset
func (x *TargetSite_FailureReason) Reset()
func (*TargetSite_FailureReason) String
func (x *TargetSite_FailureReason) String() string
TargetSite_FailureReason_QuotaFailure
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
func (*TargetSite_FailureReason_QuotaFailure) Descriptor() ([]byte, []int)
Deprecated: Use TargetSite_FailureReason_QuotaFailure.ProtoReflect.Descriptor instead.
func (*TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota
func (x *TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota() int64
func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage
func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage()
func (*TargetSite_FailureReason_QuotaFailure) ProtoReflect
func (x *TargetSite_FailureReason_QuotaFailure) ProtoReflect() protoreflect.Message
func (*TargetSite_FailureReason_QuotaFailure) Reset
func (x *TargetSite_FailureReason_QuotaFailure) Reset()
func (*TargetSite_FailureReason_QuotaFailure) String
func (x *TargetSite_FailureReason_QuotaFailure) String() string
TargetSite_FailureReason_QuotaFailure_
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"`
}
TargetSite_IndexingStatus
type TargetSite_IndexingStatus int32
Target site indexing status enumeration.
TargetSite_INDEXING_STATUS_UNSPECIFIED, TargetSite_PENDING, TargetSite_FAILED, TargetSite_SUCCEEDED, TargetSite_DELETING
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
func (TargetSite_IndexingStatus) Descriptor() protoreflect.EnumDescriptor
func (TargetSite_IndexingStatus) Enum
func (x TargetSite_IndexingStatus) Enum() *TargetSite_IndexingStatus
func (TargetSite_IndexingStatus) EnumDescriptor
func (TargetSite_IndexingStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use TargetSite_IndexingStatus.Descriptor instead.
func (TargetSite_IndexingStatus) Number
func (x TargetSite_IndexingStatus) Number() protoreflect.EnumNumber
func (TargetSite_IndexingStatus) String
func (x TargetSite_IndexingStatus) String() string
func (TargetSite_IndexingStatus) Type
func (TargetSite_IndexingStatus) Type() protoreflect.EnumType
TargetSite_Type
type TargetSite_Type int32
Possible target site types.
TargetSite_TYPE_UNSPECIFIED, TargetSite_INCLUDE, TargetSite_EXCLUDE
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
func (TargetSite_Type) Descriptor() protoreflect.EnumDescriptor
func (TargetSite_Type) Enum
func (x TargetSite_Type) Enum() *TargetSite_Type
func (TargetSite_Type) EnumDescriptor
func (TargetSite_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use TargetSite_Type.Descriptor instead.
func (TargetSite_Type) Number
func (x TargetSite_Type) Number() protoreflect.EnumNumber
func (TargetSite_Type) String
func (x TargetSite_Type) String() string
func (TargetSite_Type) Type
func (TargetSite_Type) Type() protoreflect.EnumType
TextInput
type TextInput struct {
// Text input.
Input string `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
// Conversation context of the input.
Context *ConversationContext `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
// contains filtered or unexported fields
}
Defines text input.
func (*TextInput) Descriptor
Deprecated: Use TextInput.ProtoReflect.Descriptor instead.
func (*TextInput) GetContext
func (x *TextInput) GetContext() *ConversationContext
func (*TextInput) GetInput
func (*TextInput) ProtoMessage
func (*TextInput) ProtoMessage()
func (*TextInput) ProtoReflect
func (x *TextInput) ProtoReflect() protoreflect.Message
func (*TextInput) Reset
func (x *TextInput) Reset()
func (*TextInput) String
TrainCustomModelMetadata
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
func (*TrainCustomModelMetadata) Descriptor() ([]byte, []int)
Deprecated: Use TrainCustomModelMetadata.ProtoReflect.Descriptor instead.
func (*TrainCustomModelMetadata) GetCreateTime
func (x *TrainCustomModelMetadata) GetCreateTime() *timestamppb.Timestamp
func (*TrainCustomModelMetadata) GetUpdateTime
func (x *TrainCustomModelMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*TrainCustomModelMetadata) ProtoMessage
func (*TrainCustomModelMetadata) ProtoMessage()
func (*TrainCustomModelMetadata) ProtoReflect
func (x *TrainCustomModelMetadata) ProtoReflect() protoreflect.Message
func (*TrainCustomModelMetadata) Reset
func (x *TrainCustomModelMetadata) Reset()
func (*TrainCustomModelMetadata) String
func (x *TrainCustomModelMetadata) String() string
TrainCustomModelRequest
type TrainCustomModelRequest struct {
// Model training input.
//
// Types that are assignable to TrainingInput:
//
// *TrainCustomModelRequest_GcsTrainingInput_
TrainingInput isTrainCustomModelRequest_TrainingInput `protobuf_oneof:"training_input"`
// Required. The resource name of the Data Store, such as
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
// This field is used to identify the data store where to train the models.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Model to be trained. Supported values are:
//
// - **search-tuning**: Fine tuning the search system based on data provided.
ModelType string `protobuf:"bytes,3,opt,name=model_type,json=modelType,proto3" json:"model_type,omitempty"`
// The desired location of errors incurred during the data ingestion and
// training.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,4,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}
Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] method.
func (*TrainCustomModelRequest) Descriptor
func (*TrainCustomModelRequest) Descriptor() ([]byte, []int)
Deprecated: Use TrainCustomModelRequest.ProtoReflect.Descriptor instead.
func (*TrainCustomModelRequest) GetDataStore
func (x *TrainCustomModelRequest) GetDataStore() string
func (*TrainCustomModelRequest) GetErrorConfig
func (x *TrainCustomModelRequest) GetErrorConfig() *ImportErrorConfig
func (*TrainCustomModelRequest) GetGcsTrainingInput
func (x *TrainCustomModelRequest) GetGcsTrainingInput() *TrainCustomModelRequest_GcsTrainingInput
func (*TrainCustomModelRequest) GetModelType
func (x *TrainCustomModelRequest) GetModelType() string
func (*TrainCustomModelRequest) GetTrainingInput
func (m *TrainCustomModelRequest) GetTrainingInput() isTrainCustomModelRequest_TrainingInput
func (*TrainCustomModelRequest) ProtoMessage
func (*TrainCustomModelRequest) ProtoMessage()
func (*TrainCustomModelRequest) ProtoReflect
func (x *TrainCustomModelRequest) ProtoReflect() protoreflect.Message
func (*TrainCustomModelRequest) Reset
func (x *TrainCustomModelRequest) Reset()
func (*TrainCustomModelRequest) String
func (x *TrainCustomModelRequest) String() string
TrainCustomModelRequest_GcsTrainingInput
type TrainCustomModelRequest_GcsTrainingInput struct {
// The Cloud Storage corpus data which could be associated in train data.
// The data path format is `gs://
Cloud Storage training data input.
func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor
func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor() ([]byte, []int)
Deprecated: Use TrainCustomModelRequest_GcsTrainingInput.ProtoReflect.Descriptor instead.
func (*TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath() string
func (*TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath() string
func (*TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath() string
func (*TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath() string
func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage
func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage()
func (*TrainCustomModelRequest_GcsTrainingInput) ProtoReflect
func (x *TrainCustomModelRequest_GcsTrainingInput) ProtoReflect() protoreflect.Message
func (*TrainCustomModelRequest_GcsTrainingInput) Reset
func (x *TrainCustomModelRequest_GcsTrainingInput) Reset()
func (*TrainCustomModelRequest_GcsTrainingInput) String
func (x *TrainCustomModelRequest_GcsTrainingInput) String() string
TrainCustomModelRequest_GcsTrainingInput_
type TrainCustomModelRequest_GcsTrainingInput_ struct {
// Cloud Storage training input.
GcsTrainingInput *TrainCustomModelRequest_GcsTrainingInput `protobuf:"bytes,2,opt,name=gcs_training_input,json=gcsTrainingInput,proto3,oneof"`
}
TrainCustomModelResponse
type TrainCustomModelResponse struct {
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
ModelStatus string `protobuf:"bytes,3,opt,name=model_status,json=modelStatus,proto3" json:"model_status,omitempty"`
Metrics map[string]float64 "" /* 157 byte string literal not displayed */
}
Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.
func (*TrainCustomModelResponse) Descriptor
func (*TrainCustomModelResponse) Descriptor() ([]byte, []int)
Deprecated: Use TrainCustomModelResponse.ProtoReflect.Descriptor instead.
func (*TrainCustomModelResponse) GetErrorConfig
func (x *TrainCustomModelResponse) GetErrorConfig() *ImportErrorConfig
func (*TrainCustomModelResponse) GetErrorSamples
func (x *TrainCustomModelResponse) GetErrorSamples() []*status.Status
func (*TrainCustomModelResponse) GetMetrics
func (x *TrainCustomModelResponse) GetMetrics() map[string]float64
func (*TrainCustomModelResponse) GetModelStatus
func (x *TrainCustomModelResponse) GetModelStatus() string
func (*TrainCustomModelResponse) ProtoMessage
func (*TrainCustomModelResponse) ProtoMessage()
func (*TrainCustomModelResponse) ProtoReflect
func (x *TrainCustomModelResponse) ProtoReflect() protoreflect.Message
func (*TrainCustomModelResponse) Reset
func (x *TrainCustomModelResponse) Reset()
func (*TrainCustomModelResponse) String
func (x *TrainCustomModelResponse) String() string
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
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
TuneEngineMetadata
type TuneEngineMetadata struct {
// Required. The resource name of the engine that this tune applies to.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Engine string `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
// contains filtered or unexported fields
}
Metadata associated with a tune operation.
func (*TuneEngineMetadata) Descriptor
func (*TuneEngineMetadata) Descriptor() ([]byte, []int)
Deprecated: Use TuneEngineMetadata.ProtoReflect.Descriptor instead.
func (*TuneEngineMetadata) GetEngine
func (x *TuneEngineMetadata) GetEngine() string
func (*TuneEngineMetadata) ProtoMessage
func (*TuneEngineMetadata) ProtoMessage()
func (*TuneEngineMetadata) ProtoReflect
func (x *TuneEngineMetadata) ProtoReflect() protoreflect.Message
func (*TuneEngineMetadata) Reset
func (x *TuneEngineMetadata) Reset()
func (*TuneEngineMetadata) String
func (x *TuneEngineMetadata) String() string
TuneEngineRequest
type TuneEngineRequest struct {
// Required. The resource name of the engine to tune.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
func (*TuneEngineRequest) Descriptor
func (*TuneEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use TuneEngineRequest.ProtoReflect.Descriptor instead.
func (*TuneEngineRequest) GetName
func (x *TuneEngineRequest) GetName() string
func (*TuneEngineRequest) ProtoMessage
func (*TuneEngineRequest) ProtoMessage()
func (*TuneEngineRequest) ProtoReflect
func (x *TuneEngineRequest) ProtoReflect() protoreflect.Message
func (*TuneEngineRequest) Reset
func (x *TuneEngineRequest) Reset()
func (*TuneEngineRequest) String
func (x *TuneEngineRequest) String() string
TuneEngineResponse
type TuneEngineResponse struct {
// contains filtered or unexported fields
}
Response associated with a tune operation.
func (*TuneEngineResponse) Descriptor
func (*TuneEngineResponse) Descriptor() ([]byte, []int)
Deprecated: Use TuneEngineResponse.ProtoReflect.Descriptor instead.
func (*TuneEngineResponse) ProtoMessage
func (*TuneEngineResponse) ProtoMessage()
func (*TuneEngineResponse) ProtoReflect
func (x *TuneEngineResponse) ProtoReflect() protoreflect.Message
func (*TuneEngineResponse) Reset
func (x *TuneEngineResponse) Reset()
func (*TuneEngineResponse) String
func (x *TuneEngineResponse) String() string
UnimplementedCompletionServiceServer
type UnimplementedCompletionServiceServer struct {
}
UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedCompletionServiceServer) CompleteQuery
func (*UnimplementedCompletionServiceServer) CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries
func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries
func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
UnimplementedConversationalSearchServiceServer
type UnimplementedConversationalSearchServiceServer struct {
}
UnimplementedConversationalSearchServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedConversationalSearchServiceServer) AnswerQuery
func (*UnimplementedConversationalSearchServiceServer) AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)
func (*UnimplementedConversationalSearchServiceServer) ConverseConversation
func (*UnimplementedConversationalSearchServiceServer) ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)
func (*UnimplementedConversationalSearchServiceServer) CreateConversation
func (*UnimplementedConversationalSearchServiceServer) CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)
func (*UnimplementedConversationalSearchServiceServer) CreateSession
func (*UnimplementedConversationalSearchServiceServer) CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
func (*UnimplementedConversationalSearchServiceServer) DeleteConversation
func (*UnimplementedConversationalSearchServiceServer) DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)
func (*UnimplementedConversationalSearchServiceServer) DeleteSession
func (*UnimplementedConversationalSearchServiceServer) DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)
func (*UnimplementedConversationalSearchServiceServer) GetAnswer
func (*UnimplementedConversationalSearchServiceServer) GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)
func (*UnimplementedConversationalSearchServiceServer) GetConversation
func (*UnimplementedConversationalSearchServiceServer) GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)
func (*UnimplementedConversationalSearchServiceServer) GetSession
func (*UnimplementedConversationalSearchServiceServer) GetSession(context.Context, *GetSessionRequest) (*Session, error)
func (*UnimplementedConversationalSearchServiceServer) ListConversations
func (*UnimplementedConversationalSearchServiceServer) ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
func (*UnimplementedConversationalSearchServiceServer) ListSessions
func (*UnimplementedConversationalSearchServiceServer) ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
func (*UnimplementedConversationalSearchServiceServer) UpdateConversation
func (*UnimplementedConversationalSearchServiceServer) UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)
func (*UnimplementedConversationalSearchServiceServer) UpdateSession
func (*UnimplementedConversationalSearchServiceServer) UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)
UnimplementedDataStoreServiceServer
type UnimplementedDataStoreServiceServer struct {
}
UnimplementedDataStoreServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedDataStoreServiceServer) CreateDataStore
func (*UnimplementedDataStoreServiceServer) CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)
func (*UnimplementedDataStoreServiceServer) DeleteDataStore
func (*UnimplementedDataStoreServiceServer) DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)
func (*UnimplementedDataStoreServiceServer) GetDataStore
func (*UnimplementedDataStoreServiceServer) GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)
func (*UnimplementedDataStoreServiceServer) ListDataStores
func (*UnimplementedDataStoreServiceServer) ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)
func (*UnimplementedDataStoreServiceServer) UpdateDataStore
func (*UnimplementedDataStoreServiceServer) UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)
UnimplementedDocumentServiceServer
type UnimplementedDocumentServiceServer struct {
}
UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedDocumentServiceServer) CreateDocument
func (*UnimplementedDocumentServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
func (*UnimplementedDocumentServiceServer) DeleteDocument
func (*UnimplementedDocumentServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
func (*UnimplementedDocumentServiceServer) GetDocument
func (*UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
func (*UnimplementedDocumentServiceServer) ImportDocuments
func (*UnimplementedDocumentServiceServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
func (*UnimplementedDocumentServiceServer) ListDocuments
func (*UnimplementedDocumentServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
func (*UnimplementedDocumentServiceServer) PurgeDocuments
func (*UnimplementedDocumentServiceServer) PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
func (*UnimplementedDocumentServiceServer) UpdateDocument
func (*UnimplementedDocumentServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
UnimplementedEngineServiceServer
type UnimplementedEngineServiceServer struct {
}
UnimplementedEngineServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedEngineServiceServer) CreateEngine
func (*UnimplementedEngineServiceServer) CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)
func (*UnimplementedEngineServiceServer) DeleteEngine
func (*UnimplementedEngineServiceServer) DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)
func (*UnimplementedEngineServiceServer) GetEngine
func (*UnimplementedEngineServiceServer) GetEngine(context.Context, *GetEngineRequest) (*Engine, error)
func (*UnimplementedEngineServiceServer) ListEngines
func (*UnimplementedEngineServiceServer) ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)
func (*UnimplementedEngineServiceServer) PauseEngine
func (*UnimplementedEngineServiceServer) PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)
func (*UnimplementedEngineServiceServer) ResumeEngine
func (*UnimplementedEngineServiceServer) ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)
func (*UnimplementedEngineServiceServer) TuneEngine
func (*UnimplementedEngineServiceServer) TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)
func (*UnimplementedEngineServiceServer) UpdateEngine
func (*UnimplementedEngineServiceServer) UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)
UnimplementedGroundedGenerationServiceServer
type UnimplementedGroundedGenerationServiceServer struct {
}
UnimplementedGroundedGenerationServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedGroundedGenerationServiceServer) CheckGrounding
func (*UnimplementedGroundedGenerationServiceServer) CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
UnimplementedRankServiceServer
type UnimplementedRankServiceServer struct {
}
UnimplementedRankServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedRankServiceServer) Rank
func (*UnimplementedRankServiceServer) Rank(context.Context, *RankRequest) (*RankResponse, error)
UnimplementedRecommendationServiceServer
type UnimplementedRecommendationServiceServer struct {
}
UnimplementedRecommendationServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedRecommendationServiceServer) Recommend
func (*UnimplementedRecommendationServiceServer) Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)
UnimplementedSchemaServiceServer
type UnimplementedSchemaServiceServer struct {
}
UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedSchemaServiceServer) CreateSchema
func (*UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSchemaServiceServer) DeleteSchema
func (*UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSchemaServiceServer) GetSchema
func (*UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)
func (*UnimplementedSchemaServiceServer) ListSchemas
func (*UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)
func (*UnimplementedSchemaServiceServer) UpdateSchema
func (*UnimplementedSchemaServiceServer) UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)
UnimplementedSearchServiceServer
type UnimplementedSearchServiceServer struct {
}
UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedSearchServiceServer) Search
func (*UnimplementedSearchServiceServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)
UnimplementedSearchTuningServiceServer
type UnimplementedSearchTuningServiceServer struct {
}
UnimplementedSearchTuningServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedSearchTuningServiceServer) TrainCustomModel
func (*UnimplementedSearchTuningServiceServer) TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
UnimplementedServingConfigServiceServer
type UnimplementedServingConfigServiceServer struct {
}
UnimplementedServingConfigServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedServingConfigServiceServer) GetServingConfig
func (*UnimplementedServingConfigServiceServer) GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)
func (*UnimplementedServingConfigServiceServer) ListServingConfigs
func (*UnimplementedServingConfigServiceServer) ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)
func (*UnimplementedServingConfigServiceServer) UpdateServingConfig
func (*UnimplementedServingConfigServiceServer) UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)
UnimplementedSiteSearchEngineServiceServer
type UnimplementedSiteSearchEngineServiceServer struct {
}
UnimplementedSiteSearchEngineServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites
func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites
func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites(context.Context, *BatchVerifyTargetSitesRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite
func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite
func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch
func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch(context.Context, *DisableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch
func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch(context.Context, *EnableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus
func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus(context.Context, *FetchDomainVerificationStatusRequest) (*FetchDomainVerificationStatusResponse, error)
func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine
func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)
func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite
func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)
func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites
func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)
func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris
func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris(context.Context, *RecrawlUrisRequest) (*longrunningpb.Operation, error)
func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite
func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)
UnimplementedUserEventServiceServer
type UnimplementedUserEventServiceServer struct {
}
UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedUserEventServiceServer) CollectUserEvent
func (*UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
func (*UnimplementedUserEventServiceServer) ImportUserEvents
func (*UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)
func (*UnimplementedUserEventServiceServer) WriteUserEvent
func (*UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
UpdateConversationRequest
type UpdateConversationRequest struct {
// Required. The Conversation to update.
Conversation *Conversation `protobuf:"bytes,1,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Indicates which fields in the provided
// [Conversation][google.cloud.discoveryengine.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
func (*UpdateConversationRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateConversationRequest.ProtoReflect.Descriptor instead.
func (*UpdateConversationRequest) GetConversation
func (x *UpdateConversationRequest) GetConversation() *Conversation
func (*UpdateConversationRequest) GetUpdateMask
func (x *UpdateConversationRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateConversationRequest) ProtoMessage
func (*UpdateConversationRequest) ProtoMessage()
func (*UpdateConversationRequest) ProtoReflect
func (x *UpdateConversationRequest) ProtoReflect() protoreflect.Message
func (*UpdateConversationRequest) Reset
func (x *UpdateConversationRequest) Reset()
func (*UpdateConversationRequest) String
func (x *UpdateConversationRequest) String() string
UpdateDataStoreRequest
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
func (*UpdateDataStoreRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDataStoreRequest.ProtoReflect.Descriptor instead.
func (*UpdateDataStoreRequest) GetDataStore
func (x *UpdateDataStoreRequest) GetDataStore() *DataStore
func (*UpdateDataStoreRequest) GetUpdateMask
func (x *UpdateDataStoreRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateDataStoreRequest) ProtoMessage
func (*UpdateDataStoreRequest) ProtoMessage()
func (*UpdateDataStoreRequest) ProtoReflect
func (x *UpdateDataStoreRequest) ProtoReflect() protoreflect.Message
func (*UpdateDataStoreRequest) Reset
func (x *UpdateDataStoreRequest) Reset()
func (*UpdateDataStoreRequest) String
func (x *UpdateDataStoreRequest) String() string
UpdateDocumentRequest
type UpdateDocumentRequest struct {
// Required. The document to update/create.
//
// If the caller does not have permission to update the
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
// does not exist and
// [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
// is not set, a `NOT_FOUND` error is returned.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// If set to true, and the
// [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
// new [Document][google.cloud.discoveryengine.v1beta.Document] will be
// created.
AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// Indicates which fields in the provided imported 'document' to update. If
// not set, will by default update all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.
func (*UpdateDocumentRequest) Descriptor
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
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
UpdateEngineRequest
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
func (*UpdateEngineRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateEngineRequest.ProtoReflect.Descriptor instead.
func (*UpdateEngineRequest) GetEngine
func (x *UpdateEngineRequest) GetEngine() *Engine
func (*UpdateEngineRequest) GetUpdateMask
func (x *UpdateEngineRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateEngineRequest) ProtoMessage
func (*UpdateEngineRequest) ProtoMessage()
func (*UpdateEngineRequest) ProtoReflect
func (x *UpdateEngineRequest) ProtoReflect() protoreflect.Message
func (*UpdateEngineRequest) Reset
func (x *UpdateEngineRequest) Reset()
func (*UpdateEngineRequest) String
func (x *UpdateEngineRequest) String() string
UpdateSchemaMetadata
type UpdateSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Metadata for UpdateSchema LRO.
func (*UpdateSchemaMetadata) Descriptor
func (*UpdateSchemaMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSchemaMetadata.ProtoReflect.Descriptor instead.
func (*UpdateSchemaMetadata) GetCreateTime
func (x *UpdateSchemaMetadata) GetCreateTime() *timestamppb.Timestamp
func (*UpdateSchemaMetadata) GetUpdateTime
func (x *UpdateSchemaMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*UpdateSchemaMetadata) ProtoMessage
func (*UpdateSchemaMetadata) ProtoMessage()
func (*UpdateSchemaMetadata) ProtoReflect
func (x *UpdateSchemaMetadata) ProtoReflect() protoreflect.Message
func (*UpdateSchemaMetadata) Reset
func (x *UpdateSchemaMetadata) Reset()
func (*UpdateSchemaMetadata) String
func (x *UpdateSchemaMetadata) String() string
UpdateSchemaRequest
type UpdateSchemaRequest struct {
// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
// update.
Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
// If set to true, and the
// [Schema][google.cloud.discoveryengine.v1beta.Schema] is not found, a new
// [Schema][google.cloud.discoveryengine.v1beta.Schema] will be created. In
// this situation, `update_mask` is ignored.
AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// contains filtered or unexported fields
}
Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.
func (*UpdateSchemaRequest) Descriptor
func (*UpdateSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSchemaRequest.ProtoReflect.Descriptor instead.
func (*UpdateSchemaRequest) GetAllowMissing
func (x *UpdateSchemaRequest) GetAllowMissing() bool
func (*UpdateSchemaRequest) GetSchema
func (x *UpdateSchemaRequest) GetSchema() *Schema
func (*UpdateSchemaRequest) ProtoMessage
func (*UpdateSchemaRequest) ProtoMessage()
func (*UpdateSchemaRequest) ProtoReflect
func (x *UpdateSchemaRequest) ProtoReflect() protoreflect.Message
func (*UpdateSchemaRequest) Reset
func (x *UpdateSchemaRequest) Reset()
func (*UpdateSchemaRequest) String
func (x *UpdateSchemaRequest) String() string
UpdateServingConfigRequest
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
func (*UpdateServingConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateServingConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateServingConfigRequest) GetServingConfig
func (x *UpdateServingConfigRequest) GetServingConfig() *ServingConfig
func (*UpdateServingConfigRequest) GetUpdateMask
func (x *UpdateServingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateServingConfigRequest) ProtoMessage
func (*UpdateServingConfigRequest) ProtoMessage()
func (*UpdateServingConfigRequest) ProtoReflect
func (x *UpdateServingConfigRequest) ProtoReflect() protoreflect.Message
func (*UpdateServingConfigRequest) Reset
func (x *UpdateServingConfigRequest) Reset()
func (*UpdateServingConfigRequest) String
func (x *UpdateServingConfigRequest) String() string
UpdateSessionRequest
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
func (*UpdateSessionRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSessionRequest.ProtoReflect.Descriptor instead.
func (*UpdateSessionRequest) GetSession
func (x *UpdateSessionRequest) GetSession() *Session
func (*UpdateSessionRequest) GetUpdateMask
func (x *UpdateSessionRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateSessionRequest) ProtoMessage
func (*UpdateSessionRequest) ProtoMessage()
func (*UpdateSessionRequest) ProtoReflect
func (x *UpdateSessionRequest) ProtoReflect() protoreflect.Message
func (*UpdateSessionRequest) Reset
func (x *UpdateSessionRequest) Reset()
func (*UpdateSessionRequest) String
func (x *UpdateSessionRequest) String() string
UpdateTargetSiteMetadata
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
func (*UpdateTargetSiteMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*UpdateTargetSiteMetadata) GetCreateTime
func (x *UpdateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestamp
func (*UpdateTargetSiteMetadata) GetUpdateTime
func (x *UpdateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*UpdateTargetSiteMetadata) ProtoMessage
func (*UpdateTargetSiteMetadata) ProtoMessage()
func (*UpdateTargetSiteMetadata) ProtoReflect
func (x *UpdateTargetSiteMetadata) ProtoReflect() protoreflect.Message
func (*UpdateTargetSiteMetadata) Reset
func (x *UpdateTargetSiteMetadata) Reset()
func (*UpdateTargetSiteMetadata) String
func (x *UpdateTargetSiteMetadata) String() string
UpdateTargetSiteRequest
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
func (*UpdateTargetSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*UpdateTargetSiteRequest) GetTargetSite
func (x *UpdateTargetSiteRequest) GetTargetSite() *TargetSite
func (*UpdateTargetSiteRequest) ProtoMessage
func (*UpdateTargetSiteRequest) ProtoMessage()
func (*UpdateTargetSiteRequest) ProtoReflect
func (x *UpdateTargetSiteRequest) ProtoReflect() protoreflect.Message
func (*UpdateTargetSiteRequest) Reset
func (x *UpdateTargetSiteRequest) Reset()
func (*UpdateTargetSiteRequest) String
func (x *UpdateTargetSiteRequest) String() string
UserEvent
type UserEvent struct {
EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
UserPseudoId string `protobuf:"bytes,2,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
UserInfo *UserInfo `protobuf:"bytes,4,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
DirectUserRequest bool `protobuf:"varint,5,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
SessionId string `protobuf:"bytes,6,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
PageInfo *PageInfo `protobuf:"bytes,7,opt,name=page_info,json=pageInfo,proto3" json:"page_info,omitempty"`
AttributionToken string `protobuf:"bytes,8,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
Documents []*DocumentInfo `protobuf:"bytes,10,rep,name=documents,proto3" json:"documents,omitempty"`
Panel *PanelInfo `protobuf:"bytes,11,opt,name=panel,proto3" json:"panel,omitempty"`
SearchInfo *SearchInfo `protobuf:"bytes,12,opt,name=search_info,json=searchInfo,proto3" json:"search_info,omitempty"`
CompletionInfo *CompletionInfo `protobuf:"bytes,13,opt,name=completion_info,json=completionInfo,proto3" json:"completion_info,omitempty"`
TransactionInfo *TransactionInfo `protobuf:"bytes,14,opt,name=transaction_info,json=transactionInfo,proto3" json:"transaction_info,omitempty"`
TagIds []string `protobuf:"bytes,15,rep,name=tag_ids,json=tagIds,proto3" json:"tag_ids,omitempty"`
PromotionIds []string `protobuf:"bytes,16,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
Attributes map[string]*CustomAttribute "" /* 162 byte string literal not displayed */
MediaInfo *MediaInfo `protobuf:"bytes,18,opt,name=media_info,json=mediaInfo,proto3" json:"media_info,omitempty"`
}
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
func (*UserEvent) Descriptor
Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.
func (*UserEvent) GetAttributes
func (x *UserEvent) GetAttributes() map[string]*CustomAttribute
func (*UserEvent) GetAttributionToken
func (*UserEvent) GetCompletionInfo
func (x *UserEvent) GetCompletionInfo() *CompletionInfo
func (*UserEvent) GetDirectUserRequest
func (*UserEvent) GetDocuments
func (x *UserEvent) GetDocuments() []*DocumentInfo
func (*UserEvent) GetEventTime
func (x *UserEvent) GetEventTime() *timestamppb.Timestamp
func (*UserEvent) GetEventType
func (*UserEvent) GetFilter
func (*UserEvent) GetMediaInfo
func (*UserEvent) GetPageInfo
func (*UserEvent) GetPanel
func (*UserEvent) GetPromotionIds
func (*UserEvent) GetSearchInfo
func (x *UserEvent) GetSearchInfo() *SearchInfo
func (*UserEvent) GetSessionId
func (*UserEvent) GetTagIds
func (*UserEvent) GetTransactionInfo
func (x *UserEvent) GetTransactionInfo() *TransactionInfo
func (*UserEvent) GetUserInfo
func (*UserEvent) GetUserPseudoId
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
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)
// 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
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)
// 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.
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: Use UserInfo.ProtoReflect.Descriptor instead.
func (*UserInfo) GetUserAgent
func (*UserInfo) GetUserId
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
WriteUserEventRequest
type WriteUserEventRequest struct {
// Required. The parent DataStore resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User event to write.
UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3,oneof" json:"user_event,omitempty"`
// contains filtered or unexported fields
}
Request message for WriteUserEvent method.
func (*WriteUserEventRequest) Descriptor
func (*WriteUserEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.
func (*WriteUserEventRequest) GetParent
func (x *WriteUserEventRequest) GetParent() string
func (*WriteUserEventRequest) GetUserEvent
func (x *WriteUserEventRequest) GetUserEvent() *UserEvent
func (*WriteUserEventRequest) ProtoMessage
func (*WriteUserEventRequest) ProtoMessage()
func (*WriteUserEventRequest) ProtoReflect
func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Message
func (*WriteUserEventRequest) Reset
func (x *WriteUserEventRequest) Reset()
func (*WriteUserEventRequest) String
func (x *WriteUserEventRequest) String() string