Package cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb (v1.17.1)

Variables

Answer_State_name, Answer_State_value

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

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",
		5: "NO_RELEVANT_CONTENT",
		6: "JAIL_BREAKING_QUERY_IGNORED",
		7: "CUSTOMER_POLICY_VIOLATION",
		8: "NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
		9: "LOW_GROUNDED_ANSWER",
	}
	Answer_AnswerSkippedReason_value = map[string]int32{
		"ANSWER_SKIPPED_REASON_UNSPECIFIED":   0,
		"ADVERSARIAL_QUERY_IGNORED":           1,
		"NON_ANSWER_SEEKING_QUERY_IGNORED":    2,
		"OUT_OF_DOMAIN_QUERY_IGNORED":         3,
		"POTENTIAL_POLICY_VIOLATION":          4,
		"NO_RELEVANT_CONTENT":                 5,
		"JAIL_BREAKING_QUERY_IGNORED":         6,
		"CUSTOMER_POLICY_VIOLATION":           7,
		"NON_ANSWER_SEEKING_QUERY_IGNORED_V2": 8,
		"LOW_GROUNDED_ANSWER":                 9,
	}
)

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

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.

SearchUseCase_name, SearchUseCase_value

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

Enum value maps for SearchUseCase.

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.

Control_BoostAction_InterpolationBoostSpec_AttributeType_name, Control_BoostAction_InterpolationBoostSpec_AttributeType_value

var (
	Control_BoostAction_InterpolationBoostSpec_AttributeType_name = map[int32]string{
		0: "ATTRIBUTE_TYPE_UNSPECIFIED",
		1: "NUMERICAL",
		2: "FRESHNESS",
	}
	Control_BoostAction_InterpolationBoostSpec_AttributeType_value = map[string]int32{
		"ATTRIBUTE_TYPE_UNSPECIFIED": 0,
		"NUMERICAL":                  1,
		"FRESHNESS":                  2,
	}
)

Enum value maps for Control_BoostAction_InterpolationBoostSpec_AttributeType.

Control_BoostAction_InterpolationBoostSpec_InterpolationType_name, Control_BoostAction_InterpolationBoostSpec_InterpolationType_value

var (
	Control_BoostAction_InterpolationBoostSpec_InterpolationType_name = map[int32]string{
		0: "INTERPOLATION_TYPE_UNSPECIFIED",
		1: "LINEAR",
	}
	Control_BoostAction_InterpolationBoostSpec_InterpolationType_value = map[string]int32{
		"INTERPOLATION_TYPE_UNSPECIFIED": 0,
		"LINEAR":                         1,
	}
)

Enum value maps for Control_BoostAction_InterpolationBoostSpec_InterpolationType.

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_SafetySpec_SafetySetting_HarmBlockThreshold_name, AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_value

var (
	AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_name = map[int32]string{
		0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
		1: "BLOCK_LOW_AND_ABOVE",
		2: "BLOCK_MEDIUM_AND_ABOVE",
		3: "BLOCK_ONLY_HIGH",
		4: "BLOCK_NONE",
		5: "OFF",
	}
	AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_value = map[string]int32{
		"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
		"BLOCK_LOW_AND_ABOVE":              1,
		"BLOCK_MEDIUM_AND_ABOVE":           2,
		"BLOCK_ONLY_HIGH":                  3,
		"BLOCK_NONE":                       4,
		"OFF":                              5,
	}
)

Enum value maps for AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold.

AnswerQueryRequest_GroundingSpec_FilteringLevel_name, AnswerQueryRequest_GroundingSpec_FilteringLevel_value

var (
	AnswerQueryRequest_GroundingSpec_FilteringLevel_name = map[int32]string{
		0: "FILTERING_LEVEL_UNSPECIFIED",
		1: "FILTERING_LEVEL_LOW",
		2: "FILTERING_LEVEL_HIGH",
	}
	AnswerQueryRequest_GroundingSpec_FilteringLevel_value = map[string]int32{
		"FILTERING_LEVEL_UNSPECIFIED": 0,
		"FILTERING_LEVEL_LOW":         1,
		"FILTERING_LEVEL_HIGH":        2,
	}
)

Enum value maps for AnswerQueryRequest_GroundingSpec_FilteringLevel.

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

Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.

AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_name, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_value

var (
	AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_name = map[int32]string{
		0: "MODEL_TYPE_UNSPECIFIED",
		1: "SMALL",
		2: "LARGE",
	}
	AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_value = map[string]int32{
		"MODEL_TYPE_UNSPECIFIED": 0,
		"SMALL":                  1,
		"LARGE":                  2,
	}
)

Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType.

CustomTuningModel_ModelState_name, CustomTuningModel_ModelState_value

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

Enum value maps for CustomTuningModel_ModelState.

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",
		4: "GOOGLE_WORKSPACE",
	}
	DataStore_ContentConfig_value = map[string]int32{
		"CONTENT_CONFIG_UNSPECIFIED": 0,
		"NO_CONTENT":                 1,
		"CONTENT_REQUIRED":           2,
		"PUBLIC_WEBSITE":             3,
		"GOOGLE_WORKSPACE":           4,
	}
)

Enum value maps for DataStore_ContentConfig.

WorkspaceConfig_Type_name, WorkspaceConfig_Type_value

var (
	WorkspaceConfig_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "GOOGLE_DRIVE",
		2: "GOOGLE_MAIL",
		3: "GOOGLE_SITES",
		4: "GOOGLE_CALENDAR",
		5: "GOOGLE_CHAT",
		6: "GOOGLE_GROUPS",
		7: "GOOGLE_KEEP",
		8: "GOOGLE_PEOPLE",
	}
	WorkspaceConfig_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"GOOGLE_DRIVE":     1,
		"GOOGLE_MAIL":      2,
		"GOOGLE_SITES":     3,
		"GOOGLE_CALENDAR":  4,
		"GOOGLE_CHAT":      5,
		"GOOGLE_GROUPS":    6,
		"GOOGLE_KEEP":      7,
		"GOOGLE_PEOPLE":    8,
	}
)

Enum value maps for WorkspaceConfig_Type.

BatchGetDocumentsMetadataResponse_State_name, BatchGetDocumentsMetadataResponse_State_value

var (
	BatchGetDocumentsMetadataResponse_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "INDEXED",
		2: "NOT_IN_TARGET_SITE",
		3: "NOT_IN_INDEX",
	}
	BatchGetDocumentsMetadataResponse_State_value = map[string]int32{
		"STATE_UNSPECIFIED":  0,
		"INDEXED":            1,
		"NOT_IN_TARGET_SITE": 2,
		"NOT_IN_INDEX":       3,
	}
)

Enum value maps for BatchGetDocumentsMetadataResponse_State.

GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_name, GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_value

var (
	GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_name = map[int32]string{
		0: "VERSION_UNSPECIFIED",
		1: "V1_INDEPENDENT",
	}
	GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_value = map[string]int32{
		"VERSION_UNSPECIFIED": 0,
		"V1_INDEPENDENT":      1,
	}
)

Enum value maps for GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version.

GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_name, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_value

var (
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_name = map[int32]string{
		0: "SOURCE_UNSPECIFIED",
		1: "VERTEX_AI_SEARCH",
		3: "GOOGLE_SEARCH",
		2: "INLINE_CONTENT",
		4: "GOOGLE_MAPS",
	}
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_value = map[string]int32{
		"SOURCE_UNSPECIFIED": 0,
		"VERTEX_AI_SEARCH":   1,
		"GOOGLE_SEARCH":      3,
		"INLINE_CONTENT":     2,
		"GOOGLE_MAPS":        4,
	}
)

Enum value maps for GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source.

GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_name, GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_value

var (
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_name = map[int32]string{
		0: "VERSION_UNSPECIFIED",
		1: "V1_INDEPENDENT",
	}
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_value = map[string]int32{
		"VERSION_UNSPECIFIED": 0,
		"V1_INDEPENDENT":      1,
	}
)

Enum value maps for GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version.

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.

Project_ServiceTerms_State_name, Project_ServiceTerms_State_value

var (
	Project_ServiceTerms_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "TERMS_ACCEPTED",
		2: "TERMS_PENDING",
		3: "TERMS_DECLINED",
	}
	Project_ServiceTerms_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"TERMS_ACCEPTED":    1,
		"TERMS_PENDING":     2,
		"TERMS_DECLINED":    3,
	}
)

Enum value maps for Project_ServiceTerms_State.

HarmCategory_name, HarmCategory_value

var (
	HarmCategory_name = map[int32]string{
		0: "HARM_CATEGORY_UNSPECIFIED",
		1: "HARM_CATEGORY_HATE_SPEECH",
		2: "HARM_CATEGORY_DANGEROUS_CONTENT",
		3: "HARM_CATEGORY_HARASSMENT",
		4: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
		5: "HARM_CATEGORY_CIVIC_INTEGRITY",
	}
	HarmCategory_value = map[string]int32{
		"HARM_CATEGORY_UNSPECIFIED":       0,
		"HARM_CATEGORY_HATE_SPEECH":       1,
		"HARM_CATEGORY_DANGEROUS_CONTENT": 2,
		"HARM_CATEGORY_HARASSMENT":        3,
		"HARM_CATEGORY_SEXUALLY_EXPLICIT": 4,
		"HARM_CATEGORY_CIVIC_INTEGRITY":   5,
	}
)

Enum value maps for HarmCategory.

SafetyRating_HarmProbability_name, SafetyRating_HarmProbability_value

var (
	SafetyRating_HarmProbability_name = map[int32]string{
		0: "HARM_PROBABILITY_UNSPECIFIED",
		1: "NEGLIGIBLE",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
	}
	SafetyRating_HarmProbability_value = map[string]int32{
		"HARM_PROBABILITY_UNSPECIFIED": 0,
		"NEGLIGIBLE":                   1,
		"LOW":                          2,
		"MEDIUM":                       3,
		"HIGH":                         4,
	}
)

Enum value maps for SafetyRating_HarmProbability.

SafetyRating_HarmSeverity_name, SafetyRating_HarmSeverity_value

var (
	SafetyRating_HarmSeverity_name = map[int32]string{
		0: "HARM_SEVERITY_UNSPECIFIED",
		1: "HARM_SEVERITY_NEGLIGIBLE",
		2: "HARM_SEVERITY_LOW",
		3: "HARM_SEVERITY_MEDIUM",
		4: "HARM_SEVERITY_HIGH",
	}
	SafetyRating_HarmSeverity_value = map[string]int32{
		"HARM_SEVERITY_UNSPECIFIED": 0,
		"HARM_SEVERITY_NEGLIGIBLE":  1,
		"HARM_SEVERITY_LOW":         2,
		"HARM_SEVERITY_MEDIUM":      3,
		"HARM_SEVERITY_HIGH":        4,
	}
)

Enum value maps for SafetyRating_HarmSeverity.

SearchRequest_RelevanceThreshold_name, SearchRequest_RelevanceThreshold_value

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

Enum value maps for SearchRequest_RelevanceThreshold.

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.

SearchRequest_ContentSearchSpec_SearchResultMode_name, SearchRequest_ContentSearchSpec_SearchResultMode_value

var (
	SearchRequest_ContentSearchSpec_SearchResultMode_name = map[int32]string{
		0: "SEARCH_RESULT_MODE_UNSPECIFIED",
		1: "DOCUMENTS",
		2: "CHUNKS",
	}
	SearchRequest_ContentSearchSpec_SearchResultMode_value = map[string]int32{
		"SEARCH_RESULT_MODE_UNSPECIFIED": 0,
		"DOCUMENTS":                      1,
		"CHUNKS":                         2,
	}
)

Enum value maps for SearchRequest_ContentSearchSpec_SearchResultMode.

SearchRequest_SearchAsYouTypeSpec_Condition_name, SearchRequest_SearchAsYouTypeSpec_Condition_value

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

Enum value maps for SearchRequest_SearchAsYouTypeSpec_Condition.

SearchRequest_DisplaySpec_MatchHighlightingCondition_name, SearchRequest_DisplaySpec_MatchHighlightingCondition_value

var (
	SearchRequest_DisplaySpec_MatchHighlightingCondition_name = map[int32]string{
		0: "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
		1: "MATCH_HIGHLIGHTING_DISABLED",
		2: "MATCH_HIGHLIGHTING_ENABLED",
	}
	SearchRequest_DisplaySpec_MatchHighlightingCondition_value = map[string]int32{
		"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED": 0,
		"MATCH_HIGHLIGHTING_DISABLED":              1,
		"MATCH_HIGHLIGHTING_ENABLED":               2,
	}
)

Enum value maps for SearchRequest_DisplaySpec_MatchHighlightingCondition.

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",
		6:  "NO_RELEVANT_CONTENT",
		7:  "JAIL_BREAKING_QUERY_IGNORED",
		8:  "CUSTOMER_POLICY_VIOLATION",
		9:  "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2",
		10: "TIME_OUT",
	}
	SearchResponse_Summary_SummarySkippedReason_value = map[string]int32{
		"SUMMARY_SKIPPED_REASON_UNSPECIFIED":   0,
		"ADVERSARIAL_QUERY_IGNORED":            1,
		"NON_SUMMARY_SEEKING_QUERY_IGNORED":    2,
		"OUT_OF_DOMAIN_QUERY_IGNORED":          3,
		"POTENTIAL_POLICY_VIOLATION":           4,
		"LLM_ADDON_NOT_ENABLED":                5,
		"NO_RELEVANT_CONTENT":                  6,
		"JAIL_BREAKING_QUERY_IGNORED":          7,
		"CUSTOMER_POLICY_VIOLATION":            8,
		"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2": 9,
		"TIME_OUT":                             10,
	}
)

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_v1_answer_proto

var File_google_cloud_discoveryengine_v1_answer_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_chunk_proto

var File_google_cloud_discoveryengine_v1_chunk_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_common_proto

var File_google_cloud_discoveryengine_v1_common_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_completion_proto

var File_google_cloud_discoveryengine_v1_completion_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_completion_service_proto

var File_google_cloud_discoveryengine_v1_completion_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_control_proto

var File_google_cloud_discoveryengine_v1_control_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_control_service_proto

var File_google_cloud_discoveryengine_v1_control_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_conversation_proto

var File_google_cloud_discoveryengine_v1_conversation_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_conversational_search_service_proto

var File_google_cloud_discoveryengine_v1_conversational_search_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_custom_tuning_model_proto

var File_google_cloud_discoveryengine_v1_custom_tuning_model_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_data_store_proto

var File_google_cloud_discoveryengine_v1_data_store_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_data_store_service_proto

var File_google_cloud_discoveryengine_v1_data_store_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_document_processing_config_proto

var File_google_cloud_discoveryengine_v1_document_processing_config_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_document_proto

var File_google_cloud_discoveryengine_v1_document_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_document_service_proto

var File_google_cloud_discoveryengine_v1_document_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_engine_proto

var File_google_cloud_discoveryengine_v1_engine_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_engine_service_proto

var File_google_cloud_discoveryengine_v1_engine_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_grounded_generation_service_proto

var File_google_cloud_discoveryengine_v1_grounded_generation_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_grounding_proto

var File_google_cloud_discoveryengine_v1_grounding_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_import_config_proto

var File_google_cloud_discoveryengine_v1_import_config_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_project_proto

var File_google_cloud_discoveryengine_v1_project_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_project_service_proto

var File_google_cloud_discoveryengine_v1_project_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_purge_config_proto

var File_google_cloud_discoveryengine_v1_purge_config_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_rank_service_proto

var File_google_cloud_discoveryengine_v1_rank_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_recommendation_service_proto

var File_google_cloud_discoveryengine_v1_recommendation_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_safety_proto

var File_google_cloud_discoveryengine_v1_safety_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_schema_proto

var File_google_cloud_discoveryengine_v1_schema_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_schema_service_proto

var File_google_cloud_discoveryengine_v1_schema_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_search_service_proto

var File_google_cloud_discoveryengine_v1_search_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_search_tuning_service_proto

var File_google_cloud_discoveryengine_v1_search_tuning_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_serving_config_proto

var File_google_cloud_discoveryengine_v1_serving_config_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_serving_config_service_proto

var File_google_cloud_discoveryengine_v1_serving_config_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_session_proto

var File_google_cloud_discoveryengine_v1_session_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_site_search_engine_proto

var File_google_cloud_discoveryengine_v1_site_search_engine_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_site_search_engine_service_proto

var File_google_cloud_discoveryengine_v1_site_search_engine_service_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_user_event_proto

var File_google_cloud_discoveryengine_v1_user_event_proto protoreflect.FileDescriptor

File_google_cloud_discoveryengine_v1_user_event_service_proto

var File_google_cloud_discoveryengine_v1_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterCompletionServiceServer

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

func RegisterControlServiceServer

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

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 RegisterProjectServiceServer

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

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)

AdvancedSiteSearchConfig

type AdvancedSiteSearchConfig struct {

	// If set true, initial indexing is disabled for the DataStore.
	DisableInitialIndex *bool `protobuf:"varint,3,opt,name=disable_initial_index,json=disableInitialIndex,proto3,oneof" json:"disable_initial_index,omitempty"`
	// If set true, automatic refresh is disabled for the DataStore.
	DisableAutomaticRefresh *bool `protobuf:"varint,4,opt,name=disable_automatic_refresh,json=disableAutomaticRefresh,proto3,oneof" json:"disable_automatic_refresh,omitempty"`
	// contains filtered or unexported fields
}

Configuration data for advance site search.

func (*AdvancedSiteSearchConfig) Descriptor

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

Deprecated: Use AdvancedSiteSearchConfig.ProtoReflect.Descriptor instead.

func (*AdvancedSiteSearchConfig) GetDisableAutomaticRefresh

func (x *AdvancedSiteSearchConfig) GetDisableAutomaticRefresh() bool

func (*AdvancedSiteSearchConfig) GetDisableInitialIndex

func (x *AdvancedSiteSearchConfig) GetDisableInitialIndex() bool

func (*AdvancedSiteSearchConfig) ProtoMessage

func (*AdvancedSiteSearchConfig) ProtoMessage()

func (*AdvancedSiteSearchConfig) ProtoReflect

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

func (*AdvancedSiteSearchConfig) Reset

func (x *AdvancedSiteSearchConfig) Reset()

func (*AdvancedSiteSearchConfig) String

func (x *AdvancedSiteSearchConfig) String() string

AlloyDbSource

type AlloyDbSource struct {

	// The project ID that contains the AlloyDB source.
	// Has a length limit of 128 characters. If not specified, inherits the
	// project ID from the parent request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The AlloyDB location to copy the data from with a length limit of
	// 256 characters.
	LocationId string `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// Required. The AlloyDB cluster to copy the data from with a length limit of
	// 256 characters.
	ClusterId string `protobuf:"bytes,3,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
	// Required. The AlloyDB database to copy the data from with a length limit of
	// 256 characters.
	DatabaseId string `protobuf:"bytes,4,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The AlloyDB table to copy the data from with a length limit of
	// 256 characters.
	TableId string `protobuf:"bytes,5,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// AlloyDB export to a specific Cloud Storage directory.
	//
	// Ensure that the AlloyDB service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,6,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// contains filtered or unexported fields
}

AlloyDB source import data from.

func (*AlloyDbSource) Descriptor

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

Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.

func (*AlloyDbSource) GetClusterId

func (x *AlloyDbSource) GetClusterId() string

func (*AlloyDbSource) GetDatabaseId

func (x *AlloyDbSource) GetDatabaseId() string

func (*AlloyDbSource) GetGcsStagingDir

func (x *AlloyDbSource) GetGcsStagingDir() string

func (*AlloyDbSource) GetLocationId

func (x *AlloyDbSource) GetLocationId() string

func (*AlloyDbSource) GetProjectId

func (x *AlloyDbSource) GetProjectId() string

func (*AlloyDbSource) GetTableId

func (x *AlloyDbSource) GetTableId() string

func (*AlloyDbSource) ProtoMessage

func (*AlloyDbSource) ProtoMessage()

func (*AlloyDbSource) ProtoReflect

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

func (*AlloyDbSource) Reset

func (x *AlloyDbSource) Reset()

func (*AlloyDbSource) String

func (x *AlloyDbSource) String() string

Answer

type Answer struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the answer generation.
	State Answer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.Answer_State" json:"state,omitempty"`
	// The textual answer.
	AnswerText string `protobuf:"bytes,3,opt,name=answer_text,json=answerText,proto3" json:"answer_text,omitempty"`
	// A score in the range of [0, 1] describing how grounded the answer is by the
	// reference chunks.
	GroundingScore *float64 `protobuf:"fixed64,12,opt,name=grounding_score,json=groundingScore,proto3,oneof" json:"grounding_score,omitempty"`
	// Citations.
	Citations []*Answer_Citation `protobuf:"bytes,4,rep,name=citations,proto3" json:"citations,omitempty"`
	// Optional. Grounding supports.
	GroundingSupports []*Answer_GroundingSupport `protobuf:"bytes,13,rep,name=grounding_supports,json=groundingSupports,proto3" json:"grounding_supports,omitempty"`
	// References.
	References []*Answer_Reference `protobuf:"bytes,5,rep,name=references,proto3" json:"references,omitempty"`
	// Suggested related questions.
	RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
	// Answer generation steps.
	Steps []*Answer_Step `protobuf:"bytes,7,rep,name=steps,proto3" json:"steps,omitempty"`
	// Query understanding information.
	QueryUnderstandingInfo *Answer_QueryUnderstandingInfo `protobuf:"bytes,10,opt,name=query_understanding_info,json=queryUnderstandingInfo,proto3" json:"query_understanding_info,omitempty"`
	// Additional answer-skipped reasons. This provides the reason for ignored
	// cases. If nothing is skipped, this field is not set.
	AnswerSkippedReasons []Answer_AnswerSkippedReason `protobuf:"varint,11,rep,packed,name=answer_skipped_reasons,json=answerSkippedReasons,proto3,enum=google.cloud.discoveryengine.v1.Answer_AnswerSkippedReason" json:"answer_skipped_reasons,omitempty"`
	// Output only. Answer creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Answer completed timestamp.
	CompleteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
	// Optional. Safety ratings.
	SafetyRatings []*SafetyRating `protobuf:"bytes,14,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// contains filtered or unexported fields
}

Defines an answer.

func (*Answer) Descriptor

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

Deprecated: Use Answer.ProtoReflect.Descriptor instead.

func (*Answer) GetAnswerSkippedReasons

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

func (*Answer) GetAnswerText

func (x *Answer) GetAnswerText() string

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) GetGroundingScore

func (x *Answer) GetGroundingScore() float64

func (*Answer) GetGroundingSupports

func (x *Answer) GetGroundingSupports() []*Answer_GroundingSupport

func (*Answer) GetName

func (x *Answer) GetName() string

func (*Answer) GetQueryUnderstandingInfo

func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfo

func (*Answer) GetReferences

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

func (*Answer) GetRelatedQuestions

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

func (*Answer) GetSafetyRatings

func (x *Answer) GetSafetyRatings() []*SafetyRating

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

func (x *Answer) String() string

AnswerQueryRequest

type AnswerQueryRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
	// or
	// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
	// This field is used to identify the serving configuration name, set
	// of models used to make the search.
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. Current user query.
	Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The session resource name. Not required.
	//
	// When session field is not set, the API is in sessionless mode.
	//
	// We support auto session mode: users can use the wildcard symbol `-` as
	// session ID.  A new ID will be automatically generated and assigned.
	Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
	// Model specification.
	SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
	// Related questions specification.
	RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
	// Optional. Grounding specification.
	GroundingSpec *AnswerQueryRequest_GroundingSpec `protobuf:"bytes,6,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
	// Answer generation specification.
	AnswerGenerationSpec *AnswerQueryRequest_AnswerGenerationSpec `protobuf:"bytes,7,opt,name=answer_generation_spec,json=answerGenerationSpec,proto3" json:"answer_generation_spec,omitempty"`
	// Search specification.
	SearchSpec *AnswerQueryRequest_SearchSpec `protobuf:"bytes,8,opt,name=search_spec,json=searchSpec,proto3" json:"search_spec,omitempty"`
	// Query understanding specification.
	QueryUnderstandingSpec *AnswerQueryRequest_QueryUnderstandingSpec `protobuf:"bytes,9,opt,name=query_understanding_spec,json=queryUnderstandingSpec,proto3" json:"query_understanding_spec,omitempty"`
	// Deprecated: This field is deprecated. Streaming Answer API will be
	// supported.
	//
	// Asynchronous mode control.
	//
	// If enabled, the response will be returned with answer/session resource
	// name without final answer. The API users need to do the polling to get
	// the latest status of answer/session by calling
	// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer]
	// or
	// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
	// method.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/conversational_search_service.proto.
	AsynchronousMode bool `protobuf:"varint,10,opt,name=asynchronous_mode,json=asynchronousMode,proto3" json:"asynchronous_mode,omitempty"`
	// A unique identifier for tracking visitors. For example, this could be
	// implemented with an HTTP cookie, which should be able to uniquely identify
	// a visitor on a single device. This unique identifier should not change if
	// the visitor logs in or out of the website.
	//
	// This field should NOT have a fixed value such as `unknown_visitor`.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
	UserPseudoId string `protobuf:"bytes,12,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,13,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Optional. End user specification.
	EndUserSpec *AnswerQueryRequest_EndUserSpec `protobuf:"bytes,14,opt,name=end_user_spec,json=endUserSpec,proto3" json:"end_user_spec,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.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

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/conversational_search_service.proto.

func (*AnswerQueryRequest) GetEndUserSpec

func (*AnswerQueryRequest) GetGroundingSpec

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 (*AnswerQueryRequest) GetSearchSpec

func (*AnswerQueryRequest) GetServingConfig

func (x *AnswerQueryRequest) GetServingConfig() string

func (*AnswerQueryRequest) GetSession

func (x *AnswerQueryRequest) GetSession() string

func (*AnswerQueryRequest) GetUserLabels

func (x *AnswerQueryRequest) GetUserLabels() map[string]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 {

	// Answer generation model specification.
	ModelSpec *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec `protobuf:"bytes,1,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
	// Answer generation prompt specification.
	PromptSpec *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec `protobuf:"bytes,2,opt,name=prompt_spec,json=promptSpec,proto3" json:"prompt_spec,omitempty"`
	// Specifies whether to include citation metadata in the answer. The default
	// value is `false`.
	IncludeCitations bool `protobuf:"varint,3,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
	// Language code for Answer. Use language tags defined by
	// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
	// Note: This is an experimental feature.
	AnswerLanguageCode string `protobuf:"bytes,4,opt,name=answer_language_code,json=answerLanguageCode,proto3" json:"answer_language_code,omitempty"`
	// Specifies whether to filter out adversarial queries. The default value
	// is `false`.
	//
	// Google employs search-query classification to detect adversarial
	// queries. No answer is returned if the search query is classified as an
	// adversarial query. For example, a user might ask a question regarding
	// negative comments about the company or submit a query designed to
	// generate unsafe, policy-violating output. If this field is set to
	// `true`, we skip generating answers for adversarial queries and return
	// fallback messages instead.
	IgnoreAdversarialQuery bool `protobuf:"varint,5,opt,name=ignore_adversarial_query,json=ignoreAdversarialQuery,proto3" json:"ignore_adversarial_query,omitempty"`
	// Specifies whether to filter out queries that are not answer-seeking.
	// The default value is `false`.
	//
	// Google employs search-query classification to detect answer-seeking
	// queries. No answer is returned if the search query is classified as a
	// non-answer seeking query. If this field is set to `true`, we skip
	// generating answers for non-answer seeking queries and return
	// fallback messages instead.
	IgnoreNonAnswerSeekingQuery bool `protobuf:"varint,6,opt,name=ignore_non_answer_seeking_query,json=ignoreNonAnswerSeekingQuery,proto3" json:"ignore_non_answer_seeking_query,omitempty"`
	// Specifies whether to filter out queries that have low relevance.
	//
	// If this field is set to `false`, all search results are used regardless
	// of relevance to generate answers. If set to `true` or unset, the behavior
	// will be determined automatically by the service.
	IgnoreLowRelevantContent *bool `protobuf:"varint,7,opt,name=ignore_low_relevant_content,json=ignoreLowRelevantContent,proto3,oneof" json:"ignore_low_relevant_content,omitempty"`
	// Optional. Specifies whether to filter out jail-breaking queries. The
	// default value is `false`.
	//
	// Google employs search-query classification to detect jail-breaking
	// queries. No summary is returned if the search query is classified as a
	// jail-breaking query. A user might add instructions to the query to
	// change the tone, style, language, content of the answer, or ask the
	// model to act as a different entity, e.g. "Reply in the tone of a
	// competing company's CEO". If this field is set to `true`, we skip
	// generating summaries for jail-breaking queries and return fallback
	// messages instead.
	IgnoreJailBreakingQuery bool `protobuf:"varint,8,opt,name=ignore_jail_breaking_query,json=ignoreJailBreakingQuery,proto3" json:"ignore_jail_breaking_query,omitempty"`
	// contains filtered or unexported fields
}

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) GetIgnoreJailBreakingQuery

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreJailBreakingQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent() 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 (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect

func (*AnswerQueryRequest_AnswerGenerationSpec) Reset

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String

AnswerQueryRequest_EndUserSpec

type AnswerQueryRequest_EndUserSpec struct {

	// Optional. End user metadata.
	EndUserMetadata []*AnswerQueryRequest_EndUserSpec_EndUserMetaData `protobuf:"bytes,1,rep,name=end_user_metadata,json=endUserMetadata,proto3" json:"end_user_metadata,omitempty"`
	// contains filtered or unexported fields
}

End user specification.

func (*AnswerQueryRequest_EndUserSpec) Descriptor

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

Deprecated: Use AnswerQueryRequest_EndUserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec) GetEndUserMetadata

func (*AnswerQueryRequest_EndUserSpec) ProtoMessage

func (*AnswerQueryRequest_EndUserSpec) ProtoMessage()

func (*AnswerQueryRequest_EndUserSpec) ProtoReflect

func (*AnswerQueryRequest_EndUserSpec) Reset

func (x *AnswerQueryRequest_EndUserSpec) Reset()

func (*AnswerQueryRequest_EndUserSpec) String

AnswerQueryRequest_EndUserSpec_EndUserMetaData

type AnswerQueryRequest_EndUserSpec_EndUserMetaData struct {

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

End user metadata.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Descriptor

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetChunkInfo

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent

func (m *AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent() isAnswerQueryRequest_EndUserSpec_EndUserMetaData_Content

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoMessage

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoReflect

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Reset

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) String

AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo

type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo struct {

	// Chunk textual content. It is limited to 8000 characters.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Metadata of the document from the current chunk.
	DocumentMetadata *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata `protobuf:"bytes,2,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Descriptor

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetContent

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetDocumentMetadata

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoMessage

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoReflect

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Reset

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) String

AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_

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

AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata

type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata struct {

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

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

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Descriptor

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) GetTitle

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoMessage

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoReflect

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Reset

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) String

AnswerQueryRequest_GroundingSpec

type AnswerQueryRequest_GroundingSpec struct {

	// Optional. Specifies whether to include grounding_supports in the answer.
	// The default value is `false`.
	//
	// When this field is set to `true`, returned answer will have
	// `grounding_score` and will contain GroundingSupports for each claim.
	IncludeGroundingSupports bool `protobuf:"varint,2,opt,name=include_grounding_supports,json=includeGroundingSupports,proto3" json:"include_grounding_supports,omitempty"`
	// Optional. Specifies whether to enable the filtering based on grounding
	// score and at what level.
	FilteringLevel AnswerQueryRequest_GroundingSpec_FilteringLevel `protobuf:"varint,3,opt,name=filtering_level,json=filteringLevel,proto3,enum=google.cloud.discoveryengine.v1.AnswerQueryRequest_GroundingSpec_FilteringLevel" json:"filtering_level,omitempty"`
	// contains filtered or unexported fields
}

Grounding specification.

func (*AnswerQueryRequest_GroundingSpec) Descriptor

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

Deprecated: Use AnswerQueryRequest_GroundingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_GroundingSpec) GetFilteringLevel

func (*AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports

func (x *AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports() bool

func (*AnswerQueryRequest_GroundingSpec) ProtoMessage

func (*AnswerQueryRequest_GroundingSpec) ProtoMessage()

func (*AnswerQueryRequest_GroundingSpec) ProtoReflect

func (*AnswerQueryRequest_GroundingSpec) Reset

func (*AnswerQueryRequest_GroundingSpec) String

AnswerQueryRequest_GroundingSpec_FilteringLevel

type AnswerQueryRequest_GroundingSpec_FilteringLevel int32

Level to filter based on answer grounding.

AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_UNSPECIFIED, AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_LOW, AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_HIGH

const (
	// Default is no filter
	AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_UNSPECIFIED AnswerQueryRequest_GroundingSpec_FilteringLevel = 0
	// Filter answers based on a low threshold.
	AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_LOW AnswerQueryRequest_GroundingSpec_FilteringLevel = 1
	// Filter answers based on a high threshold.
	AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_HIGH AnswerQueryRequest_GroundingSpec_FilteringLevel = 2
)

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Descriptor

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Enum

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) EnumDescriptor

Deprecated: Use AnswerQueryRequest_GroundingSpec_FilteringLevel.Descriptor instead.

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Number

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) String

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Type

AnswerQueryRequest_QueryUnderstandingSpec

type AnswerQueryRequest_QueryUnderstandingSpec struct {

	// Query classification specification.
	QueryClassificationSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec `protobuf:"bytes,1,opt,name=query_classification_spec,json=queryClassificationSpec,proto3" json:"query_classification_spec,omitempty"`
	// Query rephraser specification.
	QueryRephraserSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec `protobuf:"bytes,2,opt,name=query_rephraser_spec,json=queryRephraserSpec,proto3" json:"query_rephraser_spec,omitempty"`
	// Optional. Whether to disable spell correction.
	// The default value is `false`.
	DisableSpellCorrection bool `protobuf:"varint,3,opt,name=disable_spell_correction,json=disableSpellCorrection,proto3" json:"disable_spell_correction,omitempty"`
	// contains filtered or unexported fields
}

Query understanding specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection() bool

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect

func (*AnswerQueryRequest_QueryUnderstandingSpec) Reset

func (*AnswerQueryRequest_QueryUnderstandingSpec) String

AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {

	// Enabled query classification types.
	Types []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type `protobuf:"varint,1,rep,packed,name=types,proto3,enum=google.cloud.discoveryengine.v1.AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type" json:"types,omitempty"`
	// contains filtered or unexported fields
}

Query classification specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) 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, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY_V2

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, for chit chat.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 2
	// Jail-breaking query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 3
	// Non-answer-seeking query classification type, for no clear intent.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY_V2 AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 4
)

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type

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 5 steps.
	// If not set or set to < 1,="" it="" will="" be="" set="" to="" 1="" by="" default.="" maxrephrasesteps="">int32 `protobuf:"varint,2,opt,name=max_rephrase_steps,json=maxRephraseSteps,proto3" json:"max_rephrase_steps,omitempty"`
	// Optional. Query Rephraser Model specification.
	ModelSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec `protobuf:"bytes,3,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
	// contains filtered or unexported fields
}

Query rephraser specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Descriptor

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetModelSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String

AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec struct {

	// Optional. Enabled query rephraser model type. If not set, it will use
	// LARGE by default.
	ModelType AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType `protobuf:"varint,1,opt,name=model_type,json=modelType,proto3,enum=google.cloud.discoveryengine.v1.AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType" json:"model_type,omitempty"`
	// contains filtered or unexported fields
}

Query Rephraser Model specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Descriptor

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) GetModelType

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoMessage

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoReflect

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Reset

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) String

AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType int32

Query rephraser types. Currently only supports single-hop (max_rephrase_steps = 1) model selections. For multi-hop (max_rephrase_steps > 1), there is only one default model.

AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_MODEL_TYPE_UNSPECIFIED, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_SMALL, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_LARGE

const (
	// Unspecified model type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_MODEL_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 0
	// Small query rephraser model. Gemini 1.0 XS model.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_SMALL AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 1
	// Large query rephraser model. Gemini 1.0 Pro model.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_LARGE AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 2
)

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Descriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Enum

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) EnumDescriptor

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Number

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) String

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Type

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

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect

func (*AnswerQueryRequest_RelatedQuestionsSpec) Reset

func (*AnswerQueryRequest_RelatedQuestionsSpec) 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"`
	// Optional. Safety settings.
	// This settings are effective only when the safety_spec.enable is true.
	SafetySettings []*AnswerQueryRequest_SafetySpec_SafetySetting `protobuf:"bytes,2,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// contains filtered or unexported fields
}

Safety specification. There are two use cases:

  1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
  2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

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) GetSafetySettings

func (*AnswerQueryRequest_SafetySpec) ProtoMessage

func (*AnswerQueryRequest_SafetySpec) ProtoMessage()

func (*AnswerQueryRequest_SafetySpec) ProtoReflect

func (*AnswerQueryRequest_SafetySpec) Reset

func (x *AnswerQueryRequest_SafetySpec) Reset()

func (*AnswerQueryRequest_SafetySpec) String

AnswerQueryRequest_SafetySpec_SafetySetting

type AnswerQueryRequest_SafetySpec_SafetySetting struct {

	// Required. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.discoveryengine.v1.HarmCategory" json:"category,omitempty"`
	// Required. The harm block threshold.
	Threshold AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold `protobuf:"varint,2,opt,name=threshold,proto3,enum=google.cloud.discoveryengine.v1.AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold" json:"threshold,omitempty"`
	// contains filtered or unexported fields
}

Safety settings.

func (*AnswerQueryRequest_SafetySpec_SafetySetting) Descriptor

Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SafetySpec_SafetySetting) GetCategory

func (*AnswerQueryRequest_SafetySpec_SafetySetting) GetThreshold

func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoMessage

func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoReflect

func (*AnswerQueryRequest_SafetySpec_SafetySetting) Reset

func (*AnswerQueryRequest_SafetySpec_SafetySetting) String

AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold

type AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold int32

Probability based thresholds levels for blocking.

AnswerQueryRequest_SafetySpec_SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_LOW_AND_ABOVE, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_MEDIUM_AND_ABOVE, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_ONLY_HIGH, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_NONE, AnswerQueryRequest_SafetySpec_SafetySetting_OFF

const (
	// Unspecified harm block threshold.
	AnswerQueryRequest_SafetySpec_SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 0
	// Block low threshold and above (i.e. block more).
	AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_LOW_AND_ABOVE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 1
	// Block medium threshold and above.
	AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_MEDIUM_AND_ABOVE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 2
	// Block only high threshold (i.e. block less).
	AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_ONLY_HIGH AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 3
	// Block none.
	AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_NONE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 4
	// Turn off the safety filter.
	AnswerQueryRequest_SafetySpec_SafetySetting_OFF AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 5
)

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Descriptor

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Enum

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) EnumDescriptor

Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold.Descriptor instead.

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Number

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) String

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Type

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 (*AnswerQueryRequest_SearchSpec) GetSearchResultList

func (*AnswerQueryRequest_SearchSpec) ProtoMessage

func (*AnswerQueryRequest_SearchSpec) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec) ProtoReflect

func (*AnswerQueryRequest_SearchSpec) Reset

func (x *AnswerQueryRequest_SearchSpec) Reset()

func (*AnswerQueryRequest_SearchSpec) 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.v1.Document]
	// object. Leave it unset if ordered by relevance. `order_by` expression
	// is case-sensitive. For more information on ordering, see
	// [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
	//
	// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
	OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Specifies the search result mode. If unspecified, the
	// search result mode defaults to `DOCUMENTS`.
	// See [parse and chunk
	// documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
	SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `protobuf:"varint,5,opt,name=search_result_mode,json=searchResultMode,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_ContentSearchSpec_SearchResultMode" json:"search_result_mode,omitempty"`
	// Specs defining dataStores to filter on in a search call and
	// configurations for those dataStores. This is only considered for
	// engines with multiple dataStores use case. For single dataStore within
	// an engine, they should use the specs at the top level.
	DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,7,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
	// contains filtered or unexported fields
}

Search parameters.

func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchParams) Reset

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) 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"`
	// Metadata of the document from the current chunk.
	DocumentMetadata *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata `protobuf:"bytes,4,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetDocumentMetadata

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) 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_ChunkInfo_DocumentMetadata

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata struct {

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

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetTitle

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetUri

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) String

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. The content will be used for Answer
	// Generation. This is supposed to be the main content of the document
	// that can be long and comprehensive.
	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"`
	// Deprecated: This field is deprecated and will have no effect on
	// the Answer generation.
	// Please use document_contexts and extractive_segments fields.
	// List of extractive answers.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/conversational_search_service.proto.
	ExtractiveAnswers []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer `protobuf:"bytes,6,rep,name=extractive_answers,json=extractiveAnswers,proto3" json:"extractive_answers,omitempty"`
	// contains filtered or unexported fields
}

Unstructured document information.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/conversational_search_service.proto.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) 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 to be used for answer generation.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Document context.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) 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 Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Descriptor

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String

AnswerQueryResponse

type AnswerQueryResponse struct {

	// Answer resource object.
	// If
	// [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
	// is greater than 1, use
	// [Answer.name][google.cloud.discoveryengine.v1.Answer.name] to fetch answer
	// information using
	// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1.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.v1.AnswerQueryRequest]
	// request.
	Session *Session `protobuf:"bytes,2,opt,name=session,proto3" json:"session,omitempty"`
	// A global unique ID used for logging.
	AnswerQueryToken string `protobuf:"bytes,3,opt,name=answer_query_token,json=answerQueryToken,proto3" json:"answer_query_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.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) GetAnswerQueryToken

func (x *AnswerQueryResponse) GetAnswerQueryToken() string

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, Answer_NO_RELEVANT_CONTENT, Answer_JAIL_BREAKING_QUERY_IGNORED, Answer_CUSTOMER_POLICY_VIOLATION, Answer_NON_ANSWER_SEEKING_QUERY_IGNORED_V2, Answer_LOW_GROUNDED_ANSWER

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
	//
	// Google skips the answer if the query is chit chat.
	Answer_NON_ANSWER_SEEKING_QUERY_IGNORED Answer_AnswerSkippedReason = 2
	// The out-of-domain query ignored case.
	//
	// Google skips the answer if there are no high-relevance search results.
	Answer_OUT_OF_DOMAIN_QUERY_IGNORED Answer_AnswerSkippedReason = 3
	// The potential policy violation case.
	//
	// Google skips the answer if there is a potential policy violation
	// detected. This includes content that may be violent or toxic.
	Answer_POTENTIAL_POLICY_VIOLATION Answer_AnswerSkippedReason = 4
	// The no relevant content case.
	//
	// Google skips the answer if there is no relevant content in the
	// retrieved search results.
	Answer_NO_RELEVANT_CONTENT Answer_AnswerSkippedReason = 5
	// The jail-breaking query ignored case.
	//
	// For example, "Reply in the tone of a competing company's CEO".
	// Google skips the answer if the query is classified as a jail-breaking
	// query.
	Answer_JAIL_BREAKING_QUERY_IGNORED Answer_AnswerSkippedReason = 6
	// The customer policy violation case.
	//
	// Google skips the summary if there is a customer policy violation
	// detected. The policy is defined by the customer.
	Answer_CUSTOMER_POLICY_VIOLATION Answer_AnswerSkippedReason = 7
	// The non-answer seeking query ignored case.
	//
	// Google skips the answer if the query doesn't have clear intent.
	Answer_NON_ANSWER_SEEKING_QUERY_IGNORED_V2 Answer_AnswerSkippedReason = 8
	// The low-grounded answer case.
	//
	// Google skips the answer if a well grounded answer was unable to be
	// generated.
	Answer_LOW_GROUNDED_ANSWER Answer_AnswerSkippedReason = 9
)

func (Answer_AnswerSkippedReason) Descriptor

func (Answer_AnswerSkippedReason) Enum

func (Answer_AnswerSkippedReason) EnumDescriptor

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

Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.

func (Answer_AnswerSkippedReason) Number

func (Answer_AnswerSkippedReason) String

func (Answer_AnswerSkippedReason) Type

Answer_Citation

type Answer_Citation struct {

	// Index indicates the start of the segment, measured in bytes (UTF-8
	// unicode). If there are multi-byte characters,such as non-ASCII
	// characters, the index measurement is longer than the string length.
	StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// End of the attributed segment, exclusive. Measured in bytes (UTF-8
	// unicode). If there are multi-byte characters,such as non-ASCII
	// characters, the index measurement is longer than the string length.
	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_GroundingSupport

type Answer_GroundingSupport struct {

	// Required. Index indicates the start of the claim, measured in bytes
	// (UTF-8 unicode).
	StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// Required. End of the claim, exclusive.
	EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// A score in the range of [0, 1] describing how grounded is a specific
	// claim by the references.
	// Higher value means that the claim is better supported by the reference
	// chunks.
	GroundingScore *float64 `protobuf:"fixed64,3,opt,name=grounding_score,json=groundingScore,proto3,oneof" json:"grounding_score,omitempty"`
	// Indicates that this claim required grounding check. When the
	// system decided this claim didn't require attribution/grounding check,
	// this field is set to false. In that case, no grounding check was
	// done for the claim and therefore `grounding_score`, `sources` is not
	// returned.
	GroundingCheckRequired *bool `protobuf:"varint,4,opt,name=grounding_check_required,json=groundingCheckRequired,proto3,oneof" json:"grounding_check_required,omitempty"`
	// Optional. Citation sources for the claim.
	Sources []*Answer_CitationSource `protobuf:"bytes,5,rep,name=sources,proto3" json:"sources,omitempty"`
	// contains filtered or unexported fields
}

Grounding support for a claim in answer_text.

func (*Answer_GroundingSupport) Descriptor

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

Deprecated: Use Answer_GroundingSupport.ProtoReflect.Descriptor instead.

func (*Answer_GroundingSupport) GetEndIndex

func (x *Answer_GroundingSupport) GetEndIndex() int64

func (*Answer_GroundingSupport) GetGroundingCheckRequired

func (x *Answer_GroundingSupport) GetGroundingCheckRequired() bool

func (*Answer_GroundingSupport) GetGroundingScore

func (x *Answer_GroundingSupport) GetGroundingScore() float64

func (*Answer_GroundingSupport) GetSources

func (*Answer_GroundingSupport) GetStartIndex

func (x *Answer_GroundingSupport) GetStartIndex() int64

func (*Answer_GroundingSupport) ProtoMessage

func (*Answer_GroundingSupport) ProtoMessage()

func (*Answer_GroundingSupport) ProtoReflect

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

func (*Answer_GroundingSupport) Reset

func (x *Answer_GroundingSupport) Reset()

func (*Answer_GroundingSupport) String

func (x *Answer_GroundingSupport) String() string

Answer_QueryUnderstandingInfo

type Answer_QueryUnderstandingInfo struct {

	// Query classification information.
	QueryClassificationInfo []*Answer_QueryUnderstandingInfo_QueryClassificationInfo `protobuf:"bytes,1,rep,name=query_classification_info,json=queryClassificationInfo,proto3" json:"query_classification_info,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Answer_QueryUnderstandingInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo) ProtoReflect

func (*Answer_QueryUnderstandingInfo) Reset

func (x *Answer_QueryUnderstandingInfo) Reset()

func (*Answer_QueryUnderstandingInfo) String

Answer_QueryUnderstandingInfo_QueryClassificationInfo

type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {

	// Query classification type.
	Type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1.Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type" json:"type,omitempty"`
	// Classification output.
	Positive bool `protobuf:"varint,2,opt,name=positive,proto3" json:"positive,omitempty"`
	// contains filtered or unexported fields
}

Query classification information.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) 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, Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY, Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY_V2

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, for chit chat.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 2
	// Jail-breaking query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 3
	// Non-answer-seeking query classification type, for no clear intent.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY_V2 Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 4
)

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) 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_
	//	*Answer_Reference_StructuredDocumentInfo_
	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) GetStructuredDocumentInfo

func (x *Answer_Reference) GetStructuredDocumentInfo() *Answer_Reference_StructuredDocumentInfo

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

Chunk information.

func (*Answer_Reference_ChunkInfo) Descriptor

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 (*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 (*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"`
	// The structured JSON metadata for the document.
	// It is populated from the struct data from the Chunk in search result.
	StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

Document metadata.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor

Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset

func (*Answer_Reference_ChunkInfo_DocumentMetadata) String

Answer_Reference_StructuredDocumentInfo

type Answer_Reference_StructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Structured search data.
	StructData *structpb.Struct `protobuf:"bytes,2,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// Output only. The title of the document.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. The URI of the document.
	Uri string `protobuf:"bytes,4,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

Structured search information.

func (*Answer_Reference_StructuredDocumentInfo) Descriptor

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

Deprecated: Use Answer_Reference_StructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_StructuredDocumentInfo) GetDocument

func (*Answer_Reference_StructuredDocumentInfo) GetStructData

func (*Answer_Reference_StructuredDocumentInfo) GetTitle

func (*Answer_Reference_StructuredDocumentInfo) GetUri

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage

func (*Answer_Reference_StructuredDocumentInfo) ProtoReflect

func (*Answer_Reference_StructuredDocumentInfo) Reset

func (*Answer_Reference_StructuredDocumentInfo) String

Answer_Reference_StructuredDocumentInfo_

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

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"`
	// The structured JSON metadata for the document.
	// It is populated from the struct data from the Chunk in search result.
	StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

Unstructured document information.

func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents

func (*Answer_Reference_UnstructuredDocumentInfo) GetDocument

func (*Answer_Reference_UnstructuredDocumentInfo) GetStructData

func (*Answer_Reference_UnstructuredDocumentInfo) GetTitle

func (*Answer_Reference_UnstructuredDocumentInfo) GetUri

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect

func (*Answer_Reference_UnstructuredDocumentInfo) Reset

func (*Answer_Reference_UnstructuredDocumentInfo) 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"`
	// The relevance of the chunk for a given query. Values range from 0.0
	// (completely irrelevant) to 1.0 (completely relevant).
	// This value is for informational purpose only. It may change for
	// the same query and chunk at any time due to a model retraining or
	// change in implementation.
	RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// contains filtered or unexported fields
}

Chunk content.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) 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, Answer_STREAMING

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
	// Answer generation is currently in progress.
	Answer_STREAMING Answer_State = 4
)

func (Answer_State) Descriptor

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 (Answer_State) String

func (x Answer_State) String() string

func (Answer_State) Type

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.v1.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 (*Answer_Step_Action) GetSearchAction

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

func (*Answer_Step_Action_Observation) ProtoMessage()

func (*Answer_Step_Action_Observation) ProtoReflect

func (*Answer_Step_Action_Observation) Reset

func (x *Answer_Step_Action_Observation) Reset()

func (*Answer_Step_Action_Observation) 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"`
	// Data representation.
	// The structured JSON data for the document.
	// It's populated from the struct data from the Document, or the
	// Chunk in search result.
	StructData *structpb.Struct `protobuf:"bytes,6,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

func (*Answer_Step_Action_Observation_SearchResult) Descriptor

Deprecated: Use Answer_Step_Action_Observation_SearchResult.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult) GetChunkInfo

func (*Answer_Step_Action_Observation_SearchResult) GetDocument

func (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo

func (*Answer_Step_Action_Observation_SearchResult) GetStructData

func (*Answer_Step_Action_Observation_SearchResult) GetTitle

func (*Answer_Step_Action_Observation_SearchResult) GetUri

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage

func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect

func (*Answer_Step_Action_Observation_SearchResult) Reset

func (*Answer_Step_Action_Observation_SearchResult) 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"`
	// The relevance of the chunk for a given query. Values range from
	// 0.0 (completely irrelevant) to 1.0 (completely relevant).
	// This value is for informational purpose only. It may change for
	// the same query and chunk at any time due to a model retraining or
	// change in implementation.
	RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// contains filtered or unexported fields
}

Chunk information.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Descriptor

Deprecated: Use Answer_Step_Action_Observation_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_SnippetInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) 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 (*Answer_Step_Action_SearchAction) ProtoMessage

func (*Answer_Step_Action_SearchAction) ProtoMessage()

func (*Answer_Step_Action_SearchAction) ProtoReflect

func (*Answer_Step_Action_SearchAction) Reset

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

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 (Answer_Step_State) String

func (x Answer_Step_State) String() string

func (Answer_Step_State) Type

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.v1.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 (*BatchCreateTargetSiteMetadata) GetUpdateTime

func (*BatchCreateTargetSiteMetadata) ProtoMessage

func (*BatchCreateTargetSiteMetadata) ProtoMessage()

func (*BatchCreateTargetSiteMetadata) ProtoReflect

func (*BatchCreateTargetSiteMetadata) Reset

func (x *BatchCreateTargetSiteMetadata) Reset()

func (*BatchCreateTargetSiteMetadata) 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.v1.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 (*BatchCreateTargetSitesRequest) ProtoMessage

func (*BatchCreateTargetSitesRequest) ProtoMessage()

func (*BatchCreateTargetSitesRequest) ProtoReflect

func (*BatchCreateTargetSitesRequest) Reset

func (x *BatchCreateTargetSitesRequest) Reset()

func (*BatchCreateTargetSitesRequest) 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.v1.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 (*BatchCreateTargetSitesResponse) Reset

func (x *BatchCreateTargetSitesResponse) Reset()

func (*BatchCreateTargetSitesResponse) String

BatchGetDocumentsMetadataRequest

type BatchGetDocumentsMetadataRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Matcher for the
	// [Document][google.cloud.discoveryengine.v1.Document]s.
	Matcher *BatchGetDocumentsMetadataRequest_Matcher `protobuf:"bytes,2,opt,name=matcher,proto3" json:"matcher,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchGetDocumentsMetadataRequest) Descriptor

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

Deprecated: Use BatchGetDocumentsMetadataRequest.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest) GetMatcher

func (*BatchGetDocumentsMetadataRequest) GetParent

func (*BatchGetDocumentsMetadataRequest) ProtoMessage

func (*BatchGetDocumentsMetadataRequest) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest) ProtoReflect

func (*BatchGetDocumentsMetadataRequest) Reset

func (*BatchGetDocumentsMetadataRequest) String

BatchGetDocumentsMetadataRequest_FhirMatcher

type BatchGetDocumentsMetadataRequest_FhirMatcher struct {

	// Required. The FHIR resources to match by.
	// Format:
	// projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
	FhirResources []string `protobuf:"bytes,1,rep,name=fhir_resources,json=fhirResources,proto3" json:"fhir_resources,omitempty"`
	// contains filtered or unexported fields
}

Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s by FHIR resource names.

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) Descriptor

Deprecated: Use BatchGetDocumentsMetadataRequest_FhirMatcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) GetFhirResources

func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) GetFhirResources() []string

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoMessage

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoReflect

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) Reset

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) String

BatchGetDocumentsMetadataRequest_Matcher

type BatchGetDocumentsMetadataRequest_Matcher struct {

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

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

func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor

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

Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_Matcher) GetFhirMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetMatcher

func (m *BatchGetDocumentsMetadataRequest_Matcher) GetMatcher() isBatchGetDocumentsMetadataRequest_Matcher_Matcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect

func (*BatchGetDocumentsMetadataRequest_Matcher) Reset

func (*BatchGetDocumentsMetadataRequest_Matcher) String

BatchGetDocumentsMetadataRequest_Matcher_FhirMatcher

type BatchGetDocumentsMetadataRequest_Matcher_FhirMatcher struct {
	// Matcher by FHIR resource names.
	FhirMatcher *BatchGetDocumentsMetadataRequest_FhirMatcher `protobuf:"bytes,2,opt,name=fhir_matcher,json=fhirMatcher,proto3,oneof"`
}

BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher

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

BatchGetDocumentsMetadataRequest_UrisMatcher

type BatchGetDocumentsMetadataRequest_UrisMatcher struct {

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

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

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Descriptor

Deprecated: Use BatchGetDocumentsMetadataRequest_UrisMatcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) GetUris

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoReflect

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Reset

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) String

BatchGetDocumentsMetadataResponse

type BatchGetDocumentsMetadataResponse struct {

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

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

func (*BatchGetDocumentsMetadataResponse) Descriptor

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

Deprecated: Use BatchGetDocumentsMetadataResponse.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse) GetDocumentsMetadata

func (*BatchGetDocumentsMetadataResponse) ProtoMessage

func (*BatchGetDocumentsMetadataResponse) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse) ProtoReflect

func (*BatchGetDocumentsMetadataResponse) Reset

func (*BatchGetDocumentsMetadataResponse) String

BatchGetDocumentsMetadataResponse_DocumentMetadata

type BatchGetDocumentsMetadataResponse_DocumentMetadata struct {

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

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoReflect

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) String

BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue struct {

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

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetFhirResource

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue

func (m *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue() isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String

BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource struct {
	// Format:
	// projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
	FhirResource string `protobuf:"bytes,2,opt,name=fhir_resource,json=fhirResource,proto3,oneof"`
}

BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri

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

BatchGetDocumentsMetadataResponse_State

type BatchGetDocumentsMetadataResponse_State int32

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

BatchGetDocumentsMetadataResponse_STATE_UNSPECIFIED, BatchGetDocumentsMetadataResponse_INDEXED, BatchGetDocumentsMetadataResponse_NOT_IN_TARGET_SITE, BatchGetDocumentsMetadataResponse_NOT_IN_INDEX

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

func (BatchGetDocumentsMetadataResponse_State) Descriptor

func (BatchGetDocumentsMetadataResponse_State) Enum

func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor

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

Deprecated: Use BatchGetDocumentsMetadataResponse_State.Descriptor instead.

func (BatchGetDocumentsMetadataResponse_State) Number

func (BatchGetDocumentsMetadataResponse_State) String

func (BatchGetDocumentsMetadataResponse_State) Type

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.v1.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 (*BatchVerifyTargetSitesMetadata) GetUpdateTime

func (*BatchVerifyTargetSitesMetadata) ProtoMessage

func (*BatchVerifyTargetSitesMetadata) ProtoMessage()

func (*BatchVerifyTargetSitesMetadata) ProtoReflect

func (*BatchVerifyTargetSitesMetadata) Reset

func (x *BatchVerifyTargetSitesMetadata) Reset()

func (*BatchVerifyTargetSitesMetadata) 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.v1.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 (*BatchVerifyTargetSitesRequest) Reset

func (x *BatchVerifyTargetSitesRequest) Reset()

func (*BatchVerifyTargetSitesRequest) String

BatchVerifyTargetSitesResponse

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

Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.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 (*BatchVerifyTargetSitesResponse) Reset

func (x *BatchVerifyTargetSitesResponse) Reset()

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

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

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 (*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 {

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

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 (*BigtableOptions_BigtableColumn) GetFieldName

func (x *BigtableOptions_BigtableColumn) GetFieldName() string

func (*BigtableOptions_BigtableColumn) GetQualifier

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

func (*BigtableOptions_BigtableColumn) GetType

func (*BigtableOptions_BigtableColumn) ProtoMessage

func (*BigtableOptions_BigtableColumn) ProtoMessage()

func (*BigtableOptions_BigtableColumn) ProtoReflect

func (*BigtableOptions_BigtableColumn) Reset

func (x *BigtableOptions_BigtableColumn) Reset()

func (*BigtableOptions_BigtableColumn) String

BigtableOptions_BigtableColumnFamily

type BigtableOptions_BigtableColumnFamily struct {

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

The column family of the Bigtable.

func (*BigtableOptions_BigtableColumnFamily) Descriptor

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

Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumnFamily) GetColumns

func (*BigtableOptions_BigtableColumnFamily) GetEncoding

func (*BigtableOptions_BigtableColumnFamily) GetFieldName

func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() string

func (*BigtableOptions_BigtableColumnFamily) GetType

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()

func (*BigtableOptions_BigtableColumnFamily) ProtoReflect

func (*BigtableOptions_BigtableColumnFamily) Reset

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

func (BigtableOptions_Encoding) EnumDescriptor

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

Deprecated: Use BigtableOptions_Encoding.Descriptor instead.

func (BigtableOptions_Encoding) Number

func (BigtableOptions_Encoding) String

func (x BigtableOptions_Encoding) String() string

func (BigtableOptions_Encoding) Type

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) Enum

func (BigtableOptions_Type) EnumDescriptor

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

Deprecated: Use BigtableOptions_Type.Descriptor instead.

func (BigtableOptions_Type) Number

func (BigtableOptions_Type) String

func (x BigtableOptions_Type) String() string

func (BigtableOptions_Type) Type

BigtableSource

type BigtableSource struct {

	// The project ID that contains the Bigtable source. Has a length limit of 128
	// characters. If not specified, inherits the project ID from the parent
	// request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The instance ID of the Cloud Bigtable that needs to be imported.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The table ID of the Cloud Bigtable that needs to be imported.
	TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Required. Bigtable options that contains information needed when parsing
	// data into typed structures. For example, column type annotations.
	BigtableOptions *BigtableOptions `protobuf:"bytes,4,opt,name=bigtable_options,json=bigtableOptions,proto3" json:"bigtable_options,omitempty"`
	// contains filtered or unexported fields
}

The Cloud Bigtable source for importing data.

func (*BigtableSource) Descriptor

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. It can have a maximum length of 4096 tokens.
	AnswerCandidate string `protobuf:"bytes,2,opt,name=answer_candidate,json=answerCandidate,proto3" json:"answer_candidate,omitempty"`
	// List of facts for the grounding check.
	// We support up to 200 facts.
	Facts []*GroundingFact `protobuf:"bytes,3,rep,name=facts,proto3" json:"facts,omitempty"`
	// Configuration of the grounding check.
	GroundingSpec *CheckGroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,5,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.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) GetUserLabels

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

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"`
	// List of facts cited across all claims in the answer candidate.
	// These are derived from the facts supplied in the request.
	CitedFacts []*CheckGroundingResponse_CheckGroundingFactChunk `protobuf:"bytes,6,rep,name=cited_facts,json=citedFacts,proto3" json:"cited_facts,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.v1.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) GetCitedFacts

func (*CheckGroundingResponse) GetClaims

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_CheckGroundingFactChunk

type CheckGroundingResponse_CheckGroundingFactChunk struct {

	// Text content of the fact chunk. Can be at most 10K characters long.
	ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
	// contains filtered or unexported fields
}

Fact chunk for grounding check.

func (*CheckGroundingResponse_CheckGroundingFactChunk) Descriptor

Deprecated: Use CheckGroundingResponse_CheckGroundingFactChunk.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse_CheckGroundingFactChunk) GetChunkText

func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoMessage

func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoReflect

func (*CheckGroundingResponse_CheckGroundingFactChunk) Reset

func (*CheckGroundingResponse_CheckGroundingFactChunk) String

CheckGroundingResponse_Claim

type CheckGroundingResponse_Claim struct {

	// Position indicating the start of the claim in the answer candidate,
	// measured in bytes. Note that this is not measured in characters and,
	// therefore, must be rendered in the user interface keeping in mind that
	// some characters may take more than one byte. For example,
	// if the claim text contains non-ASCII characters, the start and end
	// positions vary when measured in characters
	// (programming-language-dependent) and when measured in bytes
	// (programming-language-independent).
	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, in bytes. Note that this is not measured in characters and,
	// therefore, must be rendered as such. For example, if the claim text
	// contains non-ASCII characters, the start and end positions vary when
	// measured in characters (programming-language-dependent) and when measured
	// in bytes (programming-language-independent).
	EndPos *int32 `protobuf:"varint,2,opt,name=end_pos,json=endPos,proto3,oneof" json:"end_pos,omitempty"`
	// Text for the claim in the answer candidate. Always provided regardless of
	// whether citations or anti-citations are found.
	ClaimText string `protobuf:"bytes,3,opt,name=claim_text,json=claimText,proto3" json:"claim_text,omitempty"`
	// A list of indices (into 'cited_chunks') specifying the citations
	// associated with the claim. For instance [1,3,4] means that
	// cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
	// supporting for the claim. A citation to a fact indicates that the claim
	// is supported by the fact.
	CitationIndices []int32 `protobuf:"varint,4,rep,packed,name=citation_indices,json=citationIndices,proto3" json:"citation_indices,omitempty"`
	// Indicates that this claim required grounding check. When the system
	// decided this claim doesn't require attribution/grounding check, this
	// field will be set to false. In that case, no grounding check was done for
	// the claim and therefore
	// [citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.citation_indices]
	// should not be returned.
	GroundingCheckRequired *bool `protobuf:"varint,6,opt,name=grounding_check_required,json=groundingCheckRequired,proto3,oneof" json:"grounding_check_required,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) GetGroundingCheckRequired

func (x *CheckGroundingResponse_Claim) GetGroundingCheckRequired() bool

func (*CheckGroundingResponse_Claim) GetStartPos

func (x *CheckGroundingResponse_Claim) GetStartPos() int32

func (*CheckGroundingResponse_Claim) ProtoMessage

func (*CheckGroundingResponse_Claim) ProtoMessage()

func (*CheckGroundingResponse_Claim) ProtoReflect

func (*CheckGroundingResponse_Claim) Reset

func (x *CheckGroundingResponse_Claim) Reset()

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

Chunk

type Chunk struct {

	// The full resource name of the chunk.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Unique chunk ID of the current chunk.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Content is a string from a document (parsed content).
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// Output only. Represents the relevance score based on similarity.
	// Higher score indicates higher chunk relevance.
	// The score is in range [-1.0, 1.0].
	// Only populated on
	// [SearchResponse][google.cloud.discoveryengine.v1.SearchResponse].
	RelevanceScore *float64 `protobuf:"fixed64,8,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
	// Metadata of the document from the current chunk.
	DocumentMetadata *Chunk_DocumentMetadata `protobuf:"bytes,5,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// Output only. This field is OUTPUT_ONLY.
	// It contains derived data that are not in the original input document.
	DerivedStructData *structpb.Struct `protobuf:"bytes,4,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
	// Page span of the chunk.
	PageSpan *Chunk_PageSpan `protobuf:"bytes,6,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// Output only. Metadata of the current chunk.
	ChunkMetadata *Chunk_ChunkMetadata `protobuf:"bytes,7,opt,name=chunk_metadata,json=chunkMetadata,proto3" json:"chunk_metadata,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Chunk) Descriptor

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetChunkMetadata

func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadata

func (*Chunk) GetContent

func (x *Chunk) GetContent() string

func (*Chunk) GetDerivedStructData

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

func (*Chunk) GetDocumentMetadata

func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadata

func (*Chunk) GetId

func (x *Chunk) GetId() string

func (*Chunk) GetName

func (x *Chunk) GetName() string

func (*Chunk) GetPageSpan

func (x *Chunk) GetPageSpan() *Chunk_PageSpan

func (*Chunk) GetRelevanceScore

func (x *Chunk) GetRelevanceScore() float64

func (*Chunk) ProtoMessage

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect

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

func (*Chunk) Reset

func (x *Chunk) Reset()

func (*Chunk) String

func (x *Chunk) String() string

Chunk_ChunkMetadata

type Chunk_ChunkMetadata struct {

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

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

func (*Chunk_ChunkMetadata) Descriptor

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

Deprecated: Use Chunk_ChunkMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_ChunkMetadata) GetNextChunks

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

func (*Chunk_ChunkMetadata) GetPreviousChunks

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

func (*Chunk_ChunkMetadata) ProtoMessage

func (*Chunk_ChunkMetadata) ProtoMessage()

func (*Chunk_ChunkMetadata) ProtoReflect

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

func (*Chunk_ChunkMetadata) Reset

func (x *Chunk_ChunkMetadata) Reset()

func (*Chunk_ChunkMetadata) String

func (x *Chunk_ChunkMetadata) String() string

Chunk_DocumentMetadata

type Chunk_DocumentMetadata struct {

	// Uri of the document.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title of the document.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Data representation.
	// The structured JSON data for the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,3,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Chunk_DocumentMetadata) Descriptor

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

Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_DocumentMetadata) GetStructData

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

func (*Chunk_DocumentMetadata) GetTitle

func (x *Chunk_DocumentMetadata) GetTitle() string

func (*Chunk_DocumentMetadata) GetUri

func (x *Chunk_DocumentMetadata) GetUri() string

func (*Chunk_DocumentMetadata) ProtoMessage

func (*Chunk_DocumentMetadata) ProtoMessage()

func (*Chunk_DocumentMetadata) ProtoReflect

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

func (*Chunk_DocumentMetadata) Reset

func (x *Chunk_DocumentMetadata) Reset()

func (*Chunk_DocumentMetadata) String

func (x *Chunk_DocumentMetadata) String() string

Chunk_PageSpan

type Chunk_PageSpan struct {

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

Page span of the chunk.

func (*Chunk_PageSpan) Descriptor

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

Deprecated: Use Chunk_PageSpan.ProtoReflect.Descriptor instead.

func (*Chunk_PageSpan) GetPageEnd

func (x *Chunk_PageSpan) GetPageEnd() int32

func (*Chunk_PageSpan) GetPageStart

func (x *Chunk_PageSpan) GetPageStart() int32

func (*Chunk_PageSpan) ProtoMessage

func (*Chunk_PageSpan) ProtoMessage()

func (*Chunk_PageSpan) ProtoReflect

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

func (*Chunk_PageSpan) Reset

func (x *Chunk_PageSpan) Reset()

func (*Chunk_PageSpan) String

func (x *Chunk_PageSpan) String() string

CloudSqlSource

type CloudSqlSource struct {

	// The project ID that contains the Cloud SQL source. Has a length limit of
	// 128 characters. If not specified, inherits the project ID from the parent
	// request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The Cloud SQL instance to copy the data from with a length limit
	// of 256 characters.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The Cloud SQL database to copy the data from with a length limit
	// of 256 characters.
	DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The Cloud SQL table to copy the data from with a length limit of
	// 256 characters.
	TableId string `protobuf:"bytes,4,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// Cloud SQL export to a specific Cloud Storage directory.
	//
	// Ensure that the Cloud SQL service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,5,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// Option for serverless export. Enabling this option will incur additional
	// cost. More info can be found
	// [here](https://cloud.google.com/sql/pricing#serverless).
	Offload bool `protobuf:"varint,6,opt,name=offload,proto3" json:"offload,omitempty"`
	// contains filtered or unexported fields
}

Cloud SQL source import data from.

func (*CloudSqlSource) Descriptor

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 resource name.
	// If the collect user event action is applied in
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
	// is:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	// If the collect user event action is applied in
	// [Location][google.cloud.location.Location] level, for example, the event
	// with [Document][google.cloud.discoveryengine.v1.Document] across multiple
	// [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
	// `projects/{project}/locations/{location}`.
	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 {

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

Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.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.v1.CompletionService.CompleteQuery] method.

func (*CompleteQueryResponse) Descriptor

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

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions

func (*CompleteQueryResponse) GetTailMatchTriggered

func (x *CompleteQueryResponse) GetTailMatchTriggered() bool

func (*CompleteQueryResponse) ProtoMessage

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect

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

func (*CompleteQueryResponse) Reset

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String

func (x *CompleteQueryResponse) String() string

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 (*CompleteQueryResponse_QuerySuggestion) Reset

func (*CompleteQueryResponse_QuerySuggestion) String

CompletionInfo

type CompletionInfo struct {

	// End user selected
	// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1.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.v1.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.v1.SuggestionDenyListEntry]
	// for a DataStore.
	ImportSuggestionDenyListEntries(ctx context.Context, in *ImportSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry]
	// for a DataStore.
	PurgeSuggestionDenyListEntries(ctx context.Context, in *PurgeSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// for a DataStore.
	ImportCompletionSuggestions(ctx context.Context, in *ImportCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// for a DataStore.
	PurgeCompletionSuggestions(ctx context.Context, in *PurgeCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

CompletionServiceClient is the client API for CompletionService service.

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

func NewCompletionServiceClient

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.v1.SuggestionDenyListEntry]
	// for a DataStore.
	ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry]
	// for a DataStore.
	PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
	// Imports
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// for a DataStore.
	ImportCompletionSuggestions(context.Context, *ImportCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
	// Permanently deletes all
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// for a DataStore.
	PurgeCompletionSuggestions(context.Context, *PurgeCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
}

CompletionServiceServer is the server API for CompletionService service.

CompletionSuggestion

type CompletionSuggestion struct {

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

Autocomplete suggestions that are imported from Customer.

func (*CompletionSuggestion) Descriptor

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

Deprecated: Use CompletionSuggestion.ProtoReflect.Descriptor instead.

func (*CompletionSuggestion) GetAlternativePhrases

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

func (*CompletionSuggestion) GetFrequency

func (x *CompletionSuggestion) GetFrequency() int64

func (*CompletionSuggestion) GetGlobalScore

func (x *CompletionSuggestion) GetGlobalScore() float64

func (*CompletionSuggestion) GetGroupId

func (x *CompletionSuggestion) GetGroupId() string

func (*CompletionSuggestion) GetGroupScore

func (x *CompletionSuggestion) GetGroupScore() float64

func (*CompletionSuggestion) GetLanguageCode

func (x *CompletionSuggestion) GetLanguageCode() string

func (*CompletionSuggestion) GetRankingInfo

func (m *CompletionSuggestion) GetRankingInfo() isCompletionSuggestion_RankingInfo

func (*CompletionSuggestion) GetSuggestion

func (x *CompletionSuggestion) GetSuggestion() string

func (*CompletionSuggestion) ProtoMessage

func (*CompletionSuggestion) ProtoMessage()

func (*CompletionSuggestion) ProtoReflect

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

func (*CompletionSuggestion) Reset

func (x *CompletionSuggestion) Reset()

func (*CompletionSuggestion) String

func (x *CompletionSuggestion) String() string

CompletionSuggestion_Frequency

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

CompletionSuggestion_GlobalScore

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

Condition

type Condition struct {

	// Search only
	// A list of terms to match the query on.
	// Cannot be set when
	// [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex]
	// is set.
	//
	// Maximum of 10 query terms.
	QueryTerms []*Condition_QueryTerm `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Range of time(s) specifying when condition is active.
	//
	// Maximum of 10 time ranges.
	ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
	// Optional. Query regex to match the whole search query.
	// Cannot be set when
	// [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms]
	// is set. This is currently supporting promotion use case.
	QueryRegex string `protobuf:"bytes,4,opt,name=query_regex,json=queryRegex,proto3" json:"query_regex,omitempty"`
	// contains filtered or unexported fields
}

Defines circumstances to be checked before allowing a behavior

func (*Condition) Descriptor

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

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetActiveTimeRange

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

func (*Condition) GetQueryRegex

func (x *Condition) GetQueryRegex() string

func (*Condition) GetQueryTerms

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

func (*Condition) ProtoMessage

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect

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

func (*Condition) Reset

func (x *Condition) Reset()

func (*Condition) String

func (x *Condition) String() string

Condition_QueryTerm

type Condition_QueryTerm struct {

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

Matcher for search request query

func (*Condition_QueryTerm) Descriptor

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

Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.

func (*Condition_QueryTerm) GetFullMatch

func (x *Condition_QueryTerm) GetFullMatch() bool

func (*Condition_QueryTerm) GetValue

func (x *Condition_QueryTerm) GetValue() string

func (*Condition_QueryTerm) ProtoMessage

func (*Condition_QueryTerm) ProtoMessage()

func (*Condition_QueryTerm) ProtoReflect

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

func (*Condition_QueryTerm) Reset

func (x *Condition_QueryTerm) Reset()

func (*Condition_QueryTerm) String

func (x *Condition_QueryTerm) String() string

Condition_TimeRange

type Condition_TimeRange struct {

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

Used for time-dependent conditions.

func (*Condition_TimeRange) Descriptor

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

Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.

func (*Condition_TimeRange) GetEndTime

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

func (*Condition_TimeRange) GetStartTime

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

func (*Condition_TimeRange) ProtoMessage

func (*Condition_TimeRange) ProtoMessage()

func (*Condition_TimeRange) ProtoReflect

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

func (*Condition_TimeRange) Reset

func (x *Condition_TimeRange) Reset()

func (*Condition_TimeRange) String

func (x *Condition_TimeRange) String() string

Control

type Control struct {

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

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

func (*Control) Descriptor

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

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetAction

func (m *Control) GetAction() isControl_Action

func (*Control) GetAssociatedServingConfigIds

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

func (*Control) GetBoostAction

func (x *Control) GetBoostAction() *Control_BoostAction

func (*Control) GetConditions

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

func (*Control) GetDisplayName

func (x *Control) GetDisplayName() string

func (*Control) GetFilterAction

func (x *Control) GetFilterAction() *Control_FilterAction

func (*Control) GetName

func (x *Control) GetName() string

func (*Control) GetPromoteAction

func (x *Control) GetPromoteAction() *Control_PromoteAction

func (*Control) GetRedirectAction

func (x *Control) GetRedirectAction() *Control_RedirectAction

func (*Control) GetSolutionType

func (x *Control) GetSolutionType() SolutionType

func (*Control) GetSynonymsAction

func (x *Control) GetSynonymsAction() *Control_SynonymsAction

func (*Control) GetUseCases

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

func (*Control) ProtoMessage

func (*Control) ProtoMessage()

func (*Control) ProtoReflect

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

func (*Control) Reset

func (x *Control) Reset()

func (*Control) String

func (x *Control) String() string

ControlServiceClient

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

ControlServiceClient is the client API for ControlService service.

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

func NewControlServiceClient

func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient

ControlServiceServer

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

ControlServiceServer is the server API for ControlService service.

Control_BoostAction

type Control_BoostAction struct {

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

Adjusts order of products in returned list.

func (*Control_BoostAction) Descriptor

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

Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.

func (*Control_BoostAction) GetBoost

func (x *Control_BoostAction) GetBoost() float32

Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/control.proto.

func (*Control_BoostAction) GetBoostSpec

func (m *Control_BoostAction) GetBoostSpec() isControl_BoostAction_BoostSpec

func (*Control_BoostAction) GetDataStore

func (x *Control_BoostAction) GetDataStore() string

func (*Control_BoostAction) GetFilter

func (x *Control_BoostAction) GetFilter() string

func (*Control_BoostAction) GetFixedBoost

func (x *Control_BoostAction) GetFixedBoost() float32

func (*Control_BoostAction) GetInterpolationBoostSpec

func (x *Control_BoostAction) GetInterpolationBoostSpec() *Control_BoostAction_InterpolationBoostSpec

func (*Control_BoostAction) ProtoMessage

func (*Control_BoostAction) ProtoMessage()

func (*Control_BoostAction) ProtoReflect

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

func (*Control_BoostAction) Reset

func (x *Control_BoostAction) Reset()

func (*Control_BoostAction) String

func (x *Control_BoostAction) String() string

Control_BoostAction_

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

Control_BoostAction_FixedBoost

type Control_BoostAction_FixedBoost struct {
	// Optional. Strength of the boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0 (No-op).
	FixedBoost float32 `protobuf:"fixed32,4,opt,name=fixed_boost,json=fixedBoost,proto3,oneof"`
}

Control_BoostAction_InterpolationBoostSpec

type Control_BoostAction_InterpolationBoostSpec struct {

	// Optional. The name of the field whose value will be used to determine
	// the boost amount.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Optional. The attribute type to be used to determine the boost amount.
	// The attribute value can be derived from the field value of the
	// specified field_name. In the case of numerical it is straightforward
	// i.e. attribute_value = numerical_field_value. In the case of freshness
	// however, attribute_value = (time.now() - datetime_field_value).
	AttributeType Control_BoostAction_InterpolationBoostSpec_AttributeType `protobuf:"varint,2,opt,name=attribute_type,json=attributeType,proto3,enum=google.cloud.discoveryengine.v1.Control_BoostAction_InterpolationBoostSpec_AttributeType" json:"attribute_type,omitempty"`
	// Optional. The interpolation type to be applied to connect the control
	// points listed below.
	InterpolationType Control_BoostAction_InterpolationBoostSpec_InterpolationType `protobuf:"varint,3,opt,name=interpolation_type,json=interpolationType,proto3,enum=google.cloud.discoveryengine.v1.Control_BoostAction_InterpolationBoostSpec_InterpolationType" json:"interpolation_type,omitempty"`
	// Optional. The control points used to define the curve. The monotonic
	// function (defined through the interpolation_type above) passes through
	// the control points listed here.
	ControlPoints []*Control_BoostAction_InterpolationBoostSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
	// contains filtered or unexported fields
}

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

func (*Control_BoostAction_InterpolationBoostSpec) Descriptor

Deprecated: Use Control_BoostAction_InterpolationBoostSpec.ProtoReflect.Descriptor instead.

func (*Control_BoostAction_InterpolationBoostSpec) GetAttributeType

func (*Control_BoostAction_InterpolationBoostSpec) GetControlPoints

func (*Control_BoostAction_InterpolationBoostSpec) GetFieldName

func (*Control_BoostAction_InterpolationBoostSpec) GetInterpolationType

func (*Control_BoostAction_InterpolationBoostSpec) ProtoMessage

func (*Control_BoostAction_InterpolationBoostSpec) ProtoReflect

func (*Control_BoostAction_InterpolationBoostSpec) Reset

func (*Control_BoostAction_InterpolationBoostSpec) String

Control_BoostAction_InterpolationBoostSpec_

type Control_BoostAction_InterpolationBoostSpec_ struct {
	// Optional. Complex specification for custom ranking based on customer
	// defined attribute value.
	InterpolationBoostSpec *Control_BoostAction_InterpolationBoostSpec `protobuf:"bytes,5,opt,name=interpolation_boost_spec,json=interpolationBoostSpec,proto3,oneof"`
}

Control_BoostAction_InterpolationBoostSpec_AttributeType

type Control_BoostAction_InterpolationBoostSpec_AttributeType int32

The attribute(or function) for which the custom ranking is to be applied.

Control_BoostAction_InterpolationBoostSpec_ATTRIBUTE_TYPE_UNSPECIFIED, Control_BoostAction_InterpolationBoostSpec_NUMERICAL, Control_BoostAction_InterpolationBoostSpec_FRESHNESS

const (
	// Unspecified AttributeType.
	Control_BoostAction_InterpolationBoostSpec_ATTRIBUTE_TYPE_UNSPECIFIED Control_BoostAction_InterpolationBoostSpec_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.
	Control_BoostAction_InterpolationBoostSpec_NUMERICAL Control_BoostAction_InterpolationBoostSpec_AttributeType = 1
	// For the freshness use case the attribute value will be the duration
	// between the current time and the date in the datetime field
	// specified. The value must be formatted as an XSD `dayTimeDuration`
	// value (a restricted subset of an ISO 8601 duration value). The
	// pattern for this is: `[nD][T[nH][nM][nS]]`.
	// For example, `5D`, `3DT12H30M`, `T24H`.
	Control_BoostAction_InterpolationBoostSpec_FRESHNESS Control_BoostAction_InterpolationBoostSpec_AttributeType = 2
)

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Descriptor

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Enum

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) EnumDescriptor

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_AttributeType.Descriptor instead.

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Number

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) String

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Type

Control_BoostAction_InterpolationBoostSpec_ControlPoint

type Control_BoostAction_InterpolationBoostSpec_ControlPoint struct {

	// Optional. 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"`
	// Optional. 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 (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Descriptor

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_ControlPoint.ProtoReflect.Descriptor instead.

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetAttributeValue

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetBoostAmount

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoMessage

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoReflect

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Reset

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) String

Control_BoostAction_InterpolationBoostSpec_InterpolationType

type Control_BoostAction_InterpolationBoostSpec_InterpolationType int32

The interpolation type to be applied. Default will be linear (Piecewise Linear).

Control_BoostAction_InterpolationBoostSpec_INTERPOLATION_TYPE_UNSPECIFIED, Control_BoostAction_InterpolationBoostSpec_LINEAR

const (
	// Interpolation type is unspecified. In this case, it defaults to
	// Linear.
	Control_BoostAction_InterpolationBoostSpec_INTERPOLATION_TYPE_UNSPECIFIED Control_BoostAction_InterpolationBoostSpec_InterpolationType = 0
	// Piecewise linear interpolation will be applied.
	Control_BoostAction_InterpolationBoostSpec_LINEAR Control_BoostAction_InterpolationBoostSpec_InterpolationType = 1
)

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Descriptor

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Enum

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) EnumDescriptor

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_InterpolationType.Descriptor instead.

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Number

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) String

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Type

Control_FilterAction

type Control_FilterAction struct {

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

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

func (*Control_FilterAction) Descriptor

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

Deprecated: Use Control_FilterAction.ProtoReflect.Descriptor instead.

func (*Control_FilterAction) GetDataStore

func (x *Control_FilterAction) GetDataStore() string

func (*Control_FilterAction) GetFilter

func (x *Control_FilterAction) GetFilter() string

func (*Control_FilterAction) ProtoMessage

func (*Control_FilterAction) ProtoMessage()

func (*Control_FilterAction) ProtoReflect

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

func (*Control_FilterAction) Reset

func (x *Control_FilterAction) Reset()

func (*Control_FilterAction) String

func (x *Control_FilterAction) String() string

Control_FilterAction_

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

Control_PromoteAction

type Control_PromoteAction struct {

	// Required. Data store with which this promotion is attached to.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. Promotion attached to this action.
	SearchLinkPromotion *SearchLinkPromotion `protobuf:"bytes,2,opt,name=search_link_promotion,json=searchLinkPromotion,proto3" json:"search_link_promotion,omitempty"`
	// contains filtered or unexported fields
}

Promote certain links based on some trigger queries.

Example: Promote shoe store link when searching for shoe keyword. The link can be outside of associated data store.

func (*Control_PromoteAction) Descriptor

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

Deprecated: Use Control_PromoteAction.ProtoReflect.Descriptor instead.

func (*Control_PromoteAction) GetDataStore

func (x *Control_PromoteAction) GetDataStore() string

func (*Control_PromoteAction) GetSearchLinkPromotion

func (x *Control_PromoteAction) GetSearchLinkPromotion() *SearchLinkPromotion

func (*Control_PromoteAction) ProtoMessage

func (*Control_PromoteAction) ProtoMessage()

func (*Control_PromoteAction) ProtoReflect

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

func (*Control_PromoteAction) Reset

func (x *Control_PromoteAction) Reset()

func (*Control_PromoteAction) String

func (x *Control_PromoteAction) String() string

Control_PromoteAction_

type Control_PromoteAction_ struct {
	// Promote certain links based on predefined trigger queries.
	//
	// This now only supports basic site search.
	PromoteAction *Control_PromoteAction `protobuf:"bytes,15,opt,name=promote_action,json=promoteAction,proto3,oneof"`
}

Control_RedirectAction

type Control_RedirectAction struct {

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

Redirects a shopper to the provided URI.

func (*Control_RedirectAction) Descriptor

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

Deprecated: Use Control_RedirectAction.ProtoReflect.Descriptor instead.

func (*Control_RedirectAction) GetRedirectUri

func (x *Control_RedirectAction) GetRedirectUri() string

func (*Control_RedirectAction) ProtoMessage

func (*Control_RedirectAction) ProtoMessage()

func (*Control_RedirectAction) ProtoReflect

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

func (*Control_RedirectAction) Reset

func (x *Control_RedirectAction) Reset()

func (*Control_RedirectAction) String

func (x *Control_RedirectAction) String() string

Control_RedirectAction_

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

Control_SynonymsAction

type Control_SynonymsAction struct {

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

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

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

func (*Control_SynonymsAction) Descriptor

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

Deprecated: Use Control_SynonymsAction.ProtoReflect.Descriptor instead.

func (*Control_SynonymsAction) GetSynonyms

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

func (*Control_SynonymsAction) ProtoMessage

func (*Control_SynonymsAction) ProtoMessage()

func (*Control_SynonymsAction) ProtoReflect

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

func (*Control_SynonymsAction) Reset

func (x *Control_SynonymsAction) Reset()

func (*Control_SynonymsAction) String

func (x *Control_SynonymsAction) String() string

Control_SynonymsAction_

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

Conversation

type Conversation struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
	// or
	// `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the Conversation.
	State Conversation_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.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) Enum

func (Conversation_State) EnumDescriptor

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

Deprecated: Use Conversation_State.Descriptor instead.

func (Conversation_State) Number

func (Conversation_State) String

func (x Conversation_State) String() string

func (Conversation_State) Type

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.v1.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.v1.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.v1.Conversation] action type
	// cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1.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.v1.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)
	// Answer query method (streaming).
	//
	// It takes one
	// [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest]
	// and returns multiple
	// [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse]
	// messages in a stream.
	StreamAnswerQuery(ctx context.Context, in *AnswerQueryRequest, opts ...grpc.CallOption) (ConversationalSearchService_StreamAnswerQueryClient, error)
	// Gets a Answer.
	GetAnswer(ctx context.Context, in *GetAnswerRequest, opts ...grpc.CallOption) (*Answer, error)
	// Creates a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1.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.v1.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.v1.Session] action type cannot be
	// changed. If the [Session][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.Conversation] action type
	// cannot be changed. If the
	// [Conversation][google.cloud.discoveryengine.v1.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.v1.DataStore].
	ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
	// Answer query method.
	AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)
	// Answer query method (streaming).
	//
	// It takes one
	// [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest]
	// and returns multiple
	// [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse]
	// messages in a stream.
	StreamAnswerQuery(*AnswerQueryRequest, ConversationalSearchService_StreamAnswerQueryServer) error
	// Gets a Answer.
	GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)
	// Creates a Session.
	//
	// If the [Session][google.cloud.discoveryengine.v1.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.v1.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.v1.Session] action type cannot be
	// changed. If the [Session][google.cloud.discoveryengine.v1.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.v1.DataStore].
	ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
}

ConversationalSearchServiceServer is the server API for ConversationalSearchService service.

ConversationalSearchService_StreamAnswerQueryClient

type ConversationalSearchService_StreamAnswerQueryClient interface {
	Recv() (*AnswerQueryResponse, error)
	grpc.ClientStream
}

ConversationalSearchService_StreamAnswerQueryServer

type ConversationalSearchService_StreamAnswerQueryServer interface {
	Send(*AnswerQueryResponse) error
	grpc.ServerStream
}

ConverseConversationRequest

type ConverseConversationRequest struct {

	// Required. The resource name of the Conversation to get. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
	// Use
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
	// to activate auto session mode, which automatically creates a new
	// conversation inside a ConverseConversation session.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Current user input.
	Query *TextInput `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The resource name of the Serving Config to use. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
	// If this is not set, the default serving config will be used.
	ServingConfig string `protobuf:"bytes,3,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// The conversation to be used by auto session only. The name field will be
	// ignored as we automatically assign new name for the conversation in auto
	// session.
	Conversation *Conversation `protobuf:"bytes,5,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// Whether to turn on safe search.
	SafeSearch bool `protobuf:"varint,6,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,7,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// A specification for configuring the summary returned in the response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,8,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
	// The filter syntax consists of an expression language for constructing a
	// predicate from one or more fields of the documents being filtered. Filter
	// expression is case-sensitive. This will be used to filter search results
	// which may affect the summary response.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
	// key property defined in the Vertex AI Search backend -- this mapping is
	// defined by the customer in their schema. For example a media customer might
	// have a field 'name' in their schema. In this case the filter would look
	// like this: filter --> name:'ANY("king kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
	// Boost specification to boost certain documents in search results which may
	// affect the converse response. For more information on boosting, see
	// [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ConverseConversationRequest) Descriptor

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

Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.

func (*ConverseConversationRequest) GetBoostSpec

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 (*ConverseConversationRequest) GetUserLabels

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

func (*ConverseConversationRequest) ProtoMessage

func (*ConverseConversationRequest) ProtoMessage()

func (*ConverseConversationRequest) ProtoReflect

func (*ConverseConversationRequest) Reset

func (x *ConverseConversationRequest) Reset()

func (*ConverseConversationRequest) String

func (x *ConverseConversationRequest) String() string

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"`
	// 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.v1.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) GetReply

func (x *ConverseConversationResponse) GetReply() *Reply

func (*ConverseConversationResponse) GetSearchResults

func (*ConverseConversationResponse) ProtoMessage

func (*ConverseConversationResponse) ProtoMessage()

func (*ConverseConversationResponse) ProtoReflect

func (*ConverseConversationResponse) Reset

func (x *ConverseConversationResponse) Reset()

func (*ConverseConversationResponse) String

CreateControlRequest

type CreateControlRequest struct {

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

Request for CreateControl method.

func (*CreateControlRequest) Descriptor

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

Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.

func (*CreateControlRequest) GetControl

func (x *CreateControlRequest) GetControl() *Control

func (*CreateControlRequest) GetControlId

func (x *CreateControlRequest) GetControlId() string

func (*CreateControlRequest) GetParent

func (x *CreateControlRequest) GetParent() string

func (*CreateControlRequest) ProtoMessage

func (*CreateControlRequest) ProtoMessage()

func (*CreateControlRequest) ProtoReflect

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

func (*CreateControlRequest) Reset

func (x *CreateControlRequest) Reset()

func (*CreateControlRequest) String

func (x *CreateControlRequest) String() string

CreateConversationRequest

type CreateConversationRequest struct {

	// Required. Full resource name of parent data store. Format:
	// `projects/{project}/locations/{location}/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 (*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.v1.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 {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [DataStore][google.cloud.discoveryengine.v1.DataStore] to
	// create.
	DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The ID to use for the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore], which will become
	// the final component of the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore]'s resource name.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
	// A boolean flag indicating whether user want to directly create an advanced
	// data store for site search.
	// If the data store is not configured as site
	// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
	// be ignored.
	CreateAdvancedSiteSearch bool `protobuf:"varint,4,opt,name=create_advanced_site_search,json=createAdvancedSiteSearch,proto3" json:"create_advanced_site_search,omitempty"`
	// A boolean flag indicating whether to skip the default schema creation for
	// the data store. Only enable this flag if you are certain that the default
	// schema is incompatible with your use case.
	//
	// If set to true, you must manually create a schema for the data store before
	// any documents can be ingested.
	//
	// This flag cannot be specified if `data_store.starting_schema` is specified.
	SkipDefaultSchemaCreation bool `protobuf:"varint,7,opt,name=skip_default_schema_creation,json=skipDefaultSchemaCreation,proto3" json:"skip_default_schema_creation,omitempty"`
	// contains filtered or unexported fields
}

Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.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) GetSkipDefaultSchemaCreation

func (x *CreateDataStoreRequest) GetSkipDefaultSchemaCreation() bool

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.v1.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.v1.Document], which becomes the
	// final component of the
	// [Document.name][google.cloud.discoveryengine.v1.Document.name].
	//
	// If the caller does not have permission to create the
	// [Document][google.cloud.discoveryengine.v1.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.v1.Document]s with the same
	// [parent][google.cloud.discoveryengine.v1.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 128 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.v1.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.v1.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.v1.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.v1.Engine], which will become the
	// final component of the [Engine][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.Schema], which becomes the final
	// component of the
	// [Schema.name][google.cloud.discoveryengine.v1.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.v1.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}/locations/{location}/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

CreateSitemapMetadata

type CreateSitemapMetadata 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.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*CreateSitemapMetadata) Descriptor

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

Deprecated: Use CreateSitemapMetadata.ProtoReflect.Descriptor instead.

func (*CreateSitemapMetadata) GetCreateTime

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

func (*CreateSitemapMetadata) GetUpdateTime

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

func (*CreateSitemapMetadata) ProtoMessage

func (*CreateSitemapMetadata) ProtoMessage()

func (*CreateSitemapMetadata) ProtoReflect

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

func (*CreateSitemapMetadata) Reset

func (x *CreateSitemapMetadata) Reset()

func (*CreateSitemapMetadata) String

func (x *CreateSitemapMetadata) String() string

CreateSitemapRequest

type CreateSitemapRequest struct {

	// Required. Parent resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], such
	// as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Sitemap][google.cloud.discoveryengine.v1.Sitemap] to create.
	Sitemap *Sitemap `protobuf:"bytes,2,opt,name=sitemap,proto3" json:"sitemap,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] method.

func (*CreateSitemapRequest) Descriptor

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

Deprecated: Use CreateSitemapRequest.ProtoReflect.Descriptor instead.

func (*CreateSitemapRequest) GetParent

func (x *CreateSitemapRequest) GetParent() string

func (*CreateSitemapRequest) GetSitemap

func (x *CreateSitemapRequest) GetSitemap() *Sitemap

func (*CreateSitemapRequest) ProtoMessage

func (*CreateSitemapRequest) ProtoMessage()

func (*CreateSitemapRequest) ProtoReflect

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

func (*CreateSitemapRequest) Reset

func (x *CreateSitemapRequest) Reset()

func (*CreateSitemapRequest) String

func (x *CreateSitemapRequest) 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.v1.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.v1.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.v1.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.v1.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.v1.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1.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.v1.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1.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.v1.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

CustomTuningModel

type CustomTuningModel struct {

	// Required. The fully qualified resource name of the model.
	//
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
	//
	// Model must be an alpha-numerical string with limit of 40 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The display name of the model.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The version of the model.
	ModelVersion int64 `protobuf:"varint,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
	ModelState CustomTuningModel_ModelState `protobuf:"varint,4,opt,name=model_state,json=modelState,proto3,enum=google.cloud.discoveryengine.v1.CustomTuningModel_ModelState" json:"model_state,omitempty"`
	// Deprecated: Timestamp the Model was created at.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/custom_tuning_model.proto.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Timestamp the model training was initiated.
	TrainingStartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=training_start_time,json=trainingStartTime,proto3" json:"training_start_time,omitempty"`
	// The metrics of the trained model.
	Metrics map[string]float64 `protobuf:"bytes,7,rep,name=metrics,proto3" json:"metrics,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"fixed64,2,opt,name=value,proto3"`
	// Currently this is only populated if the model state is
	// `INPUT_VALIDATION_FAILED`.
	ErrorMessage string `protobuf:"bytes,8,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Metadata that describes a custom tuned model.

func (*CustomTuningModel) Descriptor

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

Deprecated: Use CustomTuningModel.ProtoReflect.Descriptor instead.

func (*CustomTuningModel) GetCreateTime

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

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

func (*CustomTuningModel) GetDisplayName

func (x *CustomTuningModel) GetDisplayName() string

func (*CustomTuningModel) GetErrorMessage

func (x *CustomTuningModel) GetErrorMessage() string

func (*CustomTuningModel) GetMetrics

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

func (*CustomTuningModel) GetModelState

func (*CustomTuningModel) GetModelVersion

func (x *CustomTuningModel) GetModelVersion() int64

func (*CustomTuningModel) GetName

func (x *CustomTuningModel) GetName() string

func (*CustomTuningModel) GetTrainingStartTime

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

func (*CustomTuningModel) ProtoMessage

func (*CustomTuningModel) ProtoMessage()

func (*CustomTuningModel) ProtoReflect

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

func (*CustomTuningModel) Reset

func (x *CustomTuningModel) Reset()

func (*CustomTuningModel) String

func (x *CustomTuningModel) String() string

CustomTuningModel_ModelState

type CustomTuningModel_ModelState int32

The state of the model.

CustomTuningModel_MODEL_STATE_UNSPECIFIED, CustomTuningModel_TRAINING_PAUSED, CustomTuningModel_TRAINING, CustomTuningModel_TRAINING_COMPLETE, CustomTuningModel_READY_FOR_SERVING, CustomTuningModel_TRAINING_FAILED, CustomTuningModel_NO_IMPROVEMENT, CustomTuningModel_INPUT_VALIDATION_FAILED

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

func (CustomTuningModel_ModelState) Descriptor

func (CustomTuningModel_ModelState) Enum

func (CustomTuningModel_ModelState) EnumDescriptor

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

Deprecated: Use CustomTuningModel_ModelState.Descriptor instead.

func (CustomTuningModel_ModelState) Number

func (CustomTuningModel_ModelState) String

func (CustomTuningModel_ModelState) Type

DataStore

type DataStore struct {

	// Immutable. The full resource name of the data store.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The data store display name.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Immutable. The industry vertical that the data store registers.
	IndustryVertical IndustryVertical `protobuf:"varint,3,opt,name=industry_vertical,json=industryVertical,proto3,enum=google.cloud.discoveryengine.v1.IndustryVertical" json:"industry_vertical,omitempty"`
	// The solutions that the data store enrolls. Available solutions for each
	// [industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]:
	//
	//   - `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
	//   - `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
	//     solutions cannot be enrolled.
	SolutionTypes []SolutionType `protobuf:"varint,5,rep,packed,name=solution_types,json=solutionTypes,proto3,enum=google.cloud.discoveryengine.v1.SolutionType" json:"solution_types,omitempty"`
	// Output only. The id of the default
	// [Schema][google.cloud.discoveryengine.v1.Schema] associated to this data
	// store.
	DefaultSchemaId string `protobuf:"bytes,7,opt,name=default_schema_id,json=defaultSchemaId,proto3" json:"default_schema_id,omitempty"`
	// Immutable. The content config of the data store. If this field is unset,
	// the server behavior defaults to
	// [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT].
	ContentConfig DataStore_ContentConfig `protobuf:"varint,6,opt,name=content_config,json=contentConfig,proto3,enum=google.cloud.discoveryengine.v1.DataStore_ContentConfig" json:"content_config,omitempty"`
	// Output only. Timestamp the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Optional. Configuration for advanced site search.
	AdvancedSiteSearchConfig *AdvancedSiteSearchConfig `protobuf:"bytes,12,opt,name=advanced_site_search_config,json=advancedSiteSearchConfig,proto3" json:"advanced_site_search_config,omitempty"`
	// Output only. Data size estimation for billing.
	BillingEstimation *DataStore_BillingEstimation `protobuf:"bytes,23,opt,name=billing_estimation,json=billingEstimation,proto3" json:"billing_estimation,omitempty"`
	// Config to store data store type configuration for workspace data. This
	// must be set when
	// [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config]
	// is set as
	// [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
	WorkspaceConfig *WorkspaceConfig `protobuf:"bytes,25,opt,name=workspace_config,json=workspaceConfig,proto3" json:"workspace_config,omitempty"`
	// Configuration for Document understanding and enrichment.
	DocumentProcessingConfig *DocumentProcessingConfig `protobuf:"bytes,27,opt,name=document_processing_config,json=documentProcessingConfig,proto3" json:"document_processing_config,omitempty"`
	// The start schema to use for this
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning
	// it. If unset, a default vertical specialized schema will be used.
	//
	// This field is only used by
	// [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore]
	// API, and will be ignored if used in other APIs. This field will be omitted
	// from all API responses including
	// [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore]
	// API. To retrieve a schema of a
	// [DataStore][google.cloud.discoveryengine.v1.DataStore], use
	// [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema]
	// API instead.
	//
	// The provided schema will be validated against certain rules on schema.
	// Learn more from [this
	// doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
	StartingSchema *Schema `protobuf:"bytes,28,opt,name=starting_schema,json=startingSchema,proto3" json:"starting_schema,omitempty"`
	// contains filtered or unexported fields
}

DataStore captures global settings and configs at the DataStore level.

func (*DataStore) Descriptor

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

Deprecated: Use DataStore.ProtoReflect.Descriptor instead.

func (*DataStore) GetAdvancedSiteSearchConfig

func (x *DataStore) GetAdvancedSiteSearchConfig() *AdvancedSiteSearchConfig

func (*DataStore) GetBillingEstimation

func (x *DataStore) GetBillingEstimation() *DataStore_BillingEstimation

func (*DataStore) GetContentConfig

func (x *DataStore) GetContentConfig() DataStore_ContentConfig

func (*DataStore) GetCreateTime

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

func (*DataStore) GetDefaultSchemaId

func (x *DataStore) GetDefaultSchemaId() string

func (*DataStore) GetDisplayName

func (x *DataStore) GetDisplayName() string

func (*DataStore) GetDocumentProcessingConfig

func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*DataStore) GetIndustryVertical

func (x *DataStore) GetIndustryVertical() IndustryVertical

func (*DataStore) GetName

func (x *DataStore) GetName() string

func (*DataStore) GetSolutionTypes

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

func (*DataStore) GetStartingSchema

func (x *DataStore) GetStartingSchema() *Schema

func (*DataStore) GetWorkspaceConfig

func (x *DataStore) GetWorkspaceConfig() *WorkspaceConfig

func (*DataStore) ProtoMessage

func (*DataStore) ProtoMessage()

func (*DataStore) ProtoReflect

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

func (*DataStore) Reset

func (x *DataStore) Reset()

func (*DataStore) String

func (x *DataStore) String() string

DataStoreServiceClient

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

DataStoreServiceServer is the server API for DataStoreService service.

DataStore_BillingEstimation

type DataStore_BillingEstimation struct {

	// Data size for structured data in terms of bytes.
	StructuredDataSize int64 `protobuf:"varint,1,opt,name=structured_data_size,json=structuredDataSize,proto3" json:"structured_data_size,omitempty"`
	// Data size for unstructured data in terms of bytes.
	UnstructuredDataSize int64 `protobuf:"varint,2,opt,name=unstructured_data_size,json=unstructuredDataSize,proto3" json:"unstructured_data_size,omitempty"`
	// Data size for websites in terms of bytes.
	WebsiteDataSize int64 `protobuf:"varint,3,opt,name=website_data_size,json=websiteDataSize,proto3" json:"website_data_size,omitempty"`
	// Last updated timestamp for structured data.
	StructuredDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=structured_data_update_time,json=structuredDataUpdateTime,proto3" json:"structured_data_update_time,omitempty"`
	// Last updated timestamp for unstructured data.
	UnstructuredDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=unstructured_data_update_time,json=unstructuredDataUpdateTime,proto3" json:"unstructured_data_update_time,omitempty"`
	// Last updated timestamp for websites.
	WebsiteDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=website_data_update_time,json=websiteDataUpdateTime,proto3" json:"website_data_update_time,omitempty"`
	// contains filtered or unexported fields
}

Estimation of data size per data store.

func (*DataStore_BillingEstimation) Descriptor

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

Deprecated: Use DataStore_BillingEstimation.ProtoReflect.Descriptor instead.

func (*DataStore_BillingEstimation) GetStructuredDataSize

func (x *DataStore_BillingEstimation) GetStructuredDataSize() int64

func (*DataStore_BillingEstimation) GetStructuredDataUpdateTime

func (x *DataStore_BillingEstimation) GetStructuredDataUpdateTime() *timestamppb.Timestamp

func (*DataStore_BillingEstimation) GetUnstructuredDataSize

func (x *DataStore_BillingEstimation) GetUnstructuredDataSize() int64

func (*DataStore_BillingEstimation) GetUnstructuredDataUpdateTime

func (x *DataStore_BillingEstimation) GetUnstructuredDataUpdateTime() *timestamppb.Timestamp

func (*DataStore_BillingEstimation) GetWebsiteDataSize

func (x *DataStore_BillingEstimation) GetWebsiteDataSize() int64

func (*DataStore_BillingEstimation) GetWebsiteDataUpdateTime

func (x *DataStore_BillingEstimation) GetWebsiteDataUpdateTime() *timestamppb.Timestamp

func (*DataStore_BillingEstimation) ProtoMessage

func (*DataStore_BillingEstimation) ProtoMessage()

func (*DataStore_BillingEstimation) ProtoReflect

func (*DataStore_BillingEstimation) Reset

func (x *DataStore_BillingEstimation) Reset()

func (*DataStore_BillingEstimation) String

func (x *DataStore_BillingEstimation) String() string

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, DataStore_GOOGLE_WORKSPACE

const (
	// Default value.
	DataStore_CONTENT_CONFIG_UNSPECIFIED DataStore_ContentConfig = 0
	// Only contains documents without any
	// [Document.content][google.cloud.discoveryengine.v1.Document.content].
	DataStore_NO_CONTENT DataStore_ContentConfig = 1
	// Only contains documents with
	// [Document.content][google.cloud.discoveryengine.v1.Document.content].
	DataStore_CONTENT_REQUIRED DataStore_ContentConfig = 2
	// The data store is used for public website search.
	DataStore_PUBLIC_WEBSITE DataStore_ContentConfig = 3
	// The data store is used for workspace search. Details of workspace
	// data store are specified in the
	// [WorkspaceConfig][google.cloud.discoveryengine.v1.WorkspaceConfig].
	DataStore_GOOGLE_WORKSPACE DataStore_ContentConfig = 4
)

func (DataStore_ContentConfig) Descriptor

func (DataStore_ContentConfig) Enum

func (DataStore_ContentConfig) EnumDescriptor

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

Deprecated: Use DataStore_ContentConfig.Descriptor instead.

func (DataStore_ContentConfig) Number

func (DataStore_ContentConfig) String

func (x DataStore_ContentConfig) String() string

func (DataStore_ContentConfig) Type

DeleteControlRequest

type DeleteControlRequest struct {

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

Request for DeleteControl method.

func (*DeleteControlRequest) Descriptor

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

Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.

func (*DeleteControlRequest) GetName

func (x *DeleteControlRequest) GetName() string

func (*DeleteControlRequest) ProtoMessage

func (*DeleteControlRequest) ProtoMessage()

func (*DeleteControlRequest) ProtoReflect

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

func (*DeleteControlRequest) Reset

func (x *DeleteControlRequest) Reset()

func (*DeleteControlRequest) String

func (x *DeleteControlRequest) String() string

DeleteConversationRequest

type DeleteConversationRequest struct {

	// Required. The resource name of the Conversation to delete. Format:
	// `projects/{project}/locations/{location}/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 (*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.v1.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.v1.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.v1.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.Document], regardless of whether
	// or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.Engine], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1.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.v1.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.v1.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}/locations/{location}/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

DeleteSitemapMetadata

type DeleteSitemapMetadata 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.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*DeleteSitemapMetadata) Descriptor

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

Deprecated: Use DeleteSitemapMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSitemapMetadata) GetCreateTime

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

func (*DeleteSitemapMetadata) GetUpdateTime

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

func (*DeleteSitemapMetadata) ProtoMessage

func (*DeleteSitemapMetadata) ProtoMessage()

func (*DeleteSitemapMetadata) ProtoReflect

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

func (*DeleteSitemapMetadata) Reset

func (x *DeleteSitemapMetadata) Reset()

func (*DeleteSitemapMetadata) String

func (x *DeleteSitemapMetadata) String() string

DeleteSitemapRequest

type DeleteSitemapRequest struct {

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

func (*DeleteSitemapRequest) Descriptor

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

Deprecated: Use DeleteSitemapRequest.ProtoReflect.Descriptor instead.

func (*DeleteSitemapRequest) GetName

func (x *DeleteSitemapRequest) GetName() string

func (*DeleteSitemapRequest) ProtoMessage

func (*DeleteSitemapRequest) ProtoMessage()

func (*DeleteSitemapRequest) ProtoReflect

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

func (*DeleteSitemapRequest) Reset

func (x *DeleteSitemapRequest) Reset()

func (*DeleteSitemapRequest) String

func (x *DeleteSitemapRequest) 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.v1.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.v1.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.v1.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [TargetSite][google.cloud.discoveryengine.v1.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.v1.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.v1.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 (*DisableAdvancedSiteSearchMetadata) GetUpdateTime

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()

func (*DisableAdvancedSiteSearchMetadata) ProtoReflect

func (*DisableAdvancedSiteSearchMetadata) Reset

func (*DisableAdvancedSiteSearchMetadata) String

DisableAdvancedSiteSearchRequest

type DisableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1.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.v1.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 (*DisableAdvancedSiteSearchRequest) Reset

func (*DisableAdvancedSiteSearchRequest) String

DisableAdvancedSiteSearchResponse

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

Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.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 (*DisableAdvancedSiteSearchResponse) Reset

func (*DisableAdvancedSiteSearchResponse) String

Document

type Document struct {

	// Data representation. One of
	// [struct_data][google.cloud.discoveryengine.v1.Document.struct_data] or
	// [json_data][google.cloud.discoveryengine.v1.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 128 characters.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The identifier of the schema located in the same data store.
	SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// The unstructured data linked to this document. Content must be set if this
	// document is under a
	// `CONTENT_REQUIRED` data store.
	Content *Document_Content `protobuf:"bytes,10,opt,name=content,proto3" json:"content,omitempty"`
	// The identifier of the parent document. Currently supports at most two level
	// document hierarchy.
	//
	// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters.
	ParentDocumentId string `protobuf:"bytes,7,opt,name=parent_document_id,json=parentDocumentId,proto3" json:"parent_document_id,omitempty"`
	// Output only. This field is OUTPUT_ONLY.
	// It contains derived data that are not in the original input document.
	DerivedStructData *structpb.Struct `protobuf:"bytes,6,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
	// Output only. The last time the document was indexed. If this field is set,
	// the document could be returned in search results.
	//
	// This field is OUTPUT_ONLY. If this field is not populated, it means the
	// document has never been indexed.
	IndexTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
	// Output only. The index status of the document.
	//
	//   - If document is indexed successfully, the index_time field is populated.
	//   - Otherwise, if document is not indexed due to errors, the error_samples
	//     field is populated.
	//   - Otherwise, if document's index is in progress, the pending_message field
	//     is populated.
	IndexStatus *Document_IndexStatus `protobuf:"bytes,15,opt,name=index_status,json=indexStatus,proto3" json:"index_status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document) Descriptor

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

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 (x *Document) GetDerivedStructData() *structpb.Struct

func (*Document) GetId

func (x *Document) GetId() string

func (*Document) GetIndexStatus

func (x *Document) GetIndexStatus() *Document_IndexStatus

func (*Document) GetIndexTime

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

func (*Document) GetJsonData

func (x *Document) GetJsonData() string

func (*Document) GetName

func (x *Document) GetName() string

func (*Document) GetParentDocumentId

func (x *Document) GetParentDocumentId() string

func (*Document) GetSchemaId

func (x *Document) GetSchemaId() string

func (*Document) GetStructData

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

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

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

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

DocumentInfo

type DocumentInfo struct {

	// A required descriptor of the associated
	// [Document][google.cloud.discoveryengine.v1.Document].
	//
	// * If [id][google.cloud.discoveryengine.v1.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.v1.DocumentInfo.name] is
	// specified, then the provided values (default values allowed) for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and
	// `{branch_id}` are used when annotating with the stored Document.
	//
	// Types that are assignable to DocumentDescriptor:
	//
	//	*DocumentInfo_Id
	//	*DocumentInfo_Name
	//	*DocumentInfo_Uri
	DocumentDescriptor isDocumentInfo_DocumentDescriptor `protobuf_oneof:"document_descriptor"`
	// Quantity of the Document associated with the user event. Defaults to 1.
	//
	// For example, this field is 2 if two quantities of the same Document
	// are involved in a `add-to-cart` event.
	//
	// Required for events of the following event types:
	//
	// * `add-to-cart`
	// * `purchase`
	Quantity *int32 `protobuf:"varint,3,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
	// The promotion IDs associated with this Document.
	// Currently, this field is restricted to at most one ID.
	PromotionIds []string `protobuf:"bytes,4,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
	// Output only. Whether the referenced Document can be found in the data
	// store.
	Joined bool `protobuf:"varint,5,opt,name=joined,proto3" json:"joined,omitempty"`
	// Optional. The conversion value associated with this Document.
	// Must be set if
	// [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type]
	// is "conversion".
	//
	// For example, a value of 1000 signifies that 1000 seconds were spent viewing
	// a Document for the `watch` conversion type.
	ConversionValue *float32 `protobuf:"fixed32,7,opt,name=conversion_value,json=conversionValue,proto3,oneof" json:"conversion_value,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) GetConversionValue

func (x *DocumentInfo) GetConversionValue() float32

func (*DocumentInfo) GetDocumentDescriptor

func (m *DocumentInfo) GetDocumentDescriptor() isDocumentInfo_DocumentDescriptor

func (*DocumentInfo) GetId

func (x *DocumentInfo) GetId() string

func (*DocumentInfo) GetJoined

func (x *DocumentInfo) GetJoined() bool

func (*DocumentInfo) GetName

func (x *DocumentInfo) GetName() string

func (*DocumentInfo) GetPromotionIds

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

func (*DocumentInfo) GetQuantity

func (x *DocumentInfo) GetQuantity() int32

func (*DocumentInfo) GetUri

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.v1.Document] resource ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

DocumentInfo_Name

type DocumentInfo_Name struct {
	// The [Document][google.cloud.discoveryengine.v1.Document] resource full
	// name, of the form:
	// `projects/{project}/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.v1.Document] URI - only
	// allowed for website data stores.
	Uri string `protobuf:"bytes,6,opt,name=uri,proto3,oneof"`
}

DocumentProcessingConfig

type DocumentProcessingConfig struct {

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

A singleton resource of [DataStore][google.cloud.discoveryengine.v1.DataStore]. If it's empty when [DataStore][google.cloud.discoveryengine.v1.DataStore] is created and [DataStore][google.cloud.discoveryengine.v1.DataStore] is set to [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1.DataStore.ContentConfig.CONTENT_REQUIRED], the default parser will default to digital parser.

func (*DocumentProcessingConfig) Descriptor

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

Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig) GetChunkingConfig

func (*DocumentProcessingConfig) GetDefaultParsingConfig

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_ChunkingConfig

type DocumentProcessingConfig_ChunkingConfig struct {

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

Configuration for chunking config.

func (*DocumentProcessingConfig_ChunkingConfig) Descriptor

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode

func (m *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkMode

func (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage

func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect

func (*DocumentProcessingConfig_ChunkingConfig) Reset

func (*DocumentProcessingConfig_ChunkingConfig) String

DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {

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

Configuration for the layout based chunking.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Descriptor

Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String

DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_

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

DocumentProcessingConfig_ParsingConfig

type DocumentProcessingConfig_ParsingConfig struct {

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

Related configurations applied to a specific type of document parser.

func (*DocumentProcessingConfig_ParsingConfig) Descriptor

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig

func (m *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage

func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect

func (*DocumentProcessingConfig_ParsingConfig) Reset

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) 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_LayoutParsingConfig

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

The layout parsing configurations for documents.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Descriptor

Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String

DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_

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

DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {

	// [DEPRECATED] This field is deprecated. To use the additional enhanced
	// document elements processing, please switch to `layout_parsing_config`.
	//
	// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1/document_processing_config.proto.
	EnhancedDocumentElements []string `protobuf:"bytes,1,rep,name=enhanced_document_elements,json=enhancedDocumentElements,proto3" json:"enhanced_document_elements,omitempty"`
	// If true, will use native text instead of OCR text on pages containing
	// native text.
	UseNativeText bool `protobuf:"varint,2,opt,name=use_native_text,json=useNativeText,proto3" json:"use_native_text,omitempty"`
	// contains filtered or unexported fields
}

The OCR parsing configurations for documents.

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor

Deprecated: 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/v1/document_processing_config.proto.

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset

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

DocumentServiceClient is the client API for DocumentService service.

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

func NewDocumentServiceClient

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

DocumentServiceServer

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

Document_IndexStatus

type Document_IndexStatus struct {

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

Index status of the document.

func (*Document_IndexStatus) Descriptor

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

Deprecated: Use Document_IndexStatus.ProtoReflect.Descriptor instead.

func (*Document_IndexStatus) GetErrorSamples

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

func (*Document_IndexStatus) GetIndexTime

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

func (*Document_IndexStatus) GetPendingMessage

func (x *Document_IndexStatus) GetPendingMessage() string

func (*Document_IndexStatus) ProtoMessage

func (*Document_IndexStatus) ProtoMessage()

func (*Document_IndexStatus) ProtoReflect

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

func (*Document_IndexStatus) Reset

func (x *Document_IndexStatus) Reset()

func (*Document_IndexStatus) String

func (x *Document_IndexStatus) String() string

Document_JsonData

type Document_JsonData struct {
	// The JSON string representation of the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1.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.v1.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

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.v1.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 (*EnableAdvancedSiteSearchMetadata) GetUpdateTime

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()

func (*EnableAdvancedSiteSearchMetadata) ProtoReflect

func (*EnableAdvancedSiteSearchMetadata) Reset

func (*EnableAdvancedSiteSearchMetadata) String

EnableAdvancedSiteSearchRequest

type EnableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1.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.v1.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 (*EnableAdvancedSiteSearchRequest) Reset

func (*EnableAdvancedSiteSearchRequest) String

EnableAdvancedSiteSearchResponse

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

Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.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 (*EnableAdvancedSiteSearchResponse) Reset

func (*EnableAdvancedSiteSearchResponse) String

Engine

type Engine struct {

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

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

func (*Engine) Descriptor

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

Deprecated: Use Engine.ProtoReflect.Descriptor instead.

func (*Engine) GetChatEngineConfig

func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig

func (*Engine) GetChatEngineMetadata

func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata

func (*Engine) GetCommonConfig

func (x *Engine) GetCommonConfig() *Engine_CommonConfig

func (*Engine) GetCreateTime

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

func (*Engine) GetDataStoreIds

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

func (*Engine) GetDisableAnalytics

func (x *Engine) GetDisableAnalytics() bool

func (*Engine) GetDisplayName

func (x *Engine) GetDisplayName() string

func (*Engine) GetEngineConfig

func (m *Engine) GetEngineConfig() isEngine_EngineConfig

func (*Engine) GetEngineMetadata

func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata

func (*Engine) GetIndustryVertical

func (x *Engine) GetIndustryVertical() IndustryVertical

func (*Engine) GetName

func (x *Engine) GetName() string

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

func (x *Engine) String() string

EngineServiceClient

type EngineServiceClient interface {
	// Creates a [Engine][google.cloud.discoveryengine.v1.Engine].
	CreateEngine(ctx context.Context, in *CreateEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].
	DeleteEngine(ctx context.Context, in *DeleteEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1.Engine]
	UpdateEngine(ctx context.Context, in *UpdateEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1.Engine].
	GetEngine(ctx context.Context, in *GetEngineRequest, opts ...grpc.CallOption) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated
	// with the project.
	ListEngines(ctx context.Context, in *ListEnginesRequest, opts ...grpc.CallOption) (*ListEnginesResponse, 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.v1.Engine].
	CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)
	// Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].
	DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)
	// Updates an [Engine][google.cloud.discoveryengine.v1.Engine]
	UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)
	// Gets a [Engine][google.cloud.discoveryengine.v1.Engine].
	GetEngine(context.Context, *GetEngineRequest) (*Engine, error)
	// Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated
	// with the project.
	ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)
}

EngineServiceServer is the server API for EngineService service.

Engine_ChatEngineConfig

type Engine_ChatEngineConfig struct {

	// The configurationt generate the Dialogflow agent that is associated to
	// this Engine.
	//
	// Note that these configurations are one-time consumed by
	// and passed to Dialogflow service. It means they cannot be retrieved using
	// [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
	// API after engine creation.
	AgentCreationConfig *Engine_ChatEngineConfig_AgentCreationConfig `protobuf:"bytes,1,opt,name=agent_creation_config,json=agentCreationConfig,proto3" json:"agent_creation_config,omitempty"`
	// The resource name of an exist Dialogflow agent to link to this Chat
	// Engine. Customers can either provide `agent_creation_config` to create
	// agent or provide an agent name that links the agent with the Chat engine.
	//
	// Format: `projects/

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 (*Engine_ChatEngineConfig) GetAllowCrossRegion

func (x *Engine_ChatEngineConfig) GetAllowCrossRegion() bool
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.v1.Engine.solution_type] is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.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.v1.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] API after engine creation.

func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor

Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect

func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset

func (*Engine_ChatEngineConfig_AgentCreationConfig) String

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 (*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.v1.Engine.solution_type]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.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 {

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

	// The search feature tier of this engine.
	//
	// Different tiers might have different
	// pricing. To learn more, check the pricing documentation.
	//
	// Defaults to
	// [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1.SearchTier.SEARCH_TIER_STANDARD]
	// if not specified.
	SearchTier SearchTier `protobuf:"varint,1,opt,name=search_tier,json=searchTier,proto3,enum=google.cloud.discoveryengine.v1.SearchTier" json:"search_tier,omitempty"`
	// The add-on that this search engine enables.
	SearchAddOns []SearchAddOn `protobuf:"varint,2,rep,packed,name=search_add_ons,json=searchAddOns,proto3,enum=google.cloud.discoveryengine.v1.SearchAddOn" json:"search_add_ons,omitempty"`
	// contains filtered or unexported fields
}

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 (*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.v1.Engine.solution_type] is
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
	SearchEngineConfig *Engine_SearchEngineConfig `protobuf:"bytes,13,opt,name=search_engine_config,json=searchEngineConfig,proto3,oneof"`
}

FactChunk

type FactChunk struct {

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

Fact Chunk.

func (*FactChunk) Descriptor

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

Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.

func (*FactChunk) GetChunkText

func (x *FactChunk) GetChunkText() string

func (*FactChunk) GetIndex

func (x *FactChunk) GetIndex() int32

func (*FactChunk) GetSource

func (x *FactChunk) GetSource() string

func (*FactChunk) GetSourceMetadata

func (x *FactChunk) GetSourceMetadata() map[string]string

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

func (x *FactChunk) String() 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.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusRequest) Descriptor

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

Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusRequest) GetPageSize

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 (*FetchDomainVerificationStatusRequest) Reset

func (*FetchDomainVerificationStatusRequest) 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.v1.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 (*FetchDomainVerificationStatusResponse) Reset

func (*FetchDomainVerificationStatusResponse) String

FetchSitemapsRequest

type FetchSitemapsRequest struct {

	// Required. Parent resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], such
	// as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. If specified, fetches the matching
	// [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. If not specified,
	// fetches all [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore].
	Matcher *FetchSitemapsRequest_Matcher `protobuf:"bytes,2,opt,name=matcher,proto3" json:"matcher,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] method.

func (*FetchSitemapsRequest) Descriptor

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

Deprecated: Use FetchSitemapsRequest.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest) GetMatcher

func (*FetchSitemapsRequest) GetParent

func (x *FetchSitemapsRequest) GetParent() string

func (*FetchSitemapsRequest) ProtoMessage

func (*FetchSitemapsRequest) ProtoMessage()

func (*FetchSitemapsRequest) ProtoReflect

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

func (*FetchSitemapsRequest) Reset

func (x *FetchSitemapsRequest) Reset()

func (*FetchSitemapsRequest) String

func (x *FetchSitemapsRequest) String() string

FetchSitemapsRequest_Matcher

type FetchSitemapsRequest_Matcher struct {

	// Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s.
	//
	// Types that are assignable to Matcher:
	//
	//	*FetchSitemapsRequest_Matcher_UrisMatcher
	Matcher isFetchSitemapsRequest_Matcher_Matcher `protobuf_oneof:"matcher"`
	// contains filtered or unexported fields
}

Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. Currently only supports uris matcher.

func (*FetchSitemapsRequest_Matcher) Descriptor

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

Deprecated: Use FetchSitemapsRequest_Matcher.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest_Matcher) GetMatcher

func (m *FetchSitemapsRequest_Matcher) GetMatcher() isFetchSitemapsRequest_Matcher_Matcher

func (*FetchSitemapsRequest_Matcher) GetUrisMatcher

func (*FetchSitemapsRequest_Matcher) ProtoMessage

func (*FetchSitemapsRequest_Matcher) ProtoMessage()

func (*FetchSitemapsRequest_Matcher) ProtoReflect

func (*FetchSitemapsRequest_Matcher) Reset

func (x *FetchSitemapsRequest_Matcher) Reset()

func (*FetchSitemapsRequest_Matcher) String

FetchSitemapsRequest_Matcher_UrisMatcher

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

FetchSitemapsRequest_UrisMatcher

type FetchSitemapsRequest_UrisMatcher struct {

	// The [Sitemap][google.cloud.discoveryengine.v1.Sitemap] uris.
	Uris []string `protobuf:"bytes,1,rep,name=uris,proto3" json:"uris,omitempty"`
	// contains filtered or unexported fields
}

Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s by their uris.

func (*FetchSitemapsRequest_UrisMatcher) Descriptor

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

Deprecated: Use FetchSitemapsRequest_UrisMatcher.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest_UrisMatcher) GetUris

func (*FetchSitemapsRequest_UrisMatcher) ProtoMessage

func (*FetchSitemapsRequest_UrisMatcher) ProtoMessage()

func (*FetchSitemapsRequest_UrisMatcher) ProtoReflect

func (*FetchSitemapsRequest_UrisMatcher) Reset

func (*FetchSitemapsRequest_UrisMatcher) String

FetchSitemapsResponse

type FetchSitemapsResponse struct {

	// List of [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s fetched.
	SitemapsMetadata []*FetchSitemapsResponse_SitemapMetadata `protobuf:"bytes,1,rep,name=sitemaps_metadata,json=sitemapsMetadata,proto3" json:"sitemaps_metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] method.

func (*FetchSitemapsResponse) Descriptor

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

Deprecated: Use FetchSitemapsResponse.ProtoReflect.Descriptor instead.

func (*FetchSitemapsResponse) GetSitemapsMetadata

func (*FetchSitemapsResponse) ProtoMessage

func (*FetchSitemapsResponse) ProtoMessage()

func (*FetchSitemapsResponse) ProtoReflect

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

func (*FetchSitemapsResponse) Reset

func (x *FetchSitemapsResponse) Reset()

func (*FetchSitemapsResponse) String

func (x *FetchSitemapsResponse) String() string

FetchSitemapsResponse_SitemapMetadata

type FetchSitemapsResponse_SitemapMetadata struct {

	// The [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
	Sitemap *Sitemap `protobuf:"bytes,1,opt,name=sitemap,proto3" json:"sitemap,omitempty"`
	// contains filtered or unexported fields
}

Contains a [Sitemap][google.cloud.discoveryengine.v1.Sitemap] and its metadata.

func (*FetchSitemapsResponse_SitemapMetadata) Descriptor

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

Deprecated: Use FetchSitemapsResponse_SitemapMetadata.ProtoReflect.Descriptor instead.

func (*FetchSitemapsResponse_SitemapMetadata) GetSitemap

func (*FetchSitemapsResponse_SitemapMetadata) ProtoMessage

func (*FetchSitemapsResponse_SitemapMetadata) ProtoMessage()

func (*FetchSitemapsResponse_SitemapMetadata) ProtoReflect

func (*FetchSitemapsResponse_SitemapMetadata) Reset

func (*FetchSitemapsResponse_SitemapMetadata) 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"`
	// The FHIR resource types to import. The resource types should be a subset of
	// all [supported FHIR resource
	// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
	// Default to all supported FHIR resource types if empty.
	ResourceTypes []string `protobuf:"bytes,3,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
	// Optional. Whether to update the DataStore schema to the latest predefined
	// schema.
	//
	// If true, the DataStore schema will be updated to include any FHIR fields
	// or resource types that have been added since the last import and
	// corresponding FHIR resources will be imported from the FHIR store.
	//
	// Note this field cannot be used in conjunction with `resource_types`. It
	// should be used after initial import.
	UpdateFromLatestPredefinedSchema bool `protobuf:"varint,4,opt,name=update_from_latest_predefined_schema,json=updateFromLatestPredefinedSchema,proto3" json:"update_from_latest_predefined_schema,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) GetResourceTypes

func (x *FhirStoreSource) GetResourceTypes() []string

func (*FhirStoreSource) GetUpdateFromLatestPredefinedSchema

func (x *FhirStoreSource) GetUpdateFromLatestPredefinedSchema() bool

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 (or entity) to copy the data from with a
	// length limit of 1,500 characters.
	CollectionId string `protobuf:"bytes,3,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// Firestore export to a specific Cloud Storage directory.
	//
	// Ensure that the Firestore service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// contains filtered or unexported fields
}

Firestore source import data from.

func (*FirestoreSource) Descriptor

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. Each URI can be up to
	// 2000 characters long. URIs can match the full object path (for example,
	// `gs://bucket/directory/object.json`) or a pattern matching one or more
	// files, such as `gs://bucket/directory/*.json`.
	//
	// A request can contain at most 100 files (or 100,000 files if `data_schema`
	// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
	// `content`).
	InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One JSON
	// [Document][google.cloud.discoveryengine.v1.Document] per line. Each
	// document must
	//
	//	have a valid [Document.id][google.cloud.discoveryengine.v1.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.v1.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.v1.Schema] of the
	//
	//	data store. Each entry after the header is imported as a Document.
	//	This can only be used by the GENERIC Data Store vertical.
	//
	// Supported values for user event imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.discoveryengine.v1.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

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

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris

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

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

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

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

GenerateGroundedContentRequest

type GenerateGroundedContentRequest struct {

	// Required. Location resource.
	//
	// Format: `projects/{project}/locations/{location}`.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// Content of the system instruction for the current API.
	//
	// These instructions will take priority over any other prompt instructions
	// if the selected model is supporting them.
	SystemInstruction *GroundedGenerationContent `protobuf:"bytes,5,opt,name=system_instruction,json=systemInstruction,proto3" json:"system_instruction,omitempty"`
	// Content of the current conversation with the model.
	//
	// For single-turn queries, this is a single instance. For multi-turn queries,
	// this is a repeated field that contains conversation history + latest
	// request.
	Contents []*GroundedGenerationContent `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// Content generation specification.
	GenerationSpec *GenerateGroundedContentRequest_GenerationSpec `protobuf:"bytes,3,opt,name=generation_spec,json=generationSpec,proto3" json:"generation_spec,omitempty"`
	// Grounding specification.
	GroundingSpec *GenerateGroundedContentRequest_GroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,6,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Top-level message sent by the client for the GenerateGroundedContent method.

func (*GenerateGroundedContentRequest) Descriptor

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

Deprecated: Use GenerateGroundedContentRequest.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest) GetContents

func (*GenerateGroundedContentRequest) GetGenerationSpec

func (*GenerateGroundedContentRequest) GetGroundingSpec

func (*GenerateGroundedContentRequest) GetLocation

func (x *GenerateGroundedContentRequest) GetLocation() string

func (*GenerateGroundedContentRequest) GetSystemInstruction

func (x *GenerateGroundedContentRequest) GetSystemInstruction() *GroundedGenerationContent

func (*GenerateGroundedContentRequest) GetUserLabels

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

func (*GenerateGroundedContentRequest) ProtoMessage

func (*GenerateGroundedContentRequest) ProtoMessage()

func (*GenerateGroundedContentRequest) ProtoReflect

func (*GenerateGroundedContentRequest) Reset

func (x *GenerateGroundedContentRequest) Reset()

func (*GenerateGroundedContentRequest) String

GenerateGroundedContentRequest_DynamicRetrievalConfiguration

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration struct {

	// Specification for the predictor for dynamic retrieval.
	Predictor *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor `protobuf:"bytes,1,opt,name=predictor,proto3" json:"predictor,omitempty"`
	// contains filtered or unexported fields
}

Describes the options to customize dynamic retrieval.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) Descriptor

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) GetPredictor

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoMessage

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoReflect

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) Reset

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) String

GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor struct {

	// The version of the predictor to be used in dynamic retrieval.
	Version GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version `protobuf:"varint,1,opt,name=version,proto3,enum=google.cloud.discoveryengine.v1.GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version" json:"version,omitempty"`
	// The value of the threshold. If the predictor will predict a
	// value smaller than this, it would suppress grounding in the source.
	Threshold *float32 `protobuf:"fixed32,2,opt,name=threshold,proto3,oneof" json:"threshold,omitempty"`
	// contains filtered or unexported fields
}

Describes the predictor settings for dynamic retrieval.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) Descriptor

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetThreshold

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetVersion

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoMessage

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoReflect

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) Reset

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) String

GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version int32

The version of the predictor to be used in dynamic retrieval.

GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_VERSION_UNSPECIFIED, GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_V1_INDEPENDENT

const (
	// Automatically choose the best version of the retrieval predictor.
	GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_VERSION_UNSPECIFIED GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version = 0
	// The V1 model which is evaluating each source independently.
	GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_V1_INDEPENDENT GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version = 1
)

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Descriptor

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Enum

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) EnumDescriptor

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version.Descriptor instead.

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Number

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) String

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Type

GenerateGroundedContentRequest_GenerationSpec

type GenerateGroundedContentRequest_GenerationSpec struct {

	// Specifies which Vertex model id to use for generation.
	ModelId string `protobuf:"bytes,3,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// Language code for content. Use language tags defined by
	// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
	LanguageCode string `protobuf:"bytes,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// If specified, custom value for the temperature will be used.
	Temperature *float32 `protobuf:"fixed32,4,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// If specified, custom value for nucleus sampling will be used.
	TopP *float32 `protobuf:"fixed32,5,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// If specified, custom value for top-k sampling will be used.
	TopK *int32 `protobuf:"varint,7,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// If specified, custom value for frequency penalty will be used.
	FrequencyPenalty *float32 `protobuf:"fixed32,8,opt,name=frequency_penalty,json=frequencyPenalty,proto3,oneof" json:"frequency_penalty,omitempty"`
	// If specified, custom value for the seed will be used.
	Seed *int32 `protobuf:"varint,12,opt,name=seed,proto3,oneof" json:"seed,omitempty"`
	// If specified, custom value for presence penalty will be used.
	PresencePenalty *float32 `protobuf:"fixed32,9,opt,name=presence_penalty,json=presencePenalty,proto3,oneof" json:"presence_penalty,omitempty"`
	// If specified, custom value for max output tokens will be used.
	MaxOutputTokens *int32 `protobuf:"varint,10,opt,name=max_output_tokens,json=maxOutputTokens,proto3,oneof" json:"max_output_tokens,omitempty"`
	// contains filtered or unexported fields
}

Content generation specification.

func (*GenerateGroundedContentRequest_GenerationSpec) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GenerationSpec.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GenerationSpec) GetFrequencyPenalty

func (x *GenerateGroundedContentRequest_GenerationSpec) GetFrequencyPenalty() float32

func (*GenerateGroundedContentRequest_GenerationSpec) GetLanguageCode

func (*GenerateGroundedContentRequest_GenerationSpec) GetMaxOutputTokens

func (x *GenerateGroundedContentRequest_GenerationSpec) GetMaxOutputTokens() int32

func (*GenerateGroundedContentRequest_GenerationSpec) GetModelId

func (*GenerateGroundedContentRequest_GenerationSpec) GetPresencePenalty

func (*GenerateGroundedContentRequest_GenerationSpec) GetSeed

func (*GenerateGroundedContentRequest_GenerationSpec) GetTemperature

func (*GenerateGroundedContentRequest_GenerationSpec) GetTopK

func (*GenerateGroundedContentRequest_GenerationSpec) GetTopP

func (*GenerateGroundedContentRequest_GenerationSpec) ProtoMessage

func (*GenerateGroundedContentRequest_GenerationSpec) ProtoReflect

func (*GenerateGroundedContentRequest_GenerationSpec) Reset

func (*GenerateGroundedContentRequest_GenerationSpec) String

GenerateGroundedContentRequest_GroundingSource

type GenerateGroundedContentRequest_GroundingSource struct {

	// Sources.
	//
	// Types that are assignable to Source:
	//
	//	*GenerateGroundedContentRequest_GroundingSource_InlineSource_
	//	*GenerateGroundedContentRequest_GroundingSource_SearchSource_
	//	*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource_
	//	*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource_
	Source isGenerateGroundedContentRequest_GroundingSource_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

Grounding source.

func (*GenerateGroundedContentRequest_GroundingSource) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource) GetEnterpriseWebRetrievalSource

func (*GenerateGroundedContentRequest_GroundingSource) GetGoogleSearchSource

func (*GenerateGroundedContentRequest_GroundingSource) GetInlineSource

func (*GenerateGroundedContentRequest_GroundingSource) GetSearchSource

func (*GenerateGroundedContentRequest_GroundingSource) GetSource

func (m *GenerateGroundedContentRequest_GroundingSource) GetSource() isGenerateGroundedContentRequest_GroundingSource_Source

func (*GenerateGroundedContentRequest_GroundingSource) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSource) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSource) Reset

func (*GenerateGroundedContentRequest_GroundingSource) String

GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource

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

Params for using enterprise web retrieval as grounding source.

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) Reset

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) String

GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource_

type GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource_ struct {
	// If set, grounding is performed with enterprise web retrieval.
	EnterpriseWebRetrievalSource *GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource `protobuf:"bytes,8,opt,name=enterprise_web_retrieval_source,json=enterpriseWebRetrievalSource,proto3,oneof"`
}

GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource

type GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource struct {

	// Optional. Specifies the dynamic retrieval configuration for the given
	// source.
	DynamicRetrievalConfig *GenerateGroundedContentRequest_DynamicRetrievalConfiguration `protobuf:"bytes,2,opt,name=dynamic_retrieval_config,json=dynamicRetrievalConfig,proto3" json:"dynamic_retrieval_config,omitempty"`
	// contains filtered or unexported fields
}

Google Search config parameters.

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) GetDynamicRetrievalConfig

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Reset

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) String

GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource_

type GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource_ struct {
	// If set, grounding is performed with Google Search.
	GoogleSearchSource *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource `protobuf:"bytes,3,opt,name=google_search_source,json=googleSearchSource,proto3,oneof"`
}

GenerateGroundedContentRequest_GroundingSource_InlineSource

type GenerateGroundedContentRequest_GroundingSource_InlineSource struct {

	// List of facts to be used for grounding.
	GroundingFacts []*GroundingFact `protobuf:"bytes,1,rep,name=grounding_facts,json=groundingFacts,proto3" json:"grounding_facts,omitempty"`
	// Attributes associated with the content.
	//
	// Common attributes include `source` (indicating where the content was
	// sourced from) and `author` (indicating the author of the content).
	Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Message to be used for grounding based on inline content.

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_InlineSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) GetAttributes

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) GetGroundingFacts

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) Reset

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) String

GenerateGroundedContentRequest_GroundingSource_InlineSource_

type GenerateGroundedContentRequest_GroundingSource_InlineSource_ struct {
	// If set, grounding is performed with inline content.
	InlineSource *GenerateGroundedContentRequest_GroundingSource_InlineSource `protobuf:"bytes,1,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

GenerateGroundedContentRequest_GroundingSource_SearchSource

type GenerateGroundedContentRequest_GroundingSource_SearchSource struct {

	// The resource name of the Engine to use.
	//
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Number of search results to return.
	//
	// The default value is 10. The maximumm allowed value is 10.
	MaxResultCount int32 `protobuf:"varint,2,opt,name=max_result_count,json=maxResultCount,proto3" json:"max_result_count,omitempty"`
	// Filter expression to be applied to the search.
	//
	// The syntax is the same as
	// [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// If set, safe search is enabled in Vertex AI Search requests.
	SafeSearch bool `protobuf:"varint,5,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
	// contains filtered or unexported fields
}

Message to be used for grounding with Vertex AI Search.

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_SearchSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetFilter

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetMaxResultCount

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetSafeSearch

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetServingConfig

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) Reset

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) String

GenerateGroundedContentRequest_GroundingSource_SearchSource_

type GenerateGroundedContentRequest_GroundingSource_SearchSource_ struct {
	// If set, grounding is performed with Vertex AI Search.
	SearchSource *GenerateGroundedContentRequest_GroundingSource_SearchSource `protobuf:"bytes,2,opt,name=search_source,json=searchSource,proto3,oneof"`
}

GenerateGroundedContentRequest_GroundingSpec

type GenerateGroundedContentRequest_GroundingSpec struct {

	// Grounding sources.
	GroundingSources []*GenerateGroundedContentRequest_GroundingSource `protobuf:"bytes,1,rep,name=grounding_sources,json=groundingSources,proto3" json:"grounding_sources,omitempty"`
	// contains filtered or unexported fields
}

Grounding specification.

func (*GenerateGroundedContentRequest_GroundingSpec) Descriptor

Deprecated: Use GenerateGroundedContentRequest_GroundingSpec.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSpec) GetGroundingSources

func (*GenerateGroundedContentRequest_GroundingSpec) ProtoMessage

func (*GenerateGroundedContentRequest_GroundingSpec) ProtoReflect

func (*GenerateGroundedContentRequest_GroundingSpec) Reset

func (*GenerateGroundedContentRequest_GroundingSpec) String

GenerateGroundedContentResponse

type GenerateGroundedContentResponse struct {

	// Generated candidates.
	Candidates []*GenerateGroundedContentResponse_Candidate `protobuf:"bytes,1,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// contains filtered or unexported fields
}

Response for the GenerateGroundedContent method.

func (*GenerateGroundedContentResponse) Descriptor

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

Deprecated: Use GenerateGroundedContentResponse.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse) GetCandidates

func (*GenerateGroundedContentResponse) ProtoMessage

func (*GenerateGroundedContentResponse) ProtoMessage()

func (*GenerateGroundedContentResponse) ProtoReflect

func (*GenerateGroundedContentResponse) Reset

func (*GenerateGroundedContentResponse) String

GenerateGroundedContentResponse_Candidate

type GenerateGroundedContentResponse_Candidate struct {

	// Index of the candidate.
	Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
	// Content of the candidate.
	Content *GroundedGenerationContent `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// The overall grounding score for the candidate, in the range of [0, 1].
	GroundingScore *float32 `protobuf:"fixed32,3,opt,name=grounding_score,json=groundingScore,proto3,oneof" json:"grounding_score,omitempty"`
	// Grounding metadata for the generated content.
	GroundingMetadata *GenerateGroundedContentResponse_Candidate_GroundingMetadata `protobuf:"bytes,4,opt,name=grounding_metadata,json=groundingMetadata,proto3" json:"grounding_metadata,omitempty"`
	// contains filtered or unexported fields
}

A response candidate generated from the model.

func (*GenerateGroundedContentResponse_Candidate) Descriptor

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

Deprecated: Use GenerateGroundedContentResponse_Candidate.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate) GetContent

func (*GenerateGroundedContentResponse_Candidate) GetGroundingMetadata

func (*GenerateGroundedContentResponse_Candidate) GetGroundingScore

func (x *GenerateGroundedContentResponse_Candidate) GetGroundingScore() float32

func (*GenerateGroundedContentResponse_Candidate) GetIndex

func (*GenerateGroundedContentResponse_Candidate) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate) Reset

func (*GenerateGroundedContentResponse_Candidate) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata

type GenerateGroundedContentResponse_Candidate_GroundingMetadata struct {

	// Retrieval metadata to provide an understanding in the
	// retrieval steps performed by the model. There can be multiple such
	// messages which can correspond to different parts of the retrieval. This
	// is a mechanism used to ensure transparency to our users.
	RetrievalMetadata []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata `protobuf:"bytes,5,rep,name=retrieval_metadata,json=retrievalMetadata,proto3" json:"retrieval_metadata,omitempty"`
	// List of chunks to be attributed across all claims in the candidate.
	// These are derived from the grounding sources supplied in the request.
	SupportChunks []*FactChunk `protobuf:"bytes,1,rep,name=support_chunks,json=supportChunks,proto3" json:"support_chunks,omitempty"`
	// Web search queries for the following-up web search.
	WebSearchQueries []string `protobuf:"bytes,3,rep,name=web_search_queries,json=webSearchQueries,proto3" json:"web_search_queries,omitempty"`
	// Google search entry for the following-up web searches.
	SearchEntryPoint *GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint `protobuf:"bytes,4,opt,name=search_entry_point,json=searchEntryPoint,proto3" json:"search_entry_point,omitempty"`
	// GroundingSupport across all claims in the answer candidate.
	// An support to a fact indicates that the claim is supported by
	// the fact.
	GroundingSupport []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport `protobuf:"bytes,2,rep,name=grounding_support,json=groundingSupport,proto3" json:"grounding_support,omitempty"`
	// Images from the web search.
	Images []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata `protobuf:"bytes,9,rep,name=images,proto3" json:"images,omitempty"`
	// contains filtered or unexported fields
}

Citation for the generated content.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetGroundingSupport

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetImages

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetRetrievalMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSearchEntryPoint

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSupportChunks

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetWebSearchQueries

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata struct {

	// Metadata for the dynamic retrieval predictor.
	PredictorMetadata *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata `protobuf:"bytes,1,opt,name=predictor_metadata,json=predictorMetadata,proto3" json:"predictor_metadata,omitempty"`
	// contains filtered or unexported fields
}

Describes the metadata about dynamic retrieval.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) GetPredictorMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata struct {

	// The version of the predictor which was used in dynamic retrieval.
	Version GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version `protobuf:"varint,1,opt,name=version,proto3,enum=google.cloud.discoveryengine.v1.GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version" json:"version,omitempty"`
	// The value of the predictor. This should be between [0, 1] where
	// a value of 0 means that the query would not benefit from grounding,
	// while a value of 1.0 means that the query would benefit the most.
	// In between values allow to differentiate between different usefulness
	// scores for grounding.
	Prediction *float32 `protobuf:"fixed32,2,opt,name=prediction,proto3,oneof" json:"prediction,omitempty"`
	// contains filtered or unexported fields
}

Describes the metadata about the dynamic retrieval predictor.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetPrediction

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetVersion

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version int32

The version of the predictor which was used in dynamic retrieval.

GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_VERSION_UNSPECIFIED, GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_V1_INDEPENDENT

const (
	// Unspecified version, should never be used.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_VERSION_UNSPECIFIED GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version = 0
	// The V1 model which is evaluating each source independently.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_V1_INDEPENDENT GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version = 1
)

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Descriptor

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Enum

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) EnumDescriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version.Descriptor instead.

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Number

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) String

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Type

GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport struct {

	// Text for the claim in the candidate. Always provided when a
	// support is found.
	ClaimText string `protobuf:"bytes,1,opt,name=claim_text,json=claimText,proto3" json:"claim_text,omitempty"`
	// A list of indices (into 'support_chunks') specifying the
	// citations associated with the claim. For instance [1,3,4] means
	// that support_chunks[1], support_chunks[3],
	// support_chunks[4] are the chunks attributed to the claim.
	SupportChunkIndices []int32 `protobuf:"varint,3,rep,packed,name=support_chunk_indices,json=supportChunkIndices,proto3" json:"support_chunk_indices,omitempty"`
	// A score in the range of [0, 1] describing how grounded is a specific
	// claim in the support chunks indicated.
	// Higher value means that the claim is better supported by the chunks.
	SupportScore *float32 `protobuf:"fixed32,2,opt,name=support_score,json=supportScore,proto3,oneof" json:"support_score,omitempty"`
	// contains filtered or unexported fields
}

Grounding info for a claim in the candidate and its support.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetClaimText

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportChunkIndices

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportScore

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata struct {

	// Metadata about the full size image.
	Image *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// Metadata about the thumbnail.
	Thumbnail *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image `protobuf:"bytes,2,opt,name=thumbnail,proto3" json:"thumbnail,omitempty"`
	// The details about the website that the image is from.
	Source *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo `protobuf:"bytes,3,opt,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

Metadata about an image from the web search.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetImage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetSource

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetThumbnail

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image struct {

	// The url of the image.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// The width of the image in pixels.
	Width int32 `protobuf:"varint,2,opt,name=width,proto3" json:"width,omitempty"`
	// The height of the image in pixels.
	Height int32 `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the image.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetHeight

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetUri

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetWidth

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo struct {

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

Metadata about the website that the image is from.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) GetTitle

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) GetUri

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata struct {

	// Describes the source to which the metadata is referring to.
	Source GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source `protobuf:"varint,1,opt,name=source,proto3,enum=google.cloud.discoveryengine.v1.GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source" json:"source,omitempty"`
	// Metadata for dynamic retrieval.
	DynamicRetrievalMetadata *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata `protobuf:"bytes,2,opt,name=dynamic_retrieval_metadata,json=dynamicRetrievalMetadata,proto3" json:"dynamic_retrieval_metadata,omitempty"`
	// contains filtered or unexported fields
}

Describes the metadata associated with a retrieval step.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) GetDynamicRetrievalMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) GetSource

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata) String

GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source int32

Describes the source to which the metadata is associated to.

GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_SOURCE_UNSPECIFIED, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_VERTEX_AI_SEARCH, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_GOOGLE_SEARCH, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_INLINE_CONTENT, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_GOOGLE_MAPS

const (
	// Unspecified source.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_SOURCE_UNSPECIFIED GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source = 0
	// Vertex AI search.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_VERTEX_AI_SEARCH GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source = 1
	// Google Search.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_GOOGLE_SEARCH GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source = 3
	// User inline provided content.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_INLINE_CONTENT GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source = 2
	// Google Maps.
	GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_GOOGLE_MAPS GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source = 4
)

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) Descriptor

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) Enum

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) EnumDescriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source.Descriptor instead.

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) Number

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) String

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source) Type

GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint struct {

	// Web content snippet that can be embedded in a web page or an app
	// webview.
	RenderedContent string `protobuf:"bytes,1,opt,name=rendered_content,json=renderedContent,proto3" json:"rendered_content,omitempty"`
	// Base64 encoded JSON representing array of 

Google search entry point.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) Descriptor

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) GetRenderedContent

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) GetSdkBlob

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) ProtoMessage

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) ProtoReflect

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) Reset

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint) String

GetAnswerRequest

type GetAnswerRequest struct {

	// Required. The resource name of the Answer to get. Format:
	// `projects/{project}/locations/{location}/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

GetControlRequest

type GetControlRequest struct {

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

Request for GetControl method.

func (*GetControlRequest) Descriptor

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

Deprecated: Use GetControlRequest.ProtoReflect.Descriptor instead.

func (*GetControlRequest) GetName

func (x *GetControlRequest) GetName() string

func (*GetControlRequest) ProtoMessage

func (*GetControlRequest) ProtoMessage()

func (*GetControlRequest) ProtoReflect

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

func (*GetControlRequest) Reset

func (x *GetControlRequest) Reset()

func (*GetControlRequest) String

func (x *GetControlRequest) String() string

GetConversationRequest

type GetConversationRequest struct {

	// Required. The resource name of the Conversation to get. Format:
	// `projects/{project}/locations/{location}/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.v1.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.v1.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [DataStore][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.Document], regardless of whether
	// or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Document][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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

GetSessionRequest

type GetSessionRequest struct {

	// Required. The resource name of the Session to get. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, the full session including all answer details
	// will be returned.
	IncludeAnswerDetails bool `protobuf:"varint,2,opt,name=include_answer_details,json=includeAnswerDetails,proto3" json:"include_answer_details,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) GetIncludeAnswerDetails

func (x *GetSessionRequest) GetIncludeAnswerDetails() bool

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.v1.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.v1.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 (*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.v1.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.v1.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [TargetSite][google.cloud.discoveryengine.v1.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.v1.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

GroundedGenerationContent

type GroundedGenerationContent struct {

	// Producer of the content. Must be either `user` or `model`.
	//
	// Intended to be used for multi-turn conversations. Otherwise, it can be left
	// unset.
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// Ordered `Parts` that constitute a single message.
	Parts []*GroundedGenerationContent_Part `protobuf:"bytes,2,rep,name=parts,proto3" json:"parts,omitempty"`
	// contains filtered or unexported fields
}

Base structured datatype containing multi-part content of a message.

func (*GroundedGenerationContent) Descriptor

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

Deprecated: Use GroundedGenerationContent.ProtoReflect.Descriptor instead.

func (*GroundedGenerationContent) GetParts

func (*GroundedGenerationContent) GetRole

func (x *GroundedGenerationContent) GetRole() string

func (*GroundedGenerationContent) ProtoMessage

func (*GroundedGenerationContent) ProtoMessage()

func (*GroundedGenerationContent) ProtoReflect

func (*GroundedGenerationContent) Reset

func (x *GroundedGenerationContent) Reset()

func (*GroundedGenerationContent) String

func (x *GroundedGenerationContent) String() string

GroundedGenerationContent_Part

type GroundedGenerationContent_Part struct {

	// Holder of data. It only supports text for now.
	//
	// Types that are assignable to Data:
	//
	//	*GroundedGenerationContent_Part_Text
	Data isGroundedGenerationContent_Part_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

Single part of content.

func (*GroundedGenerationContent_Part) Descriptor

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

Deprecated: Use GroundedGenerationContent_Part.ProtoReflect.Descriptor instead.

func (*GroundedGenerationContent_Part) GetData

func (m *GroundedGenerationContent_Part) GetData() isGroundedGenerationContent_Part_Data

func (*GroundedGenerationContent_Part) GetText

func (*GroundedGenerationContent_Part) ProtoMessage

func (*GroundedGenerationContent_Part) ProtoMessage()

func (*GroundedGenerationContent_Part) ProtoReflect

func (*GroundedGenerationContent_Part) Reset

func (x *GroundedGenerationContent_Part) Reset()

func (*GroundedGenerationContent_Part) String

GroundedGenerationContent_Part_Text

type GroundedGenerationContent_Part_Text struct {
	// Inline text.
	Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}

GroundedGenerationServiceClient

type GroundedGenerationServiceClient interface {
	// Generates grounded content in a streaming fashion.
	StreamGenerateGroundedContent(ctx context.Context, opts ...grpc.CallOption) (GroundedGenerationService_StreamGenerateGroundedContentClient, error)
	// Generates grounded content.
	GenerateGroundedContent(ctx context.Context, in *GenerateGroundedContentRequest, opts ...grpc.CallOption) (*GenerateGroundedContentResponse, error)
	// 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 {
	// Generates grounded content in a streaming fashion.
	StreamGenerateGroundedContent(GroundedGenerationService_StreamGenerateGroundedContentServer) error
	// Generates grounded content.
	GenerateGroundedContent(context.Context, *GenerateGroundedContentRequest) (*GenerateGroundedContentResponse, error)
	// Performs a grounding check.
	CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
}

GroundedGenerationServiceServer is the server API for GroundedGenerationService service.

GroundedGenerationService_StreamGenerateGroundedContentClient

type GroundedGenerationService_StreamGenerateGroundedContentClient interface {
	Send(*GenerateGroundedContentRequest) error
	Recv() (*GenerateGroundedContentResponse, error)
	grpc.ClientStream
}

GroundedGenerationService_StreamGenerateGroundedContentServer

type GroundedGenerationService_StreamGenerateGroundedContentServer interface {
	Send(*GenerateGroundedContentResponse) error
	Recv() (*GenerateGroundedContentRequest, error)
	grpc.ServerStream
}

GroundingFact

type GroundingFact struct {

	// Text content of the fact. Can be at most 10K characters long.
	FactText string `protobuf:"bytes,1,opt,name=fact_text,json=factText,proto3" json:"fact_text,omitempty"`
	// Attributes associated with the fact.
	// Common attributes include `source` (indicating where the fact was sourced
	// from), `author` (indicating the author of the fact), and so on.
	Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

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

HarmCategory

type HarmCategory int32

Harm categories that will block the content.

HarmCategory_HARM_CATEGORY_UNSPECIFIED, HarmCategory_HARM_CATEGORY_HATE_SPEECH, HarmCategory_HARM_CATEGORY_DANGEROUS_CONTENT, HarmCategory_HARM_CATEGORY_HARASSMENT, HarmCategory_HARM_CATEGORY_SEXUALLY_EXPLICIT, HarmCategory_HARM_CATEGORY_CIVIC_INTEGRITY

const (
	// The harm category is unspecified.
	HarmCategory_HARM_CATEGORY_UNSPECIFIED HarmCategory = 0
	// The harm category is hate speech.
	HarmCategory_HARM_CATEGORY_HATE_SPEECH HarmCategory = 1
	// The harm category is dangerous content.
	HarmCategory_HARM_CATEGORY_DANGEROUS_CONTENT HarmCategory = 2
	// The harm category is harassment.
	HarmCategory_HARM_CATEGORY_HARASSMENT HarmCategory = 3
	// The harm category is sexually explicit content.
	HarmCategory_HARM_CATEGORY_SEXUALLY_EXPLICIT HarmCategory = 4
	// The harm category is civic integrity.
	HarmCategory_HARM_CATEGORY_CIVIC_INTEGRITY HarmCategory = 5
)

func (HarmCategory) Descriptor

func (HarmCategory) Enum

func (x HarmCategory) Enum() *HarmCategory

func (HarmCategory) EnumDescriptor

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

Deprecated: Use HarmCategory.Descriptor instead.

func (HarmCategory) Number

func (HarmCategory) String

func (x HarmCategory) String() string

func (HarmCategory) Type

ImportCompletionSuggestionsMetadata

type ImportCompletionSuggestionsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// successfully imported.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of
	// [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
	// that failed to be imported.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ImportCompletionSuggestionsMetadata) Descriptor

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

Deprecated: Use ImportCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsMetadata) GetCreateTime

func (*ImportCompletionSuggestionsMetadata) GetFailureCount

func (x *ImportCompletionSuggestionsMetadata) GetFailureCount() int64

func (*ImportCompletionSuggestionsMetadata) GetSuccessCount

func (x *ImportCompletionSuggestionsMetadata) GetSuccessCount() int64

func (*ImportCompletionSuggestionsMetadata) GetUpdateTime

func (*ImportCompletionSuggestionsMetadata) ProtoMessage

func (*ImportCompletionSuggestionsMetadata) ProtoMessage()

func (*ImportCompletionSuggestionsMetadata) ProtoReflect

func (*ImportCompletionSuggestionsMetadata) Reset

func (*ImportCompletionSuggestionsMetadata) String

ImportCompletionSuggestionsRequest

type ImportCompletionSuggestionsRequest struct {

	// The source of the autocomplete suggestions.
	//
	// Types that are assignable to Source:
	//
	//	*ImportCompletionSuggestionsRequest_InlineSource_
	//	*ImportCompletionSuggestionsRequest_GcsSource
	//	*ImportCompletionSuggestionsRequest_BigquerySource
	Source isImportCompletionSuggestionsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent data store resource name for which to import customer
	// autocomplete suggestions.
	//
	// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] method.

func (*ImportCompletionSuggestionsRequest) Descriptor

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

Deprecated: Use ImportCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest) GetBigquerySource

func (x *ImportCompletionSuggestionsRequest) GetBigquerySource() *BigQuerySource

func (*ImportCompletionSuggestionsRequest) GetErrorConfig

func (*ImportCompletionSuggestionsRequest) GetGcsSource

func (x *ImportCompletionSuggestionsRequest) GetGcsSource() *GcsSource

func (*ImportCompletionSuggestionsRequest) GetInlineSource

func (*ImportCompletionSuggestionsRequest) GetParent

func (*ImportCompletionSuggestionsRequest) GetSource

func (m *ImportCompletionSuggestionsRequest) GetSource() isImportCompletionSuggestionsRequest_Source

func (*ImportCompletionSuggestionsRequest) ProtoMessage

func (*ImportCompletionSuggestionsRequest) ProtoMessage()

func (*ImportCompletionSuggestionsRequest) ProtoReflect

func (*ImportCompletionSuggestionsRequest) Reset

func (*ImportCompletionSuggestionsRequest) String

ImportCompletionSuggestionsRequest_BigquerySource

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

ImportCompletionSuggestionsRequest_GcsSource

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

ImportCompletionSuggestionsRequest_InlineSource

type ImportCompletionSuggestionsRequest_InlineSource struct {

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

The inline source for CompletionSuggestions.

func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor

Deprecated: Use ImportCompletionSuggestionsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect

func (*ImportCompletionSuggestionsRequest_InlineSource) Reset

func (*ImportCompletionSuggestionsRequest_InlineSource) String

ImportCompletionSuggestionsRequest_InlineSource_

type ImportCompletionSuggestionsRequest_InlineSource_ struct {
	// The Inline source for suggestion entries.
	InlineSource *ImportCompletionSuggestionsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

ImportCompletionSuggestionsResponse

type ImportCompletionSuggestionsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

func (*ImportCompletionSuggestionsResponse) Descriptor

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

Deprecated: Use ImportCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsResponse) GetErrorConfig

func (*ImportCompletionSuggestionsResponse) GetErrorSamples

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

func (*ImportCompletionSuggestionsResponse) ProtoMessage

func (*ImportCompletionSuggestionsResponse) ProtoMessage()

func (*ImportCompletionSuggestionsResponse) ProtoReflect

func (*ImportCompletionSuggestionsResponse) Reset

func (*ImportCompletionSuggestionsResponse) 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 {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*ImportDocumentsRequest_InlineSource_
	//	*ImportDocumentsRequest_GcsSource
	//	*ImportDocumentsRequest_BigquerySource
	//	*ImportDocumentsRequest_FhirStoreSource
	//	*ImportDocumentsRequest_SpannerSource
	//	*ImportDocumentsRequest_CloudSqlSource
	//	*ImportDocumentsRequest_FirestoreSource
	//	*ImportDocumentsRequest_AlloyDbSource
	//	*ImportDocumentsRequest_BigtableSource
	Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Requires create/update permission.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// The mode of reconciliation between existing documents and the documents to
	// be imported. Defaults to
	// [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
	ReconciliationMode ImportDocumentsRequest_ReconciliationMode `protobuf:"varint,6,opt,name=reconciliation_mode,json=reconciliationMode,proto3,enum=google.cloud.discoveryengine.v1.ImportDocumentsRequest_ReconciliationMode" json:"reconciliation_mode,omitempty"`
	// Indicates which fields in the provided imported documents to update. If
	// not set, the default is to update all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Whether to automatically generate IDs for the documents if absent.
	//
	// If set to `true`,
	// [Document.id][google.cloud.discoveryengine.v1.Document.id]s are
	// automatically generated based on the hash of the payload, where IDs may not
	// be consistent during multiple imports. In which case
	// [ReconciliationMode.FULL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL]
	// is highly recommended to avoid duplicate contents. If unset or set to
	// `false`, [Document.id][google.cloud.discoveryengine.v1.Document.id]s have
	// to be specified using
	// [id_field][google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field],
	// otherwise, documents without IDs fail to be imported.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource].
	AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
	// The field indicates the ID field or column to be used as unique IDs of
	// the documents.
	//
	// For [GcsSource][google.cloud.discoveryengine.v1.GcsSource] it is the key of
	// the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
	// For others, it may be the column name of the table where the unique ids are
	// stored.
	//
	// The values of the JSON field or the table column are used as the
	// [Document.id][google.cloud.discoveryengine.v1.Document.id]s. The JSON field
	// or the table column must be of string type, and the values must be set as
	// valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// with 1-63 characters. Otherwise, documents without valid IDs fail to be
	// imported.
	//
	// Only set this field when
	// [auto_generate_ids][google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids]
	// is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
	//
	// If it is unset, a default value `_id` is used when importing from the
	// allowed data sources.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource].
	IdField string `protobuf:"bytes,9,opt,name=id_field,json=idField,proto3" json:"id_field,omitempty"`
	// Optional. Whether to force refresh the unstructured content of the
	// documents.
	//
	// If set to `true`, the content part of the documents will be refreshed
	// regardless of the update status of the referencing content.
	ForceRefreshContent bool `protobuf:"varint,16,opt,name=force_refresh_content,json=forceRefreshContent,proto3" json:"force_refresh_content,omitempty"`
	// contains filtered or unexported fields
}

Request message for Import methods.

func (*ImportDocumentsRequest) Descriptor

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

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetAlloyDbSource

func (x *ImportDocumentsRequest) GetAlloyDbSource() *AlloyDbSource

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) GetForceRefreshContent

func (x *ImportDocumentsRequest) GetForceRefreshContent() bool

func (*ImportDocumentsRequest) GetGcsSource

func (x *ImportDocumentsRequest) GetGcsSource() *GcsSource

func (*ImportDocumentsRequest) GetIdField

func (x *ImportDocumentsRequest) GetIdField() string

func (*ImportDocumentsRequest) GetInlineSource

func (*ImportDocumentsRequest) GetParent

func (x *ImportDocumentsRequest) GetParent() string

func (*ImportDocumentsRequest) GetReconciliationMode

func (*ImportDocumentsRequest) GetSource

func (m *ImportDocumentsRequest) GetSource() isImportDocumentsRequest_Source

func (*ImportDocumentsRequest) 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_AlloyDbSource

type ImportDocumentsRequest_AlloyDbSource struct {
	// AlloyDB input source.
	AlloyDbSource *AlloyDbSource `protobuf:"bytes,14,opt,name=alloy_db_source,json=alloyDbSource,proto3,oneof"`
}

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

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

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor

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

Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.

func (ImportDocumentsRequest_ReconciliationMode) Number

func (ImportDocumentsRequest_ReconciliationMode) String

func (ImportDocumentsRequest_ReconciliationMode) Type

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.v1.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 (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage

func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect

func (*ImportSuggestionDenyListEntriesMetadata) Reset

func (*ImportSuggestionDenyListEntriesMetadata) 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.v1.CompletionService.ImportSuggestionDenyListEntries] method.

func (*ImportSuggestionDenyListEntriesRequest) Descriptor

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

Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource

func (*ImportSuggestionDenyListEntriesRequest) GetInlineSource

func (*ImportSuggestionDenyListEntriesRequest) GetParent

func (*ImportSuggestionDenyListEntriesRequest) GetSource

func (m *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Source

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage

func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect

func (*ImportSuggestionDenyListEntriesRequest) Reset

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

Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) 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.v1.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) ProtoReflect

func (*ImportSuggestionDenyListEntriesResponse) Reset

func (*ImportSuggestionDenyListEntriesResponse) 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 (*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 (*ImportUserEventsRequest_InlineSource) Reset

func (*ImportUserEventsRequest_InlineSource) 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.v1.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) Enum

func (IndustryVertical) EnumDescriptor

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

Deprecated: Use IndustryVertical.Descriptor instead.

func (IndustryVertical) Number

func (IndustryVertical) String

func (x IndustryVertical) String() string

func (IndustryVertical) Type

Interval

type Interval struct {

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

A floating point interval.

func (*Interval) Descriptor

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

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect

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

func (*Interval) Reset

func (x *Interval) Reset()

func (*Interval) String

func (x *Interval) String() string

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"`
}

ListControlsRequest

type ListControlsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
	// or
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListControls` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter to apply on the list results. Supported features:
	//
	// * List all the products under the parent branch if
	// [filter][google.cloud.discoveryengine.v1.ListControlsRequest.filter] is
	// unset. Currently this field is unsupported.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request for ListControls method.

func (*ListControlsRequest) Descriptor

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

Deprecated: Use ListControlsRequest.ProtoReflect.Descriptor instead.

func (*ListControlsRequest) GetFilter

func (x *ListControlsRequest) GetFilter() string

func (*ListControlsRequest) GetPageSize

func (x *ListControlsRequest) GetPageSize() int32

func (*ListControlsRequest) GetPageToken

func (x *ListControlsRequest) GetPageToken() string

func (*ListControlsRequest) GetParent

func (x *ListControlsRequest) GetParent() string

func (*ListControlsRequest) ProtoMessage

func (*ListControlsRequest) ProtoMessage()

func (*ListControlsRequest) ProtoReflect

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

func (*ListControlsRequest) Reset

func (x *ListControlsRequest) Reset()

func (*ListControlsRequest) String

func (x *ListControlsRequest) String() string

ListControlsResponse

type ListControlsResponse struct {

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

Response for ListControls method.

func (*ListControlsResponse) Descriptor

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

Deprecated: Use ListControlsResponse.ProtoReflect.Descriptor instead.

func (*ListControlsResponse) GetControls

func (x *ListControlsResponse) GetControls() []*Control

func (*ListControlsResponse) GetNextPageToken

func (x *ListControlsResponse) GetNextPageToken() string

func (*ListControlsResponse) ProtoMessage

func (*ListControlsResponse) ProtoMessage()

func (*ListControlsResponse) ProtoReflect

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

func (*ListControlsResponse) Reset

func (x *ListControlsResponse) Reset()

func (*ListControlsResponse) String

func (x *ListControlsResponse) String() string

ListConversationsRequest

type ListConversationsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project}/locations/{location}/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 (*ListConversationsResponse) Reset

func (x *ListConversationsResponse) Reset()

func (*ListConversationsResponse) String

func (x *ListConversationsResponse) String() string

ListCustomModelsRequest

type ListCustomModelsRequest struct {

	// Required. The resource name of the parent Data Store, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	// This field is used to identify the data store where to fetch the models
	// from.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsRequest) Descriptor

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

Deprecated: Use ListCustomModelsRequest.ProtoReflect.Descriptor instead.

func (*ListCustomModelsRequest) GetDataStore

func (x *ListCustomModelsRequest) GetDataStore() string

func (*ListCustomModelsRequest) ProtoMessage

func (*ListCustomModelsRequest) ProtoMessage()

func (*ListCustomModelsRequest) ProtoReflect

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

func (*ListCustomModelsRequest) Reset

func (x *ListCustomModelsRequest) Reset()

func (*ListCustomModelsRequest) String

func (x *ListCustomModelsRequest) String() string

ListCustomModelsResponse

type ListCustomModelsResponse struct {

	// List of custom tuning models.
	Models []*CustomTuningModel `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsResponse) Descriptor

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

Deprecated: Use ListCustomModelsResponse.ProtoReflect.Descriptor instead.

func (*ListCustomModelsResponse) GetModels

func (x *ListCustomModelsResponse) GetModels() []*CustomTuningModel

func (*ListCustomModelsResponse) ProtoMessage

func (*ListCustomModelsResponse) ProtoMessage()

func (*ListCustomModelsResponse) ProtoReflect

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

func (*ListCustomModelsResponse) Reset

func (x *ListCustomModelsResponse) Reset()

func (*ListCustomModelsResponse) String

func (x *ListCustomModelsResponse) 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.v1.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.v1.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.v1.ListDataStoresResponse.next_page_token],
	// received from a previous
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Document]s to
	// return. If unspecified, defaults to 100. The maximum allowed value is 1000.
	// Values above 1000 are set to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
	// received from a previous
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Schema]s to
	// return. The service may return fewer than this value.
	//
	// If unspecified, at most 100
	// [Schema][google.cloud.discoveryengine.v1.Schema]s are returned.
	//
	// The maximum value is 1000; values above 1000 are set to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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

ListSessionsRequest

type ListSessionsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project}/locations/{location}/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`
	//   - `is_pinned`
	//
	// Example:
	//
	//   - "update_time desc"
	//   - "create_time"
	//   - "is_pinned desc,update_time desc": list sessions by is_pinned first, then
	//     by update_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.v1.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.v1.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.v1.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 {

	// The media progress time in seconds, if applicable.
	// For example, if the end user has finished 90 seconds of a playback video,
	// then
	// [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds]
	// should be set to 90.
	MediaProgressDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=media_progress_duration,json=mediaProgressDuration,proto3" json:"media_progress_duration,omitempty"`
	// Media progress should be computed using only the
	// [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration]
	// relative to the media total length.
	//
	// This value must be between `[0, 1.0]` inclusive.
	//
	// If this is not a playback or the progress cannot be computed (e.g. ongoing
	// livestream), this field should be unset.
	MediaProgressPercentage *float32 `protobuf:"fixed32,2,opt,name=media_progress_percentage,json=mediaProgressPercentage,proto3,oneof" json:"media_progress_percentage,omitempty"`
	// contains filtered or unexported fields
}

Media-specific user event information.

func (*MediaInfo) Descriptor

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

Deprecated: Use MediaInfo.ProtoReflect.Descriptor instead.

func (*MediaInfo) GetMediaProgressDuration

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

func (*MediaInfo) GetMediaProgressPercentage

func (x *MediaInfo) GetMediaProgressPercentage() float32

func (*MediaInfo) ProtoMessage

func (*MediaInfo) ProtoMessage()

func (*MediaInfo) ProtoReflect

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

func (*MediaInfo) Reset

func (x *MediaInfo) Reset()

func (*MediaInfo) String

func (x *MediaInfo) String() string

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

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

Deprecated: Use PageInfo.ProtoReflect.Descriptor instead.

func (*PageInfo) GetPageCategory

func (x *PageInfo) GetPageCategory() string

func (*PageInfo) GetPageviewId

func (x *PageInfo) GetPageviewId() string

func (*PageInfo) GetReferrerUri

func (x *PageInfo) GetReferrerUri() string

func (*PageInfo) GetUri

func (x *PageInfo) GetUri() string

func (*PageInfo) ProtoMessage

func (*PageInfo) ProtoMessage()

func (*PageInfo) ProtoReflect

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

func (*PageInfo) Reset

func (x *PageInfo) Reset()

func (*PageInfo) String

func (x *PageInfo) String() string

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.v1.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.v1.PanelInfo.panel_position]
	// is set.
	TotalPanels *int32 `protobuf:"varint,5,opt,name=total_panels,json=totalPanels,proto3,oneof" json:"total_panels,omitempty"`
	// Optional. The document IDs associated with this panel.
	Documents []*DocumentInfo `protobuf:"bytes,6,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

Detailed panel information associated with a user event.

func (*PanelInfo) Descriptor

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

Deprecated: Use PanelInfo.ProtoReflect.Descriptor instead.

func (*PanelInfo) GetDisplayName

func (x *PanelInfo) GetDisplayName() string

func (*PanelInfo) GetDocuments

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

func (*PanelInfo) GetPanelId

func (x *PanelInfo) GetPanelId() string

func (*PanelInfo) GetPanelPosition

func (x *PanelInfo) GetPanelPosition() int32

func (*PanelInfo) GetTotalPanels

func (x *PanelInfo) GetTotalPanels() int32

func (*PanelInfo) ProtoMessage

func (*PanelInfo) ProtoMessage()

func (*PanelInfo) ProtoReflect

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

func (*PanelInfo) Reset

func (x *PanelInfo) Reset()

func (*PanelInfo) String

func (x *PanelInfo) String() string

Project

type Project struct {

	// Output only. Full resource name of the project, for example
	// `projects/{project}`.
	// Note that when making requests, project number and project id are both
	// acceptable, but the server will always respond in project number.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The timestamp when this project is created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp when this project is successfully provisioned.
	// Empty value means this project is still provisioning and is not ready for
	// use.
	ProvisionCompletionTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=provision_completion_time,json=provisionCompletionTime,proto3" json:"provision_completion_time,omitempty"`
	// Output only. A map of terms of services. The key is the `id` of
	// [ServiceTerms][google.cloud.discoveryengine.v1.Project.ServiceTerms].
	ServiceTermsMap map[string]*Project_ServiceTerms `protobuf:"bytes,4,rep,name=service_terms_map,json=serviceTermsMap,proto3" json:"service_terms_map,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Metadata and configurations for a Google Cloud project in the service.

func (*Project) Descriptor

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetCreateTime

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

func (*Project) GetName

func (x *Project) GetName() string

func (*Project) GetProvisionCompletionTime

func (x *Project) GetProvisionCompletionTime() *timestamppb.Timestamp

func (*Project) GetServiceTermsMap

func (x *Project) GetServiceTermsMap() map[string]*Project_ServiceTerms

func (*Project) ProtoMessage

func (*Project) ProtoMessage()

func (*Project) ProtoReflect

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

func (*Project) Reset

func (x *Project) Reset()

func (*Project) String

func (x *Project) String() string

ProjectServiceClient

type ProjectServiceClient interface {
	// Provisions the project resource. During the
	// process, related systems will get prepared and initialized.
	//
	// Caller must read the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms), and optionally
	// specify in request to provide consent to that service terms.
	ProvisionProject(ctx context.Context, in *ProvisionProjectRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ProjectServiceClient is the client API for ProjectService service.

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

func NewProjectServiceClient

func NewProjectServiceClient(cc grpc.ClientConnInterface) ProjectServiceClient

ProjectServiceServer

type ProjectServiceServer interface {
	// Provisions the project resource. During the
	// process, related systems will get prepared and initialized.
	//
	// Caller must read the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms), and optionally
	// specify in request to provide consent to that service terms.
	ProvisionProject(context.Context, *ProvisionProjectRequest) (*longrunningpb.Operation, error)
}

ProjectServiceServer is the server API for ProjectService service.

Project_ServiceTerms

type Project_ServiceTerms struct {

	// The unique identifier of this terms of service.
	// Available terms:
	//
	// * `GA_DATA_USE_TERMS`: [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms). When using this as
	// `id`, the acceptable
	// [version][google.cloud.discoveryengine.v1.Project.ServiceTerms.version]
	// to provide is `2022-11-23`.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The version string of the terms of service.
	// For acceptable values, see the comments for
	// [id][google.cloud.discoveryengine.v1.Project.ServiceTerms.id] above.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Whether the project has accepted/rejected the service terms or it is
	// still pending.
	State Project_ServiceTerms_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.Project_ServiceTerms_State" json:"state,omitempty"`
	// The last time when the project agreed to the terms of service.
	AcceptTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=accept_time,json=acceptTime,proto3" json:"accept_time,omitempty"`
	// The last time when the project declined or revoked the agreement to terms
	// of service.
	DeclineTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=decline_time,json=declineTime,proto3" json:"decline_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the terms of service.

func (*Project_ServiceTerms) Descriptor

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

Deprecated: Use Project_ServiceTerms.ProtoReflect.Descriptor instead.

func (*Project_ServiceTerms) GetAcceptTime

func (x *Project_ServiceTerms) GetAcceptTime() *timestamppb.Timestamp

func (*Project_ServiceTerms) GetDeclineTime

func (x *Project_ServiceTerms) GetDeclineTime() *timestamppb.Timestamp

func (*Project_ServiceTerms) GetId

func (x *Project_ServiceTerms) GetId() string

func (*Project_ServiceTerms) GetState

func (*Project_ServiceTerms) GetVersion

func (x *Project_ServiceTerms) GetVersion() string

func (*Project_ServiceTerms) ProtoMessage

func (*Project_ServiceTerms) ProtoMessage()

func (*Project_ServiceTerms) ProtoReflect

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

func (*Project_ServiceTerms) Reset

func (x *Project_ServiceTerms) Reset()

func (*Project_ServiceTerms) String

func (x *Project_ServiceTerms) String() string

Project_ServiceTerms_State

type Project_ServiceTerms_State int32

The agreement states this terms of service.

Project_ServiceTerms_STATE_UNSPECIFIED, Project_ServiceTerms_TERMS_ACCEPTED, Project_ServiceTerms_TERMS_PENDING, Project_ServiceTerms_TERMS_DECLINED

const (
	// The default value of the enum. This value is not actually used.
	Project_ServiceTerms_STATE_UNSPECIFIED Project_ServiceTerms_State = 0
	// The project has given consent to the terms of service.
	Project_ServiceTerms_TERMS_ACCEPTED Project_ServiceTerms_State = 1
	// The project is pending to review and accept the terms of service.
	Project_ServiceTerms_TERMS_PENDING Project_ServiceTerms_State = 2
	// The project has declined or revoked the agreement to terms of service.
	Project_ServiceTerms_TERMS_DECLINED Project_ServiceTerms_State = 3
)

func (Project_ServiceTerms_State) Descriptor

func (Project_ServiceTerms_State) Enum

func (Project_ServiceTerms_State) EnumDescriptor

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

Deprecated: Use Project_ServiceTerms_State.Descriptor instead.

func (Project_ServiceTerms_State) Number

func (Project_ServiceTerms_State) String

func (Project_ServiceTerms_State) Type

ProvisionProjectMetadata

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

Metadata associated with a project provision operation.

func (*ProvisionProjectMetadata) Descriptor

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

Deprecated: Use ProvisionProjectMetadata.ProtoReflect.Descriptor instead.

func (*ProvisionProjectMetadata) ProtoMessage

func (*ProvisionProjectMetadata) ProtoMessage()

func (*ProvisionProjectMetadata) ProtoReflect

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

func (*ProvisionProjectMetadata) Reset

func (x *ProvisionProjectMetadata) Reset()

func (*ProvisionProjectMetadata) String

func (x *ProvisionProjectMetadata) String() string

ProvisionProjectRequest

type ProvisionProjectRequest struct {

	// Required. Full resource name of a
	// [Project][google.cloud.discoveryengine.v1.Project], such as
	// `projects/{project_id_or_number}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Set to `true` to specify that caller has read and would like to
	// give consent to the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms).
	AcceptDataUseTerms bool `protobuf:"varint,2,opt,name=accept_data_use_terms,json=acceptDataUseTerms,proto3" json:"accept_data_use_terms,omitempty"`
	// Required. The version of the [Terms for data
	// use](https://cloud.google.com/retail/data-use-terms) that caller has read
	// and would like to give consent to.
	//
	// Acceptable version is `2022-11-23`, and this may change over time.
	DataUseTermsVersion string `protobuf:"bytes,3,opt,name=data_use_terms_version,json=dataUseTermsVersion,proto3" json:"data_use_terms_version,omitempty"`
	// contains filtered or unexported fields
}

Request for [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] method.

func (*ProvisionProjectRequest) Descriptor

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

Deprecated: Use ProvisionProjectRequest.ProtoReflect.Descriptor instead.

func (*ProvisionProjectRequest) GetAcceptDataUseTerms

func (x *ProvisionProjectRequest) GetAcceptDataUseTerms() bool

func (*ProvisionProjectRequest) GetDataUseTermsVersion

func (x *ProvisionProjectRequest) GetDataUseTermsVersion() string

func (*ProvisionProjectRequest) GetName

func (x *ProvisionProjectRequest) GetName() string

func (*ProvisionProjectRequest) ProtoMessage

func (*ProvisionProjectRequest) ProtoMessage()

func (*ProvisionProjectRequest) ProtoReflect

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

func (*ProvisionProjectRequest) Reset

func (x *ProvisionProjectRequest) Reset()

func (*ProvisionProjectRequest) String

func (x *ProvisionProjectRequest) String() string

PurgeCompletionSuggestionsMetadata

type PurgeCompletionSuggestionsMetadata struct {

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

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

func (*PurgeCompletionSuggestionsMetadata) Descriptor

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

Deprecated: Use PurgeCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsMetadata) GetCreateTime

func (*PurgeCompletionSuggestionsMetadata) GetUpdateTime

func (*PurgeCompletionSuggestionsMetadata) ProtoMessage

func (*PurgeCompletionSuggestionsMetadata) ProtoMessage()

func (*PurgeCompletionSuggestionsMetadata) ProtoReflect

func (*PurgeCompletionSuggestionsMetadata) Reset

func (*PurgeCompletionSuggestionsMetadata) String

PurgeCompletionSuggestionsRequest

type PurgeCompletionSuggestionsRequest struct {

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

Request message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] method.

func (*PurgeCompletionSuggestionsRequest) Descriptor

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

Deprecated: Use PurgeCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsRequest) GetParent

func (*PurgeCompletionSuggestionsRequest) ProtoMessage

func (*PurgeCompletionSuggestionsRequest) ProtoMessage()

func (*PurgeCompletionSuggestionsRequest) ProtoReflect

func (*PurgeCompletionSuggestionsRequest) Reset

func (*PurgeCompletionSuggestionsRequest) String

PurgeCompletionSuggestionsResponse

type PurgeCompletionSuggestionsResponse struct {

	// Whether the completion suggestions were successfully purged.
	PurgeSucceeded bool `protobuf:"varint,1,opt,name=purge_succeeded,json=purgeSucceeded,proto3" json:"purge_succeeded,omitempty"`
	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

Response message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] method.

func (*PurgeCompletionSuggestionsResponse) Descriptor

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

Deprecated: Use PurgeCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.

func (*PurgeCompletionSuggestionsResponse) GetErrorSamples

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

func (*PurgeCompletionSuggestionsResponse) GetPurgeSucceeded

func (x *PurgeCompletionSuggestionsResponse) GetPurgeSucceeded() bool

func (*PurgeCompletionSuggestionsResponse) ProtoMessage

func (*PurgeCompletionSuggestionsResponse) ProtoMessage()

func (*PurgeCompletionSuggestionsResponse) ProtoReflect

func (*PurgeCompletionSuggestionsResponse) Reset

func (*PurgeCompletionSuggestionsResponse) 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 {

	// The desired input source for the purging documents based on document IDs.
	//
	// Types that are assignable to Source:
	//
	//	*PurgeDocumentsRequest_GcsSource
	//	*PurgeDocumentsRequest_InlineSource_
	Source isPurgeDocumentsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Filter matching documents to purge. Only currently supported
	// value is
	// `*` (all items).
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The desired location of errors incurred during the purge.
	ErrorConfig *PurgeErrorConfig `protobuf:"bytes,7,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// Actually performs the purge. If `force` is set to false, return the
	// expected purge count without deleting any documents.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

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

func (*PurgeDocumentsRequest) Descriptor

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

Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest) GetErrorConfig

func (x *PurgeDocumentsRequest) GetErrorConfig() *PurgeErrorConfig

func (*PurgeDocumentsRequest) GetFilter

func (x *PurgeDocumentsRequest) GetFilter() string

func (*PurgeDocumentsRequest) GetForce

func (x *PurgeDocumentsRequest) GetForce() bool

func (*PurgeDocumentsRequest) GetGcsSource

func (x *PurgeDocumentsRequest) GetGcsSource() *GcsSource

func (*PurgeDocumentsRequest) GetInlineSource

func (*PurgeDocumentsRequest) GetParent

func (x *PurgeDocumentsRequest) GetParent() string

func (*PurgeDocumentsRequest) GetSource

func (m *PurgeDocumentsRequest) GetSource() isPurgeDocumentsRequest_Source

func (*PurgeDocumentsRequest) ProtoMessage

func (*PurgeDocumentsRequest) ProtoMessage()

func (*PurgeDocumentsRequest) ProtoReflect

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

func (*PurgeDocumentsRequest) Reset

func (x *PurgeDocumentsRequest) Reset()

func (*PurgeDocumentsRequest) String

func (x *PurgeDocumentsRequest) String() string

PurgeDocumentsRequest_GcsSource

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

PurgeDocumentsRequest_InlineSource

type PurgeDocumentsRequest_InlineSource struct {

	// Required. A list of full resource name of documents to purge. In the
	// format
	// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
	// Recommended max of 100 items.
	Documents []string `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method.

func (*PurgeDocumentsRequest_InlineSource) Descriptor

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

Deprecated: Use PurgeDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*PurgeDocumentsRequest_InlineSource) GetDocuments

func (x *PurgeDocumentsRequest_InlineSource) GetDocuments() []string

func (*PurgeDocumentsRequest_InlineSource) ProtoMessage

func (*PurgeDocumentsRequest_InlineSource) ProtoMessage()

func (*PurgeDocumentsRequest_InlineSource) ProtoReflect

func (*PurgeDocumentsRequest_InlineSource) Reset

func (*PurgeDocumentsRequest_InlineSource) String

PurgeDocumentsRequest_InlineSource_

type PurgeDocumentsRequest_InlineSource_ struct {
	// Inline source for the input content for purge.
	InlineSource *PurgeDocumentsRequest_InlineSource `protobuf:"bytes,6,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

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

PurgeErrorConfig

type PurgeErrorConfig struct {

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

Configuration of destination for Purge related errors.

func (*PurgeErrorConfig) Descriptor

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

Deprecated: Use PurgeErrorConfig.ProtoReflect.Descriptor instead.

func (*PurgeErrorConfig) GetDestination

func (m *PurgeErrorConfig) GetDestination() isPurgeErrorConfig_Destination

func (*PurgeErrorConfig) GetGcsPrefix

func (x *PurgeErrorConfig) GetGcsPrefix() string

func (*PurgeErrorConfig) ProtoMessage

func (*PurgeErrorConfig) ProtoMessage()

func (*PurgeErrorConfig) ProtoReflect

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

func (*PurgeErrorConfig) Reset

func (x *PurgeErrorConfig) Reset()

func (*PurgeErrorConfig) String

func (x *PurgeErrorConfig) String() string

PurgeErrorConfig_GcsPrefix

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

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 (*PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage

func (*PurgeSuggestionDenyListEntriesMetadata) ProtoReflect

func (*PurgeSuggestionDenyListEntriesMetadata) Reset

func (*PurgeSuggestionDenyListEntriesMetadata) 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.v1.CompletionService.PurgeSuggestionDenyListEntries] method.

func (*PurgeSuggestionDenyListEntriesRequest) Descriptor

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

Deprecated: Use PurgeSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*PurgeSuggestionDenyListEntriesRequest) GetParent

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage

func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage()

func (*PurgeSuggestionDenyListEntriesRequest) ProtoReflect

func (*PurgeSuggestionDenyListEntriesRequest) Reset

func (*PurgeSuggestionDenyListEntriesRequest) 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.v1.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) ProtoReflect

func (*PurgeSuggestionDenyListEntriesResponse) Reset

func (*PurgeSuggestionDenyListEntriesResponse) String

PurgeUserEventsMetadata

type PurgeUserEventsMetadata struct {

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

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

func (*PurgeUserEventsMetadata) Descriptor

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

Deprecated: Use PurgeUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsMetadata) GetCreateTime

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

func (*PurgeUserEventsMetadata) GetFailureCount

func (x *PurgeUserEventsMetadata) GetFailureCount() int64

func (*PurgeUserEventsMetadata) GetSuccessCount

func (x *PurgeUserEventsMetadata) GetSuccessCount() int64

func (*PurgeUserEventsMetadata) GetUpdateTime

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

func (*PurgeUserEventsMetadata) ProtoMessage

func (*PurgeUserEventsMetadata) ProtoMessage()

func (*PurgeUserEventsMetadata) ProtoReflect

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

func (*PurgeUserEventsMetadata) Reset

func (x *PurgeUserEventsMetadata) Reset()

func (*PurgeUserEventsMetadata) String

func (x *PurgeUserEventsMetadata) String() string

PurgeUserEventsRequest

type PurgeUserEventsRequest struct {

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

Request message for PurgeUserEvents method.

func (*PurgeUserEventsRequest) Descriptor

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

Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsRequest) GetFilter

func (x *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce

func (x *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent

func (x *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) ProtoReflect

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

func (*PurgeUserEventsRequest) Reset

func (x *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String

func (x *PurgeUserEventsRequest) String() string

PurgeUserEventsResponse

type PurgeUserEventsResponse struct {

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

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

func (*PurgeUserEventsResponse) Descriptor

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

Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsResponse) GetPurgeCount

func (x *PurgeUserEventsResponse) GetPurgeCount() int64

func (*PurgeUserEventsResponse) ProtoMessage

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) ProtoReflect

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

func (*PurgeUserEventsResponse) Reset

func (x *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String

func (x *PurgeUserEventsResponse) String() string

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

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

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetContent

func (m *Query) GetContent() isQuery_Content

func (*Query) GetQueryId

func (x *Query) GetQueryId() string

func (*Query) GetText

func (x *Query) GetText() string

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

func (x *Query) String() string

Query_Text

type Query_Text struct {
	// Plain text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}

RankRequest

type RankRequest struct {

	// Required. The resource name of the rank service config, such as
	// `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
	RankingConfig string `protobuf:"bytes,1,opt,name=ranking_config,json=rankingConfig,proto3" json:"ranking_config,omitempty"`
	// The identifier of the model to use. It is one of:
	//
	// * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
	// token size 512.
	//
	// It is set to `semantic-ranker-512@latest` by default if unspecified.
	Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	// The number of results to return. If this is unset or no bigger than zero,
	// returns all results.
	TopN int32 `protobuf:"varint,3,opt,name=top_n,json=topN,proto3" json:"top_n,omitempty"`
	// The query to use.
	Query string `protobuf:"bytes,4,opt,name=query,proto3" json:"query,omitempty"`
	// Required. A list of records to rank. At most 200 records to rank.
	Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
	// If true, the response will contain only record ID and score. By default, it
	// is false, the response will contain record details.
	IgnoreRecordDetailsInResponse bool `protobuf:"varint,6,opt,name=ignore_record_details_in_response,json=ignoreRecordDetailsInResponse,proto3" json:"ignore_record_details_in_response,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,7,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Request message for [RankService.Rank][google.cloud.discoveryengine.v1.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) GetUserLabels

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

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.v1.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.v1.RankingRecord.title] or
	// [content][google.cloud.discoveryengine.v1.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.v1.RankingRecord.title] or
	// [content][google.cloud.discoveryengine.v1.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.
	// The score will be rounded to 2 decimal places. If the score is close to 0,
	// it will be rounded to 0.0001 to avoid returning unset.
	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.v1.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 {

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

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.v1.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.v1.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 (*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 {

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

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

func (*RecommendResponse_RecommendationResult) GetMetadata

func (*RecommendResponse_RecommendationResult) ProtoMessage

func (*RecommendResponse_RecommendationResult) ProtoReflect

func (*RecommendResponse_RecommendationResult) Reset

func (*RecommendResponse_RecommendationResult) 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 have invalid format. Sample limited to
	// 1000.
	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 have invalid format.
	InvalidUrisCount int32 `protobuf:"varint,8,opt,name=invalid_uris_count,json=invalidUrisCount,proto3" json:"invalid_uris_count,omitempty"`
	// URIs that have no index meta tag. Sample limited to 1000.
	NoindexUris []string `protobuf:"bytes,11,rep,name=noindex_uris,json=noindexUris,proto3" json:"noindex_uris,omitempty"`
	// Total number of URIs that have no index meta tag.
	NoindexUrisCount int32 `protobuf:"varint,12,opt,name=noindex_uris_count,json=noindexUrisCount,proto3" json:"noindex_uris_count,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. Sample limited to 1000.
	UrisNotMatchingTargetSites []string `protobuf:"bytes,9,rep,name=uris_not_matching_target_sites,json=urisNotMatchingTargetSites,proto3" json:"uris_not_matching_target_sites,omitempty"`
	// Total number of URIs that don't match any TargetSites.
	UrisNotMatchingTargetSitesCount int32 `protobuf:"varint,10,opt,name=uris_not_matching_target_sites_count,json=urisNotMatchingTargetSitesCount,proto3" json:"uris_not_matching_target_sites_count,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.v1.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) GetInvalidUrisCount

func (x *RecrawlUrisMetadata) GetInvalidUrisCount() int32

func (*RecrawlUrisMetadata) GetNoindexUris

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

func (*RecrawlUrisMetadata) GetNoindexUrisCount

func (x *RecrawlUrisMetadata) GetNoindexUrisCount() int32

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) GetUrisNotMatchingTargetSites

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

func (*RecrawlUrisMetadata) GetUrisNotMatchingTargetSitesCount

func (x *RecrawlUrisMetadata) GetUrisNotMatchingTargetSitesCount() int32

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.v1.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.v1.TargetSite] in
	// `site_search_engine`.
	Uris []string `protobuf:"bytes,2,rep,name=uris,proto3" json:"uris,omitempty"`
	// Optional. Credential id to use for crawling.
	SiteCredential string `protobuf:"bytes,5,opt,name=site_credential,json=siteCredential,proto3" json:"site_credential,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RecrawlUrisRequest) Descriptor

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

Deprecated: Use RecrawlUrisRequest.ProtoReflect.Descriptor instead.

func (*RecrawlUrisRequest) GetSiteCredential

func (x *RecrawlUrisRequest) GetSiteCredential() string

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.v1.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 (*RecrawlUrisResponse_FailureInfo) GetUri

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage

func (*RecrawlUrisResponse_FailureInfo) ProtoMessage()

func (*RecrawlUrisResponse_FailureInfo) ProtoReflect

func (*RecrawlUrisResponse_FailureInfo) Reset

func (*RecrawlUrisResponse_FailureInfo) String

RecrawlUrisResponse_FailureInfo_FailureReason

type RecrawlUrisResponse_FailureInfo_FailureReason struct {

	// DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
	CorpusType RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType `protobuf:"varint,1,opt,name=corpus_type,json=corpusType,proto3,enum=google.cloud.discoveryengine.v1.RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType" json:"corpus_type,omitempty"`
	// Reason why the URI was not crawled.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RecrawlUrisResponse_FailureInfo_FailureReason) Descriptor

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason.ProtoReflect.Descriptor instead.

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType

func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage

func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect

func (*RecrawlUrisResponse_FailureInfo_FailureReason) Reset

func (*RecrawlUrisResponse_FailureInfo_FailureReason) String

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) Enum

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor

Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.Descriptor instead.

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String

func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type

Reply

type Reply struct {

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

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

Deprecated: Use Reply.ProtoReflect.Descriptor instead.

func (*Reply) GetSummary

func (x *Reply) GetSummary() *SearchResponse_Summary

func (*Reply) ProtoMessage

func (*Reply) ProtoMessage()

func (*Reply) ProtoReflect

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

func (*Reply) Reset

func (x *Reply) Reset()

func (*Reply) String

func (x *Reply) String() string

SafetyRating

type SafetyRating struct {

	// Output only. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.discoveryengine.v1.HarmCategory" json:"category,omitempty"`
	// Output only. Harm probability levels in the content.
	Probability SafetyRating_HarmProbability `protobuf:"varint,2,opt,name=probability,proto3,enum=google.cloud.discoveryengine.v1.SafetyRating_HarmProbability" json:"probability,omitempty"`
	// Output only. Harm probability score.
	ProbabilityScore float32 `protobuf:"fixed32,5,opt,name=probability_score,json=probabilityScore,proto3" json:"probability_score,omitempty"`
	// Output only. Harm severity levels in the content.
	Severity SafetyRating_HarmSeverity `protobuf:"varint,6,opt,name=severity,proto3,enum=google.cloud.discoveryengine.v1.SafetyRating_HarmSeverity" json:"severity,omitempty"`
	// Output only. Harm severity score.
	SeverityScore float32 `protobuf:"fixed32,7,opt,name=severity_score,json=severityScore,proto3" json:"severity_score,omitempty"`
	// Output only. Indicates whether the content was filtered out because of this
	// rating.
	Blocked bool `protobuf:"varint,3,opt,name=blocked,proto3" json:"blocked,omitempty"`
	// contains filtered or unexported fields
}

Safety rating corresponding to the generated content.

func (*SafetyRating) Descriptor

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

Deprecated: Use SafetyRating.ProtoReflect.Descriptor instead.

func (*SafetyRating) GetBlocked

func (x *SafetyRating) GetBlocked() bool

func (*SafetyRating) GetCategory

func (x *SafetyRating) GetCategory() HarmCategory

func (*SafetyRating) GetProbability

func (x *SafetyRating) GetProbability() SafetyRating_HarmProbability

func (*SafetyRating) GetProbabilityScore

func (x *SafetyRating) GetProbabilityScore() float32

func (*SafetyRating) GetSeverity

func (x *SafetyRating) GetSeverity() SafetyRating_HarmSeverity

func (*SafetyRating) GetSeverityScore

func (x *SafetyRating) GetSeverityScore() float32

func (*SafetyRating) ProtoMessage

func (*SafetyRating) ProtoMessage()

func (*SafetyRating) ProtoReflect

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

func (*SafetyRating) Reset

func (x *SafetyRating) Reset()

func (*SafetyRating) String

func (x *SafetyRating) String() string

SafetyRating_HarmProbability

type SafetyRating_HarmProbability int32

Harm probability levels in the content.

SafetyRating_HARM_PROBABILITY_UNSPECIFIED, SafetyRating_NEGLIGIBLE, SafetyRating_LOW, SafetyRating_MEDIUM, SafetyRating_HIGH

const (
	// Harm probability unspecified.
	SafetyRating_HARM_PROBABILITY_UNSPECIFIED SafetyRating_HarmProbability = 0
	// Negligible level of harm.
	SafetyRating_NEGLIGIBLE SafetyRating_HarmProbability = 1
	// Low level of harm.
	SafetyRating_LOW SafetyRating_HarmProbability = 2
	// Medium level of harm.
	SafetyRating_MEDIUM SafetyRating_HarmProbability = 3
	// High level of harm.
	SafetyRating_HIGH SafetyRating_HarmProbability = 4
)

func (SafetyRating_HarmProbability) Descriptor

func (SafetyRating_HarmProbability) Enum

func (SafetyRating_HarmProbability) EnumDescriptor

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

Deprecated: Use SafetyRating_HarmProbability.Descriptor instead.

func (SafetyRating_HarmProbability) Number

func (SafetyRating_HarmProbability) String

func (SafetyRating_HarmProbability) Type

SafetyRating_HarmSeverity

type SafetyRating_HarmSeverity int32

Harm severity levels.

SafetyRating_HARM_SEVERITY_UNSPECIFIED, SafetyRating_HARM_SEVERITY_NEGLIGIBLE, SafetyRating_HARM_SEVERITY_LOW, SafetyRating_HARM_SEVERITY_MEDIUM, SafetyRating_HARM_SEVERITY_HIGH

const (
	// Harm severity unspecified.
	SafetyRating_HARM_SEVERITY_UNSPECIFIED SafetyRating_HarmSeverity = 0
	// Negligible level of harm severity.
	SafetyRating_HARM_SEVERITY_NEGLIGIBLE SafetyRating_HarmSeverity = 1
	// Low level of harm severity.
	SafetyRating_HARM_SEVERITY_LOW SafetyRating_HarmSeverity = 2
	// Medium level of harm severity.
	SafetyRating_HARM_SEVERITY_MEDIUM SafetyRating_HarmSeverity = 3
	// High level of harm severity.
	SafetyRating_HARM_SEVERITY_HIGH SafetyRating_HarmSeverity = 4
)

func (SafetyRating_HarmSeverity) Descriptor

func (SafetyRating_HarmSeverity) Enum

func (SafetyRating_HarmSeverity) EnumDescriptor

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

Deprecated: Use SafetyRating_HarmSeverity.Descriptor instead.

func (SafetyRating_HarmSeverity) Number

func (SafetyRating_HarmSeverity) String

func (x SafetyRating_HarmSeverity) String() string

func (SafetyRating_HarmSeverity) Type

Schema

type Schema struct {

	// Schema representation. One of
	// [struct_schema][google.cloud.discoveryengine.v1.Schema.struct_schema] or
	// [json_schema][google.cloud.discoveryengine.v1.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

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetJsonSchema

func (x *Schema) GetJsonSchema() string

func (*Schema) GetName

func (x *Schema) GetName() string

func (*Schema) GetSchema

func (m *Schema) GetSchema() isSchema_Schema

func (*Schema) GetStructSchema

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

func (*Schema) ProtoMessage

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect

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

func (*Schema) Reset

func (x *Schema) Reset()

func (*Schema) String

func (x *Schema) String() string

SchemaServiceClient

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

SearchInfo

type SearchInfo struct {

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

SearchLinkPromotion

type SearchLinkPromotion struct {

	// Required. The title of the promotion.
	// Maximum length: 160 characters.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Optional. The URL for the page the user wants to promote. Must be set for
	// site search. For other verticals, this is optional.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Optional. The promotion thumbnail image url.
	ImageUri string `protobuf:"bytes,3,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// Optional. The Promotion description.
	// Maximum length: 200 characters.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. The enabled promotion will be returned for any serving configs
	// associated with the parent of the control this promotion is attached to.
	//
	// This flag is used for basic site search only.
	Enabled bool `protobuf:"varint,5,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

Promotion proto includes uri and other helping information to display the promotion.

func (*SearchLinkPromotion) Descriptor

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

Deprecated: Use SearchLinkPromotion.ProtoReflect.Descriptor instead.

func (*SearchLinkPromotion) GetDescription

func (x *SearchLinkPromotion) GetDescription() string

func (*SearchLinkPromotion) GetEnabled

func (x *SearchLinkPromotion) GetEnabled() bool

func (*SearchLinkPromotion) GetImageUri

func (x *SearchLinkPromotion) GetImageUri() string

func (*SearchLinkPromotion) GetTitle

func (x *SearchLinkPromotion) GetTitle() string

func (*SearchLinkPromotion) GetUri

func (x *SearchLinkPromotion) GetUri() string

func (*SearchLinkPromotion) ProtoMessage

func (*SearchLinkPromotion) ProtoMessage()

func (*SearchLinkPromotion) ProtoReflect

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

func (*SearchLinkPromotion) Reset

func (x *SearchLinkPromotion) Reset()

func (*SearchLinkPromotion) String

func (x *SearchLinkPromotion) String() string

SearchRequest

type SearchRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
	// or
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
	// This field is used to identify the serving configuration name, set
	// of models used to make the search.
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// The branch resource name, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
	//
	// Use `default_branch` as the branch ID or leave this field empty, to search
	// documents under the default branch.
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// Raw search query.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// Raw image query.
	ImageQuery *SearchRequest_ImageQuery `protobuf:"bytes,19,opt,name=image_query,json=imageQuery,proto3" json:"image_query,omitempty"`
	// Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
	// return. The maximum allowed value depends on the data type. Values above
	// the maximum value are coerced to the maximum value.
	//
	// * Websites with basic indexing: Default `10`, Maximum `25`.
	// * Websites with advanced indexing: Default `25`, Maximum `50`.
	// * Other: Default `50`, Maximum `100`.
	//
	// If this field is negative, an  `INVALID_ARGUMENT` is returned.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token received from a previous
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// must match the call that provided the page token. Otherwise, an
	//
	//	`INVALID_ARGUMENT`  error is returned.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A 0-indexed integer that specifies the current offset (that is, starting
	// result location, amongst the
	// [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
	// relevant) in search results. This field is only considered if
	// [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
	// unset.
	//
	// If this field is negative, an  `INVALID_ARGUMENT`  is returned.
	Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
	// The maximum number of results to return for OneBox.
	// This applies to each OneBox type individually.
	// Default number is 10.
	OneBoxPageSize int32 `protobuf:"varint,47,opt,name=one_box_page_size,json=oneBoxPageSize,proto3" json:"one_box_page_size,omitempty"`
	// Specifications that define the specific
	// [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
	// along with configurations for those data stores. This is only considered
	// for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
	// stores. For engines with a single data store, the specs directly under
	// [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
	// used.
	DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,32,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
	// The filter syntax consists of an expression language for constructing a
	// predicate from one or more fields of the documents being filtered. Filter
	// expression is case-sensitive.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
	// key property defined in the Vertex AI Search backend -- this mapping is
	// defined by the customer in their schema. For example a media customer might
	// have a field 'name' in their schema. In this case the filter would look
	// like this: filter --> name:'ANY("king kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,7,opt,name=filter,proto3" json:"filter,omitempty"`
	// The default filter that is applied when a user performs a search without
	// checking any filters on the search page.
	//
	// The filter applied to every search request when quality improvement such as
	// query expansion is needed. In the case a query does not have a sufficient
	// amount of results this filter will be used to determine whether or not to
	// enable the query expansion flow. The original filter will still be used for
	// the query expanded search.
	// This field is strongly recommended to achieve high search quality.
	//
	// For more information about filter syntax, see
	// [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].
	CanonicalFilter string `protobuf:"bytes,29,opt,name=canonical_filter,json=canonicalFilter,proto3" json:"canonical_filter,omitempty"`
	// The order in which documents are returned. Documents can be ordered by
	// a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
	// Leave it unset if ordered by relevance. `order_by` expression is
	// case-sensitive.
	//
	// For more information on ordering the website search results, see
	// [Order web search
	// results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
	// For more information on ordering the healthcare search results, see
	// [Order healthcare search
	// results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
	// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
	OrderBy string `protobuf:"bytes,8,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Information about the end user.
	// Highly recommended for analytics and personalization.
	// [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
	// is used to deduce `device_type` for analytics.
	UserInfo *UserInfo `protobuf:"bytes,21,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// The BCP-47 language code, such as "en-US" or "sr-Latn". For more
	// information, see [Standard
	// fields](https://cloud.google.com/apis/design/standard_fields). This field
	// helps to better interpret the query. If a value isn't specified, the query
	// language code is automatically detected, which may not be accurate.
	LanguageCode string `protobuf:"bytes,35,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Facet specifications for faceted search. If empty, no facets are returned.
	//
	// A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
	// error is returned.
	FacetSpecs []*SearchRequest_FacetSpec `protobuf:"bytes,9,rep,name=facet_specs,json=facetSpecs,proto3" json:"facet_specs,omitempty"`
	// Boost specification to boost certain documents.
	// For more information on boosting, see
	// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// Additional search parameters.
	//
	// For public website search only, supported values are:
	//
	//   - `user_country_code`: string. Default empty. If set to non-empty, results
	//     are restricted or boosted based on the location provided.
	//     For example, `user_country_code: "au"`
	//
	//     For available codes see [Country
	//     Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
	//
	//   - `search_type`: double. Default empty. Enables non-webpage searching
	//     depending on the value. The only valid non-default value is 1,
	//     which enables image searching.
	//     For example, `search_type: 1`
	Params map[string]*structpb.Value `protobuf:"bytes,11,rep,name=params,proto3" json:"params,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// The query expansion specification that specifies the conditions under which
	// query expansion occurs.
	QueryExpansionSpec *SearchRequest_QueryExpansionSpec `protobuf:"bytes,13,opt,name=query_expansion_spec,json=queryExpansionSpec,proto3" json:"query_expansion_spec,omitempty"`
	// The spell correction specification that specifies the mode under
	// which spell correction takes effect.
	SpellCorrectionSpec *SearchRequest_SpellCorrectionSpec `protobuf:"bytes,14,opt,name=spell_correction_spec,json=spellCorrectionSpec,proto3" json:"spell_correction_spec,omitempty"`
	// A unique identifier for tracking visitors. For example, this could be
	// implemented with an HTTP cookie, which should be able to uniquely identify
	// a visitor on a single device. This unique identifier should not change if
	// the visitor logs in or out of the website.
	//
	// This field should NOT have a fixed value such as `unknown_visitor`.
	//
	// This should be the same identifier as
	// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
	// and
	// [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
	UserPseudoId string `protobuf:"bytes,15,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// A specification for configuring the behavior of content search.
	ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,24,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
	// Whether to turn on safe search. This is only supported for
	// website search.
	SafeSearch bool `protobuf:"varint,20,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `protobuf:"bytes,22,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Search as you type configuration. Only supported for the
	// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
	// vertical.
	SearchAsYouTypeSpec *SearchRequest_SearchAsYouTypeSpec `protobuf:"bytes,31,opt,name=search_as_you_type_spec,json=searchAsYouTypeSpec,proto3" json:"search_as_you_type_spec,omitempty"`
	// Optional. Config for display feature, like match highlighting on search
	// results.
	DisplaySpec *SearchRequest_DisplaySpec `protobuf:"bytes,38,opt,name=display_spec,json=displaySpec,proto3" json:"display_spec,omitempty"`
	// The session resource name. Optional.
	//
	// Session allows users to do multi-turn /search API calls or coordination
	// between /search API calls and /answer API calls.
	//
	// Example #1 (multi-turn /search API calls):
	//  1. Call /search API with the auto-session mode (see below).
	//  2. Call /search API with the session ID generated in the first call.
	//     Here, the previous search query gets considered in query
	//     standing. I.e., if the first query is "How did Alphabet do in 2022?"
	//     and the current query is "How about 2023?", the current query will
	//     be interpreted as "How did Alphabet do in 2023?".
	//
	// Example #2 (coordination between /search API calls and /answer API calls):
	//  1. Call /search API with the auto-session mode (see below).
	//  2. Call /answer API with the session ID generated in the first call.
	//     Here, the answer generation happens in the context of the search
	//     results from the first search call.
	//
	// Auto-session mode: when `projects/.../sessions/-` is used, a new session
	// gets automatically created. Otherwise, users can use the create-session API
	// to create a session manually.
	//
	// Multi-turn Search feature is currently at private GA stage. Please use
	// v1alpha or v1beta version instead before we launch this feature to public
	// GA. Or ask for allowlisting through Google Support team.
	Session string `protobuf:"bytes,41,opt,name=session,proto3" json:"session,omitempty"`
	// Session specification.
	//
	// Can be used only when `session` is set.
	SessionSpec *SearchRequest_SessionSpec `protobuf:"bytes,42,opt,name=session_spec,json=sessionSpec,proto3" json:"session_spec,omitempty"`
	// The relevance threshold of the search results.
	//
	// Default to Google defined threshold, leveraging a balance of
	// precision and recall to deliver both highly accurate results and
	// comprehensive coverage of relevant information.
	//
	// This feature is not supported for healthcare search.
	RelevanceThreshold SearchRequest_RelevanceThreshold `protobuf:"varint,44,opt,name=relevance_threshold,json=relevanceThreshold,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_RelevanceThreshold" json:"relevance_threshold,omitempty"`
	// Optional. The specification for returning the relevance score.
	RelevanceScoreSpec *SearchRequest_RelevanceScoreSpec `protobuf:"bytes,52,opt,name=relevance_score_spec,json=relevanceScoreSpec,proto3" json:"relevance_score_spec,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchService.Search][google.cloud.discoveryengine.v1.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) GetDisplaySpec

func (x *SearchRequest) GetDisplaySpec() *SearchRequest_DisplaySpec

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) GetLanguageCode

func (x *SearchRequest) GetLanguageCode() string

func (*SearchRequest) GetOffset

func (x *SearchRequest) GetOffset() int32

func (*SearchRequest) GetOneBoxPageSize

func (x *SearchRequest) GetOneBoxPageSize() 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) GetRelevanceScoreSpec

func (x *SearchRequest) GetRelevanceScoreSpec() *SearchRequest_RelevanceScoreSpec

func (*SearchRequest) GetRelevanceThreshold

func (x *SearchRequest) GetRelevanceThreshold() SearchRequest_RelevanceThreshold

func (*SearchRequest) GetSafeSearch

func (x *SearchRequest) GetSafeSearch() bool

func (*SearchRequest) GetSearchAsYouTypeSpec

func (x *SearchRequest) GetSearchAsYouTypeSpec() *SearchRequest_SearchAsYouTypeSpec

func (*SearchRequest) GetServingConfig

func (x *SearchRequest) GetServingConfig() string

func (*SearchRequest) GetSession

func (x *SearchRequest) GetSession() string

func (*SearchRequest) GetSessionSpec

func (x *SearchRequest) GetSessionSpec() *SearchRequest_SessionSpec

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 specifications, 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 (*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.v1.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost documents with document ID "doc_1" or "doc_2", and
	// color "Red" or "Blue":
	// `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
	Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
	// Strength of the condition boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0.
	//
	// Setting to 1.0 gives the document a big promotion. However, it does
	// not necessarily mean that the boosted document will be the top result
	// at all times, nor that other documents will be excluded. Results
	// could still be shown even when none of them matches the condition.
	// And results that are significantly more relevant to the search query
	// can still trump your heavily favored but irrelevant documents.
	//
	// Setting to -1.0 gives the document a big demotion. However, results
	// that are deeply relevant might still be shown. The document will have
	// an upstream battle to get a fairly high ranking, but it is not
	// blocked out completely.
	//
	// Setting to 0.0 means no boost applied. The boosting condition is
	// ignored. Only one of the (condition, boost) combination or the
	// boost_control_spec below are set. If both are set then the global boost
	// is ignored and the more fine-grained boost_control_spec is applied.
	Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
	// Complex specification for custom ranking based on customer defined
	// attribute value.
	BoostControlSpec *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec `protobuf:"bytes,3,opt,name=boost_control_spec,json=boostControlSpec,proto3" json:"boost_control_spec,omitempty"`
	// contains filtered or unexported fields
}

Boost applies to documents which match a condition.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset

func (*SearchRequest_BoostSpec_ConditionBoostSpec) String

SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec

type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec struct {

	// The name of the field whose value will be used to determine the
	// boost amount.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The attribute type to be used to determine the boost amount. The
	// attribute value can be derived from the field value of the specified
	// field_name. In the case of numerical it is straightforward i.e.
	// attribute_value = numerical_field_value. In the case of freshness
	// however, attribute_value = (time.now() - datetime_field_value).
	AttributeType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType `protobuf:"varint,2,opt,name=attribute_type,json=attributeType,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType" json:"attribute_type,omitempty"`
	// The interpolation type to be applied to connect the control points
	// listed below.
	InterpolationType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType `protobuf:"varint,3,opt,name=interpolation_type,json=interpolationType,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType" json:"interpolation_type,omitempty"`
	// The control points used to define the curve. The monotonic function
	// (defined through the interpolation_type above) passes through the
	// control points listed here.
	ControlPoints []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
	// contains filtered or unexported fields
}

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) 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]]`.
	// For example, `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) Enum

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.Descriptor instead.

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type

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

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect

func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset

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

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.Descriptor instead.

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String

func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type

SearchRequest_ContentSearchSpec

type SearchRequest_ContentSearchSpec struct {

	// If `snippetSpec` is not specified, snippets are not included in the
	// search response.
	SnippetSpec *SearchRequest_ContentSearchSpec_SnippetSpec `protobuf:"bytes,1,opt,name=snippet_spec,json=snippetSpec,proto3" json:"snippet_spec,omitempty"`
	// If `summarySpec` is not specified, summaries are not included in the
	// search response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,2,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
	// If there is no extractive_content_spec provided, there will be no
	// extractive answer in the search response.
	ExtractiveContentSpec *SearchRequest_ContentSearchSpec_ExtractiveContentSpec `protobuf:"bytes,3,opt,name=extractive_content_spec,json=extractiveContentSpec,proto3" json:"extractive_content_spec,omitempty"`
	// Specifies the search result mode. If unspecified, the
	// search result mode defaults to `DOCUMENTS`.
	SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `protobuf:"varint,4,opt,name=search_result_mode,json=searchResultMode,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_ContentSearchSpec_SearchResultMode" json:"search_result_mode,omitempty"`
	// Specifies the chunk spec to be returned from the search response.
	// Only available if the
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
	ChunkSpec *SearchRequest_ContentSearchSpec_ChunkSpec `protobuf:"bytes,5,opt,name=chunk_spec,json=chunkSpec,proto3" json:"chunk_spec,omitempty"`
	// contains filtered or unexported fields
}

A specification for configuring the behavior of content search.

func (*SearchRequest_ContentSearchSpec) Descriptor

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

Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec) GetChunkSpec

func (*SearchRequest_ContentSearchSpec) GetExtractiveContentSpec

func (*SearchRequest_ContentSearchSpec) GetSearchResultMode

func (*SearchRequest_ContentSearchSpec) GetSnippetSpec

func (*SearchRequest_ContentSearchSpec) GetSummarySpec

func (*SearchRequest_ContentSearchSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec) ProtoMessage()

func (*SearchRequest_ContentSearchSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec) Reset

func (*SearchRequest_ContentSearchSpec) String

SearchRequest_ContentSearchSpec_ChunkSpec

type SearchRequest_ContentSearchSpec_ChunkSpec struct {

	// The number of previous chunks to be returned of the current chunk. The
	// maximum allowed value is 3.
	// If not specified, no previous chunks will be returned.
	NumPreviousChunks int32 `protobuf:"varint,1,opt,name=num_previous_chunks,json=numPreviousChunks,proto3" json:"num_previous_chunks,omitempty"`
	// The number of next chunks to be returned of the current chunk. The
	// maximum allowed value is 3.
	// If not specified, no next chunks will be returned.
	NumNextChunks int32 `protobuf:"varint,2,opt,name=num_next_chunks,json=numNextChunks,proto3" json:"num_next_chunks,omitempty"`
	// contains filtered or unexported fields
}

Specifies the chunk spec to be returned from the search response. Only available if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]

func (*SearchRequest_ContentSearchSpec_ChunkSpec) Descriptor

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

Deprecated: Use SearchRequest_ContentSearchSpec_ChunkSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks() int32

func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks

func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks() int32

func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_ChunkSpec) Reset

func (*SearchRequest_ContentSearchSpec_ChunkSpec) String

SearchRequest_ContentSearchSpec_ExtractiveContentSpec

type SearchRequest_ContentSearchSpec_ExtractiveContentSpec struct {

	// The maximum number of extractive answers returned in each search
	// result.
	//
	// An extractive answer is a verbatim answer extracted from the original
	// document, which provides a precise and contextually relevant answer to
	// the search query.
	//
	// If the number of matching answers is less than the
	// `max_extractive_answer_count`, return all of the answers. Otherwise,
	// return the `max_extractive_answer_count`.
	//
	// At most five answers are returned for each
	// [SearchResult][google.cloud.discoveryengine.v1.SearchResponse.SearchResult].
	MaxExtractiveAnswerCount int32 `protobuf:"varint,1,opt,name=max_extractive_answer_count,json=maxExtractiveAnswerCount,proto3" json:"max_extractive_answer_count,omitempty"`
	// The max number of extractive segments returned in each search result.
	// Only applied if the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] is set to
	// [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1.DataStore.ContentConfig.CONTENT_REQUIRED]
	// or
	// [DataStore.solution_types][google.cloud.discoveryengine.v1.DataStore.solution_types]
	// is
	// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
	//
	// An extractive segment is a text segment extracted from the original
	// document that is relevant to the search query, and, in general, more
	// verbose than an extractive answer. The segment could then be used as
	// input for LLMs to generate summaries and answers.
	//
	// If the number of matching segments is less than
	// `max_extractive_segment_count`, return all of the segments. Otherwise,
	// return the `max_extractive_segment_count`.
	MaxExtractiveSegmentCount int32 `protobuf:"varint,2,opt,name=max_extractive_segment_count,json=maxExtractiveSegmentCount,proto3" json:"max_extractive_segment_count,omitempty"`
	// Specifies whether to return the confidence score from the extractive
	// segments in each search result. This feature is available only for new
	// or allowlisted data stores. To allowlist your data store,
	// contact your Customer Engineer. The default value is `false`.
	ReturnExtractiveSegmentScore bool `protobuf:"varint,3,opt,name=return_extractive_segment_score,json=returnExtractiveSegmentScore,proto3" json:"return_extractive_segment_score,omitempty"`
	// Specifies whether to also include the adjacent from each selected
	// segments.
	// Return at most `num_previous_segments` segments before each selected
	// segments.
	NumPreviousSegments int32 `protobuf:"varint,4,opt,name=num_previous_segments,json=numPreviousSegments,proto3" json:"num_previous_segments,omitempty"`
	// Return at most `num_next_segments` segments after each selected
	// segments.
	NumNextSegments int32 `protobuf:"varint,5,opt,name=num_next_segments,json=numNextSegments,proto3" json:"num_next_segments,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor

Deprecated: Use SearchRequest_ContentSearchSpec_ExtractiveContentSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount() int32

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore

func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore() bool

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset

func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String

SearchRequest_ContentSearchSpec_SearchResultMode

type SearchRequest_ContentSearchSpec_SearchResultMode int32

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

SearchRequest_ContentSearchSpec_SEARCH_RESULT_MODE_UNSPECIFIED, SearchRequest_ContentSearchSpec_DOCUMENTS, SearchRequest_ContentSearchSpec_CHUNKS

const (
	// Default value.
	SearchRequest_ContentSearchSpec_SEARCH_RESULT_MODE_UNSPECIFIED SearchRequest_ContentSearchSpec_SearchResultMode = 0
	// Returns documents in the search result.
	SearchRequest_ContentSearchSpec_DOCUMENTS SearchRequest_ContentSearchSpec_SearchResultMode = 1
	// Returns chunks in the search result. Only available if the
	// [DocumentProcessingConfig.chunking_config][google.cloud.discoveryengine.v1.DocumentProcessingConfig.chunking_config]
	// is specified.
	SearchRequest_ContentSearchSpec_CHUNKS SearchRequest_ContentSearchSpec_SearchResultMode = 2
)

func (SearchRequest_ContentSearchSpec_SearchResultMode) Descriptor

func (SearchRequest_ContentSearchSpec_SearchResultMode) Enum

func (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor

Deprecated: Use SearchRequest_ContentSearchSpec_SearchResultMode.Descriptor instead.

func (SearchRequest_ContentSearchSpec_SearchResultMode) Number

func (SearchRequest_ContentSearchSpec_SearchResultMode) String

func (SearchRequest_ContentSearchSpec_SearchResultMode) Type

SearchRequest_ContentSearchSpec_SnippetSpec

type SearchRequest_ContentSearchSpec_SnippetSpec struct {

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

A specification for configuring snippets in a search response.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor

Deprecated: 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/v1/search_service.proto.

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() bool

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

func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet

func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet() bool

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset

func (*SearchRequest_ContentSearchSpec_SnippetSpec) String

SearchRequest_ContentSearchSpec_SummarySpec

type SearchRequest_ContentSearchSpec_SummarySpec struct {

	// The number of top results to generate the summary from. If the number
	// of results returned is less than `summaryResultCount`, the summary is
	// generated from all of the results.
	//
	// At most 10 results for documents mode, or 50 for chunks mode, can be
	// used to generate a summary. The chunks mode is used when
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
	SummaryResultCount int32 `protobuf:"varint,1,opt,name=summary_result_count,json=summaryResultCount,proto3" json:"summary_result_count,omitempty"`
	// Specifies whether to include citations in the summary. The default
	// value is `false`.
	//
	// When this field is set to `true`, summaries include in-line citation
	// numbers.
	//
	// Example summary including citations:
	//
	// BigQuery is Google Cloud's fully managed and completely serverless
	// enterprise data warehouse [1]. BigQuery supports all data types, works
	// across clouds, and has built-in machine learning and business
	// intelligence, all within a unified platform [2, 3].
	//
	// The citation numbers refer to the returned search results and are
	// 1-indexed. For example, [1] means that the sentence is attributed to
	// the first search result. [2, 3] means that the sentence is attributed
	// to both the second and third search results.
	IncludeCitations bool `protobuf:"varint,2,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
	// Specifies whether to filter out adversarial queries. The default value
	// is `false`.
	//
	// Google employs search-query classification to detect adversarial
	// queries. No summary is returned if the search query is classified as an
	// adversarial query. For example, a user might ask a question regarding
	// negative comments about the company or submit a query designed to
	// generate unsafe, policy-violating output. If this field is set to
	// `true`, we skip generating summaries for adversarial queries and return
	// fallback messages instead.
	IgnoreAdversarialQuery bool `protobuf:"varint,3,opt,name=ignore_adversarial_query,json=ignoreAdversarialQuery,proto3" json:"ignore_adversarial_query,omitempty"`
	// Specifies whether to filter out queries that are not summary-seeking.
	// The default value is `false`.
	//
	// Google employs search-query classification to detect summary-seeking
	// queries. No summary is returned if the search query is classified as a
	// non-summary seeking query. For example, `why is the sky blue` and `Who
	// is the best soccer player in the world?` are summary-seeking queries,
	// but `SFO airport` and `world cup 2026` are not. They are most likely
	// navigational queries. If this field is set to `true`, we skip
	// generating summaries for non-summary seeking queries and return
	// fallback messages instead.
	IgnoreNonSummarySeekingQuery bool `protobuf:"varint,4,opt,name=ignore_non_summary_seeking_query,json=ignoreNonSummarySeekingQuery,proto3" json:"ignore_non_summary_seeking_query,omitempty"`
	// Specifies whether to filter out queries that have low relevance. The
	// default value is `false`.
	//
	// If this field is set to `false`, all search results are used regardless
	// of relevance to generate answers. If set to `true`, only queries with
	// high relevance search results will generate answers.
	IgnoreLowRelevantContent bool `protobuf:"varint,9,opt,name=ignore_low_relevant_content,json=ignoreLowRelevantContent,proto3" json:"ignore_low_relevant_content,omitempty"`
	// Optional. Specifies whether to filter out jail-breaking queries. The
	// default value is `false`.
	//
	// Google employs search-query classification to detect jail-breaking
	// queries. No summary is returned if the search query is classified as a
	// jail-breaking query. A user might add instructions to the query to
	// change the tone, style, language, content of the answer, or ask the
	// model to act as a different entity, e.g. "Reply in the tone of a
	// competing company's CEO". If this field is set to `true`, we skip
	// generating summaries for jail-breaking queries and return fallback
	// messages instead.
	IgnoreJailBreakingQuery bool `protobuf:"varint,10,opt,name=ignore_jail_breaking_query,json=ignoreJailBreakingQuery,proto3" json:"ignore_jail_breaking_query,omitempty"`
	// If specified, the spec will be used to modify the prompt provided to
	// the LLM.
	ModelPromptSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec `protobuf:"bytes,5,opt,name=model_prompt_spec,json=modelPromptSpec,proto3" json:"model_prompt_spec,omitempty"`
	// Language code for Summary. Use language tags defined by
	// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
	// Note: This is an experimental feature.
	LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// If specified, the spec will be used to modify the model specification
	// provided to the LLM.
	ModelSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec `protobuf:"bytes,7,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
	// If true, answer will be generated from most relevant chunks from top
	// search results. This feature will improve summary quality.
	// Note that with this feature enabled, not all top search results
	// will be referenced and included in the reference list, so the citation
	// source index only points to the search results listed in the reference
	// list.
	UseSemanticChunks bool `protobuf:"varint,8,opt,name=use_semantic_chunks,json=useSemanticChunks,proto3" json:"use_semantic_chunks,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreJailBreakingQuery

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreJailBreakingQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations

func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations() bool

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec

func (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec

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) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SummarySpec) Reset

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

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset

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

Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset

func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String

SearchRequest_DataStoreSpec

type SearchRequest_DataStoreSpec struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1.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"`
	// Optional. Filter specification to filter documents in the data store
	// specified by data_store field. For more information on filtering, see
	// [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Boost specification to boost certain documents.
	// For more information on boosting, see
	// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,6,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// contains filtered or unexported fields
}

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

func (*SearchRequest_DataStoreSpec) Descriptor

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

Deprecated: Use SearchRequest_DataStoreSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_DataStoreSpec) GetBoostSpec

func (*SearchRequest_DataStoreSpec) GetDataStore

func (x *SearchRequest_DataStoreSpec) GetDataStore() string

func (*SearchRequest_DataStoreSpec) GetFilter

func (x *SearchRequest_DataStoreSpec) GetFilter() string

func (*SearchRequest_DataStoreSpec) ProtoMessage

func (*SearchRequest_DataStoreSpec) ProtoMessage()

func (*SearchRequest_DataStoreSpec) ProtoReflect

func (*SearchRequest_DataStoreSpec) Reset

func (x *SearchRequest_DataStoreSpec) Reset()

func (*SearchRequest_DataStoreSpec) String

func (x *SearchRequest_DataStoreSpec) String() string

SearchRequest_DisplaySpec

type SearchRequest_DisplaySpec struct {

	// The condition under which match highlighting should occur.
	MatchHighlightingCondition SearchRequest_DisplaySpec_MatchHighlightingCondition `protobuf:"varint,1,opt,name=match_highlighting_condition,json=matchHighlightingCondition,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_DisplaySpec_MatchHighlightingCondition" json:"match_highlighting_condition,omitempty"`
	// contains filtered or unexported fields
}

Specifies features for display, like match highlighting.

func (*SearchRequest_DisplaySpec) Descriptor

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

Deprecated: Use SearchRequest_DisplaySpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_DisplaySpec) GetMatchHighlightingCondition

func (*SearchRequest_DisplaySpec) ProtoMessage

func (*SearchRequest_DisplaySpec) ProtoMessage()

func (*SearchRequest_DisplaySpec) ProtoReflect

func (*SearchRequest_DisplaySpec) Reset

func (x *SearchRequest_DisplaySpec) Reset()

func (*SearchRequest_DisplaySpec) String

func (x *SearchRequest_DisplaySpec) String() string

SearchRequest_DisplaySpec_MatchHighlightingCondition

type SearchRequest_DisplaySpec_MatchHighlightingCondition int32

Enum describing under which condition match highlighting should occur.

SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED, SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_DISABLED, SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_ENABLED

const (
	// Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
	SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED SearchRequest_DisplaySpec_MatchHighlightingCondition = 0
	// Disables match highlighting on all documents.
	SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_DISABLED SearchRequest_DisplaySpec_MatchHighlightingCondition = 1
	// Enables match highlighting on all documents.
	SearchRequest_DisplaySpec_MATCH_HIGHLIGHTING_ENABLED SearchRequest_DisplaySpec_MatchHighlightingCondition = 2
)

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) Descriptor

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) Enum

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) EnumDescriptor

Deprecated: Use SearchRequest_DisplaySpec_MatchHighlightingCondition.Descriptor instead.

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) Number

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) String

func (SearchRequest_DisplaySpec_MatchHighlightingCondition) Type

SearchRequest_FacetSpec

type SearchRequest_FacetSpec struct {

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

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

func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string

func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes

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

func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues

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

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()

func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect

func (*SearchRequest_FacetSpec_FacetKey) Reset

func (*SearchRequest_FacetSpec_FacetKey) String

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 {

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

Specification to determine under which conditions query expansion should occur.

func (*SearchRequest_QueryExpansionSpec) Descriptor

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

Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_QueryExpansionSpec) GetCondition

func (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults

func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() bool

func (*SearchRequest_QueryExpansionSpec) ProtoMessage

func (*SearchRequest_QueryExpansionSpec) ProtoMessage()

func (*SearchRequest_QueryExpansionSpec) ProtoReflect

func (*SearchRequest_QueryExpansionSpec) Reset

func (*SearchRequest_QueryExpansionSpec) String

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.v1.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.v1.SearchResponse.total_size]
	// is zero.
	SearchRequest_QueryExpansionSpec_DISABLED SearchRequest_QueryExpansionSpec_Condition = 1
	// Automatic query expansion built by the Search API.
	SearchRequest_QueryExpansionSpec_AUTO SearchRequest_QueryExpansionSpec_Condition = 2
)

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor

func (SearchRequest_QueryExpansionSpec_Condition) Enum

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor

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

Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.

func (SearchRequest_QueryExpansionSpec_Condition) Number

func (SearchRequest_QueryExpansionSpec_Condition) String

func (SearchRequest_QueryExpansionSpec_Condition) Type

SearchRequest_RelevanceScoreSpec

type SearchRequest_RelevanceScoreSpec struct {

	// Optional. Whether to return the relevance score for search results.
	// The higher the score, the more relevant the document is to the query.
	ReturnRelevanceScore bool `protobuf:"varint,1,opt,name=return_relevance_score,json=returnRelevanceScore,proto3" json:"return_relevance_score,omitempty"`
	// contains filtered or unexported fields
}

The specification for returning the document relevance score.

func (*SearchRequest_RelevanceScoreSpec) Descriptor

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

Deprecated: Use SearchRequest_RelevanceScoreSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_RelevanceScoreSpec) GetReturnRelevanceScore

func (x *SearchRequest_RelevanceScoreSpec) GetReturnRelevanceScore() bool

func (*SearchRequest_RelevanceScoreSpec) ProtoMessage

func (*SearchRequest_RelevanceScoreSpec) ProtoMessage()

func (*SearchRequest_RelevanceScoreSpec) ProtoReflect

func (*SearchRequest_RelevanceScoreSpec) Reset

func (*SearchRequest_RelevanceScoreSpec) String

SearchRequest_RelevanceThreshold

type SearchRequest_RelevanceThreshold int32

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

SearchRequest_RELEVANCE_THRESHOLD_UNSPECIFIED, SearchRequest_LOWEST, SearchRequest_LOW, SearchRequest_MEDIUM, SearchRequest_HIGH

const (
	// Default value. In this case, server behavior defaults to Google defined
	// threshold.
	SearchRequest_RELEVANCE_THRESHOLD_UNSPECIFIED SearchRequest_RelevanceThreshold = 0
	// Lowest relevance threshold.
	SearchRequest_LOWEST SearchRequest_RelevanceThreshold = 1
	// Low relevance threshold.
	SearchRequest_LOW SearchRequest_RelevanceThreshold = 2
	// Medium relevance threshold.
	SearchRequest_MEDIUM SearchRequest_RelevanceThreshold = 3
	// High relevance threshold.
	SearchRequest_HIGH SearchRequest_RelevanceThreshold = 4
)

func (SearchRequest_RelevanceThreshold) Descriptor

func (SearchRequest_RelevanceThreshold) Enum

func (SearchRequest_RelevanceThreshold) EnumDescriptor

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

Deprecated: Use SearchRequest_RelevanceThreshold.Descriptor instead.

func (SearchRequest_RelevanceThreshold) Number

func (SearchRequest_RelevanceThreshold) String

func (SearchRequest_RelevanceThreshold) Type

SearchRequest_SearchAsYouTypeSpec

type SearchRequest_SearchAsYouTypeSpec struct {

	// The condition under which search as you type should occur.
	// Default to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
	Condition SearchRequest_SearchAsYouTypeSpec_Condition `protobuf:"varint,1,opt,name=condition,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_SearchAsYouTypeSpec_Condition" json:"condition,omitempty"`
	// contains filtered or unexported fields
}

Specification for search as you type in search requests.

func (*SearchRequest_SearchAsYouTypeSpec) Descriptor

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

Deprecated: Use SearchRequest_SearchAsYouTypeSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SearchAsYouTypeSpec) GetCondition

func (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage

func (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage()

func (*SearchRequest_SearchAsYouTypeSpec) ProtoReflect

func (*SearchRequest_SearchAsYouTypeSpec) Reset

func (*SearchRequest_SearchAsYouTypeSpec) String

SearchRequest_SearchAsYouTypeSpec_Condition

type SearchRequest_SearchAsYouTypeSpec_Condition int32

Enum describing under which condition search as you type should occur.

SearchRequest_SearchAsYouTypeSpec_CONDITION_UNSPECIFIED, SearchRequest_SearchAsYouTypeSpec_DISABLED, SearchRequest_SearchAsYouTypeSpec_ENABLED, SearchRequest_SearchAsYouTypeSpec_AUTO

const (
	// Server behavior defaults to
	// [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
	SearchRequest_SearchAsYouTypeSpec_CONDITION_UNSPECIFIED SearchRequest_SearchAsYouTypeSpec_Condition = 0
	// Disables Search As You Type.
	SearchRequest_SearchAsYouTypeSpec_DISABLED SearchRequest_SearchAsYouTypeSpec_Condition = 1
	// Enables Search As You Type.
	SearchRequest_SearchAsYouTypeSpec_ENABLED SearchRequest_SearchAsYouTypeSpec_Condition = 2
	// Automatic switching between search-as-you-type and standard search
	// modes, ideal for single-API implementations (e.g., debouncing).
	SearchRequest_SearchAsYouTypeSpec_AUTO SearchRequest_SearchAsYouTypeSpec_Condition = 3
)

func (SearchRequest_SearchAsYouTypeSpec_Condition) Descriptor

func (SearchRequest_SearchAsYouTypeSpec_Condition) Enum

func (SearchRequest_SearchAsYouTypeSpec_Condition) EnumDescriptor

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

Deprecated: Use SearchRequest_SearchAsYouTypeSpec_Condition.Descriptor instead.

func (SearchRequest_SearchAsYouTypeSpec_Condition) Number

func (SearchRequest_SearchAsYouTypeSpec_Condition) String

func (SearchRequest_SearchAsYouTypeSpec_Condition) Type

SearchRequest_SessionSpec

type SearchRequest_SessionSpec struct {

	// If set, the search result gets stored to the "turn" specified by this
	// query ID.
	//
	// Example: Let's say the session looks like this:
	//
	//	session {
	//	  name: ".../sessions/xxx"
	//	  turns {
	//	    query { text: "What is foo?" query_id: ".../questions/yyy" }
	//	    answer: "Foo is ..."
	//	  }
	//	  turns {
	//	    query { text: "How about bar then?" query_id: ".../questions/zzz" }
	//	  }
	//	}
	//
	// The user can call /search API with a request like this:
	//
	//	session: ".../sessions/xxx"
	//	session_spec { query_id: ".../questions/zzz" }
	//
	// Then, the API stores the search result, associated with the last turn.
	// The stored search result can be used by a subsequent /answer API call
	// (with the session ID and the query ID specified). Also, it is possible
	// to call /search and /answer in parallel with the same session ID & query
	// ID.
	QueryId string `protobuf:"bytes,1,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
	// The number of top search results to persist. The persisted search results
	// can be used for the subsequent /answer api call.
	//
	// This field is similar to the `summary_result_count` field in
	// [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].
	//
	// At most 10 results for documents mode, or 50 for chunks mode.
	SearchResultPersistenceCount *int32 `protobuf:"varint,2,opt,name=search_result_persistence_count,json=searchResultPersistenceCount,proto3,oneof" json:"search_result_persistence_count,omitempty"`
	// contains filtered or unexported fields
}

Session specification.

Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

func (*SearchRequest_SessionSpec) Descriptor

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

Deprecated: Use SearchRequest_SessionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SessionSpec) GetQueryId

func (x *SearchRequest_SessionSpec) GetQueryId() string

func (*SearchRequest_SessionSpec) GetSearchResultPersistenceCount

func (x *SearchRequest_SessionSpec) GetSearchResultPersistenceCount() int32

func (*SearchRequest_SessionSpec) ProtoMessage

func (*SearchRequest_SessionSpec) ProtoMessage()

func (*SearchRequest_SessionSpec) ProtoReflect

func (*SearchRequest_SessionSpec) Reset

func (x *SearchRequest_SessionSpec) Reset()

func (*SearchRequest_SessionSpec) String

func (x *SearchRequest_SessionSpec) String() string

SearchRequest_SpellCorrectionSpec

type SearchRequest_SpellCorrectionSpec struct {

	// The mode under which spell correction
	// replaces the original search query. Defaults to
	// [Mode.AUTO][google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	Mode SearchRequest_SpellCorrectionSpec_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.cloud.discoveryengine.v1.SearchRequest_SpellCorrectionSpec_Mode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()

func (*SearchRequest_SpellCorrectionSpec) ProtoReflect

func (*SearchRequest_SpellCorrectionSpec) Reset

func (*SearchRequest_SpellCorrectionSpec) 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.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
	// Search API tries to find a spelling suggestion. If a suggestion is
	// found, it is put in the
	// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1.SearchResponse.corrected_query].
	// The spelling suggestion won't be used as the search query.
	SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
	// Automatic spell correction built by the Search API. Search will
	// be based on the corrected query if found.
	SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor

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 (SearchRequest_SpellCorrectionSpec_Mode) String

func (SearchRequest_SpellCorrectionSpec_Mode) Type

SearchResponse

type SearchResponse struct {

	// A list of matched documents. The order represents the ranking.
	Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// Results of facets requested by user.
	Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`
	// The estimated total count of matched items irrespective of pagination. The
	// count of [results][google.cloud.discoveryengine.v1.SearchResponse.results]
	// returned by pagination may be less than the
	// [total_size][google.cloud.discoveryengine.v1.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.v1.UserEvent] logs resulting from
	// this search, which enables accurate attribution of search model
	// performance. This also helps to identify a request during the customer
	// support scenarios.
	AttributionToken string `protobuf:"bytes,4,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// The URI of a customer-defined redirect page. If redirect action is
	// triggered, no search is performed, and only
	// [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
	// and
	// [attribution_token][google.cloud.discoveryengine.v1.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.v1.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.v1.SearchRequest.ContentSearchSpec.summary_spec]
	// is set.
	Summary *SearchResponse_Summary `protobuf:"bytes,9,opt,name=summary,proto3" json:"summary,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"`
	// Session information.
	//
	// Only set if
	// [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
	// is provided. See its description for more details.
	SessionInfo *SearchResponse_SessionInfo `protobuf:"bytes,19,opt,name=session_info,json=sessionInfo,proto3" json:"session_info,omitempty"`
	// Promotions for site search.
	SearchLinkPromotions []*SearchLinkPromotion `protobuf:"bytes,23,rep,name=search_link_promotions,json=searchLinkPromotions,proto3" json:"search_link_promotions,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SearchResponse) Descriptor

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

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) 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) GetSearchLinkPromotions

func (x *SearchResponse) GetSearchLinkPromotions() []*SearchLinkPromotion

func (*SearchResponse) GetSessionInfo

func (x *SearchResponse) GetSessionInfo() *SearchResponse_SessionInfo

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. For example, `"colors"` or `"price"`. It matches
	// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1.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 (*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 (*SearchResponse_Facet_FacetValue) ProtoMessage

func (*SearchResponse_Facet_FacetValue) ProtoMessage()

func (*SearchResponse_Facet_FacetValue) ProtoReflect

func (*SearchResponse_Facet_FacetValue) Reset

func (*SearchResponse_Facet_FacetValue) 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.v1.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_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.v1.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 (*SearchResponse_QueryExpansionInfo) Reset

func (*SearchResponse_QueryExpansionInfo) String

SearchResponse_SearchResult

type SearchResponse_SearchResult struct {

	// [Document.id][google.cloud.discoveryengine.v1.Document.id] of the
	// searched [Document][google.cloud.discoveryengine.v1.Document].
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The document data snippet in the search response. Only fields that are
	// marked as `retrievable` are populated.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// The chunk data in the search response if the
	// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
	// is set to
	// [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
	Chunk *Chunk `protobuf:"bytes,18,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Output only. Google provided available scores.
	ModelScores map[string]*DoubleList `protobuf:"bytes,4,rep,name=model_scores,json=modelScores,proto3" json:"model_scores,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

Represents the search results.

func (*SearchResponse_SearchResult) Descriptor

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

Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchResult) GetChunk

func (x *SearchResponse_SearchResult) GetChunk() *Chunk

func (*SearchResponse_SearchResult) GetDocument

func (x *SearchResponse_SearchResult) GetDocument() *Document

func (*SearchResponse_SearchResult) GetId

func (*SearchResponse_SearchResult) GetModelScores

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

func (*SearchResponse_SearchResult) ProtoMessage

func (*SearchResponse_SearchResult) ProtoMessage()

func (*SearchResponse_SearchResult) ProtoReflect

func (*SearchResponse_SearchResult) Reset

func (x *SearchResponse_SearchResult) Reset()

func (*SearchResponse_SearchResult) String

func (x *SearchResponse_SearchResult) String() string

SearchResponse_SessionInfo

type SearchResponse_SessionInfo struct {

	// Name of the session.
	// If the auto-session mode is used (when
	// [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
	// ends with "-"), this field holds the newly generated session name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Query ID that corresponds to this search API call.
	// One session can have multiple turns, each with a unique query ID.
	//
	// By specifying the session name and this query ID in the Answer API call,
	// the answer generation happens in the context of the search results from
	// this search call.
	QueryId string `protobuf:"bytes,2,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
	// contains filtered or unexported fields
}

Information about the session.

func (*SearchResponse_SessionInfo) Descriptor

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

Deprecated: Use SearchResponse_SessionInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_SessionInfo) GetName

func (x *SearchResponse_SessionInfo) GetName() string

func (*SearchResponse_SessionInfo) GetQueryId

func (x *SearchResponse_SessionInfo) GetQueryId() string

func (*SearchResponse_SessionInfo) ProtoMessage

func (*SearchResponse_SessionInfo) ProtoMessage()

func (*SearchResponse_SessionInfo) ProtoReflect

func (*SearchResponse_SessionInfo) Reset

func (x *SearchResponse_SessionInfo) Reset()

func (*SearchResponse_SessionInfo) String

func (x *SearchResponse_SessionInfo) String() string

SearchResponse_Summary

type SearchResponse_Summary struct {

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

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

func (*SearchResponse_Summary) Descriptor

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

Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary) GetSafetyAttributes

func (*SearchResponse_Summary) GetSummarySkippedReasons

func (*SearchResponse_Summary) GetSummaryText

func (x *SearchResponse_Summary) GetSummaryText() string

func (*SearchResponse_Summary) GetSummaryWithMetadata

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 (*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 (*SearchResponse_Summary_Citation) Reset

func (*SearchResponse_Summary_Citation) 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 (*SearchResponse_Summary_CitationMetadata) ProtoMessage

func (*SearchResponse_Summary_CitationMetadata) ProtoReflect

func (*SearchResponse_Summary_CitationMetadata) Reset

func (*SearchResponse_Summary_CitationMetadata) 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 (*SearchResponse_Summary_CitationSource) Reset

func (*SearchResponse_Summary_CitationSource) 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.v1.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 (*SearchResponse_Summary_Reference) GetDocument

func (x *SearchResponse_Summary_Reference) GetDocument() string

func (*SearchResponse_Summary_Reference) GetTitle

func (*SearchResponse_Summary_Reference) GetUri

func (*SearchResponse_Summary_Reference) ProtoMessage

func (*SearchResponse_Summary_Reference) ProtoMessage()

func (*SearchResponse_Summary_Reference) ProtoReflect

func (*SearchResponse_Summary_Reference) Reset

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

Deprecated: Use SearchResponse_Summary_Reference_ChunkContent.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_Reference_ChunkContent) GetContent

func (*SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier

func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage

func (*SearchResponse_Summary_Reference_ChunkContent) ProtoReflect

func (*SearchResponse_Summary_Reference_ChunkContent) Reset

func (*SearchResponse_Summary_Reference_ChunkContent) 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 (*SearchResponse_Summary_SafetyAttributes) ProtoMessage

func (*SearchResponse_Summary_SafetyAttributes) ProtoReflect

func (*SearchResponse_Summary_SafetyAttributes) Reset

func (*SearchResponse_Summary_SafetyAttributes) 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, SearchResponse_Summary_NO_RELEVANT_CONTENT, SearchResponse_Summary_JAIL_BREAKING_QUERY_IGNORED, SearchResponse_Summary_CUSTOMER_POLICY_VIOLATION, SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED_V2, SearchResponse_Summary_TIME_OUT

const (
	// Default value. The summary skipped reason is not specified.
	SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED SearchResponse_Summary_SummarySkippedReason = 0
	// The adversarial query ignored case.
	//
	// Only used when
	// [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1.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.
	//
	// Google skips the summary if the query is chit chat.
	// Only used when
	// [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
	// is set to `true`.
	SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 2
	// The out-of-domain query ignored case.
	//
	// Google skips the summary if there are no high-relevance search results.
	// For example, the data store contains facts about company A but the
	// user query is asking questions about company B.
	SearchResponse_Summary_OUT_OF_DOMAIN_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 3
	// The potential policy violation case.
	//
	// Google skips the summary if there is a potential policy violation
	// detected. This includes content that may be violent or toxic.
	SearchResponse_Summary_POTENTIAL_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 4
	// The LLM addon not enabled case.
	//
	// Google skips the summary if the LLM addon is not enabled.
	SearchResponse_Summary_LLM_ADDON_NOT_ENABLED SearchResponse_Summary_SummarySkippedReason = 5
	// The no relevant content case.
	//
	// Google skips the summary if there is no relevant content in the
	// retrieved search results.
	SearchResponse_Summary_NO_RELEVANT_CONTENT SearchResponse_Summary_SummarySkippedReason = 6
	// The jail-breaking query ignored case.
	//
	// For example, "Reply in the tone of a competing company's CEO".
	// Only used when
	// [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
	// is set to `true`.
	SearchResponse_Summary_JAIL_BREAKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 7
	// The customer policy violation case.
	//
	// Google skips the summary if there is a customer policy violation
	// detected. The policy is defined by the customer.
	SearchResponse_Summary_CUSTOMER_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 8
	// The non-answer seeking query ignored case.
	//
	// Google skips the summary if the query doesn't have clear intent.
	// Only used when
	// [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
	// is set to `true`.
	SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 SearchResponse_Summary_SummarySkippedReason = 9
	// The time out case.
	//
	// Google skips the summary if the time out.
	SearchResponse_Summary_TIME_OUT SearchResponse_Summary_SummarySkippedReason = 10
)

func (SearchResponse_Summary_SummarySkippedReason) Descriptor

func (SearchResponse_Summary_SummarySkippedReason) Enum

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 (SearchResponse_Summary_SummarySkippedReason) String

func (SearchResponse_Summary_SummarySkippedReason) Type

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

Deprecated: Use SearchResponse_Summary_SummaryWithMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata

func (*SearchResponse_Summary_SummaryWithMetadata) GetReferences

func (*SearchResponse_Summary_SummaryWithMetadata) GetSummary

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage

func (*SearchResponse_Summary_SummaryWithMetadata) ProtoReflect

func (*SearchResponse_Summary_SummaryWithMetadata) Reset

func (*SearchResponse_Summary_SummaryWithMetadata) String

SearchServiceClient

type SearchServiceClient interface {
	// Performs a search.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
	// Performs a search. Similar to the
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// method, but a lite version that allows API key for authentication, where
	// OAuth and IAM checks are not required.
	//
	// Only public website search is supported by this method. If data stores and
	// engines not associated with public website search are specified, a
	// `FAILED_PRECONDITION` error is returned.
	//
	// This method can be used for easy onboarding without having to implement an
	// authentication backend. However, it is strongly recommended to use
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// instead with required OAuth and IAM checks to provide better data security.
	SearchLite(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)
	// Performs a search. Similar to the
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// method, but a lite version that allows API key for authentication, where
	// OAuth and IAM checks are not required.
	//
	// Only public website search is supported by this method. If data stores and
	// engines not associated with public website search are specified, a
	// `FAILED_PRECONDITION` error is returned.
	//
	// This method can be used for easy onboarding without having to implement an
	// authentication backend. However, it is strongly recommended to use
	// [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
	// instead with required OAuth and IAM checks to provide better data security.
	SearchLite(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

SearchTuningServiceClient

type SearchTuningServiceClient interface {
	// Trains a custom model.
	TrainCustomModel(ctx context.Context, in *TrainCustomModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of all the custom models.
	ListCustomModels(ctx context.Context, in *ListCustomModelsRequest, opts ...grpc.CallOption) (*ListCustomModelsResponse, error)
}

SearchTuningServiceClient is the client API for SearchTuningService service.

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

func NewSearchTuningServiceClient

func NewSearchTuningServiceClient(cc grpc.ClientConnInterface) SearchTuningServiceClient

SearchTuningServiceServer

type SearchTuningServiceServer interface {
	// Trains a custom model.
	TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
	// Gets a list of all the custom models.
	ListCustomModels(context.Context, *ListCustomModelsRequest) (*ListCustomModelsResponse, error)
}

SearchTuningServiceServer is the server API for SearchTuningService service.

SearchUseCase

type SearchUseCase int32

Defines a further subdivision of SolutionType. Specifically applies to [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].

SearchUseCase_SEARCH_USE_CASE_UNSPECIFIED, SearchUseCase_SEARCH_USE_CASE_SEARCH, SearchUseCase_SEARCH_USE_CASE_BROWSE

const (
	// Value used when unset. Will not occur in CSS.
	SearchUseCase_SEARCH_USE_CASE_UNSPECIFIED SearchUseCase = 0
	// Search use case. Expects the traffic has a non-empty
	// [query][google.cloud.discoveryengine.v1.SearchRequest.query].
	SearchUseCase_SEARCH_USE_CASE_SEARCH SearchUseCase = 1
	// Browse use case. Expects the traffic has an empty
	// [query][google.cloud.discoveryengine.v1.SearchRequest.query].
	SearchUseCase_SEARCH_USE_CASE_BROWSE SearchUseCase = 2
)

func (SearchUseCase) Descriptor

func (SearchUseCase) Enum

func (x SearchUseCase) Enum() *SearchUseCase

func (SearchUseCase) EnumDescriptor

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

Deprecated: Use SearchUseCase.Descriptor instead.

func (SearchUseCase) Number

func (SearchUseCase) String

func (x SearchUseCase) String() string

func (SearchUseCase) Type

ServingConfig

type ServingConfig struct {

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

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

func (*ServingConfig) Descriptor

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) 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) GetPromoteControlIds

func (x *ServingConfig) GetPromoteControlIds() []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)
}

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)
}

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

func (*ServingConfig_GenericConfig) ProtoMessage()

func (*ServingConfig_GenericConfig) ProtoReflect

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 {

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

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

  • demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.
  • promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.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) GetDemoteContentWatchedPastDays

func (x *ServingConfig_MediaConfig) GetDemoteContentWatchedPastDays() int32

func (*ServingConfig_MediaConfig) GetDemotionEventType

func (x *ServingConfig_MediaConfig) GetDemotionEventType() string

func (*ServingConfig_MediaConfig) ProtoMessage

func (*ServingConfig_MediaConfig) ProtoMessage()

func (*ServingConfig_MediaConfig) ProtoReflect

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
	// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The display name of the session.
	//
	// This field is used to identify the session in the UI.
	// By default, the display name is the first turn query text in the session.
	DisplayName string `protobuf:"bytes,7,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The state of the session.
	State Session_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.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"`
	// Optional. Whether the session is pinned, pinned session will be displayed
	// on the top of the session list.
	IsPinned bool `protobuf:"varint,8,opt,name=is_pinned,json=isPinned,proto3" json:"is_pinned,omitempty"`
	// contains filtered or unexported fields
}

External session proto definition.

func (*Session) Descriptor

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

Deprecated: Use Session.ProtoReflect.Descriptor instead.

func (*Session) GetDisplayName

func (x *Session) GetDisplayName() string

func (*Session) GetEndTime

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

func (*Session) GetIsPinned

func (x *Session) GetIsPinned() bool

func (*Session) GetName

func (x *Session) GetName() string

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 (x *Session) GetUserPseudoId() string

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

func (x *Session) String() 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) 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 (Session_State) String

func (x Session_State) String() string

func (Session_State) Type

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.
	//
	// Only set if the answer generation (/answer API call) happened in this
	// turn.
	Answer string `protobuf:"bytes,2,opt,name=answer,proto3" json:"answer,omitempty"`
	// Output only. In
	// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
	// API, if
	// [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details]
	// is set to true, this field will be populated when getting answer query
	// session.
	DetailedAnswer *Answer `protobuf:"bytes,7,opt,name=detailed_answer,json=detailedAnswer,proto3" json:"detailed_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) GetDetailedAnswer

func (x *Session_Turn) GetDetailedAnswer() *Answer

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.v1.SiteSearchEngine].
	GetSiteSearchEngine(ctx context.Context, in *GetSiteSearchEngineRequest, opts ...grpc.CallOption) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	CreateTargetSite(ctx context.Context, in *CreateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] in a
	// batch.
	BatchCreateTargetSites(ctx context.Context, in *BatchCreateTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	GetTargetSite(ctx context.Context, in *GetTargetSiteRequest, opts ...grpc.CallOption) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	UpdateTargetSite(ctx context.Context, in *UpdateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	DeleteTargetSite(ctx context.Context, in *DeleteTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s.
	ListTargetSites(ctx context.Context, in *ListTargetSitesRequest, opts ...grpc.CallOption) (*ListTargetSitesResponse, error)
	// Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
	CreateSitemap(ctx context.Context, in *CreateSitemapRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
	DeleteSitemap(ctx context.Context, in *DeleteSitemapRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a
	// [DataStore][google.cloud.discoveryengine.v1.DataStore].
	FetchSitemaps(ctx context.Context, in *FetchSitemapsRequest, opts ...grpc.CallOption) (*FetchSitemapsResponse, 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.v1.SiteSearchEngine].
	GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)
	// Creates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] in a
	// batch.
	BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)
	// Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)
	// Updates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)
	// Deletes a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
	DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)
	// Gets a list of [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s.
	ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)
	// Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
	CreateSitemap(context.Context, *CreateSitemapRequest) (*longrunningpb.Operation, error)
	// Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
	DeleteSitemap(context.Context, *DeleteSitemapRequest) (*longrunningpb.Operation, error)
	// Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a
	// [DataStore][google.cloud.discoveryengine.v1.DataStore].
	FetchSitemaps(context.Context, *FetchSitemapsRequest) (*FetchSitemapsResponse, 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 {

	// Site verification state indicating the ownership and validity.
	SiteVerificationState SiteVerificationInfo_SiteVerificationState `protobuf:"varint,1,opt,name=site_verification_state,json=siteVerificationState,proto3,enum=google.cloud.discoveryengine.v1.SiteVerificationInfo_SiteVerificationState" json:"site_verification_state,omitempty"`
	// Latest site verification time.
	VerifyTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=verify_time,json=verifyTime,proto3" json:"verify_time,omitempty"`
	// contains filtered or unexported fields
}

Verification information for target sites in advanced site search.

func (*SiteVerificationInfo) Descriptor

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

Deprecated: Use SiteVerificationInfo.ProtoReflect.Descriptor instead.

func (*SiteVerificationInfo) GetSiteVerificationState

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) Enum

func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor

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

Deprecated: Use SiteVerificationInfo_SiteVerificationState.Descriptor instead.

func (SiteVerificationInfo_SiteVerificationState) Number

func (SiteVerificationInfo_SiteVerificationState) String

func (SiteVerificationInfo_SiteVerificationState) Type

Sitemap

type Sitemap struct {

	// Supported feed sources.
	//
	// Types that are assignable to Feed:
	//
	//	*Sitemap_Uri
	Feed isSitemap_Feed `protobuf_oneof:"feed"`
	// Output only. The fully qualified resource name of the sitemap.
	// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`
	// The `sitemap_id` suffix is system-generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The sitemap's creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A sitemap for the SiteSearchEngine.

func (*Sitemap) Descriptor

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

Deprecated: Use Sitemap.ProtoReflect.Descriptor instead.

func (*Sitemap) GetCreateTime

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

func (*Sitemap) GetFeed

func (m *Sitemap) GetFeed() isSitemap_Feed

func (*Sitemap) GetName

func (x *Sitemap) GetName() string

func (*Sitemap) GetUri

func (x *Sitemap) GetUri() string

func (*Sitemap) ProtoMessage

func (*Sitemap) ProtoMessage()

func (*Sitemap) ProtoReflect

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

func (*Sitemap) Reset

func (x *Sitemap) Reset()

func (*Sitemap) String

func (x *Sitemap) String() string

Sitemap_Uri

type Sitemap_Uri struct {
	// Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3,oneof"`
}

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) Enum

func (x SolutionType) Enum() *SolutionType

func (SolutionType) EnumDescriptor

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

Deprecated: Use SolutionType.Descriptor instead.

func (SolutionType) Number

func (SolutionType) String

func (x SolutionType) String() string

func (SolutionType) Type

SpannerSource

type SpannerSource struct {

	// The project ID that contains the Spanner source. Has a length limit of 128
	// characters. If not specified, inherits the project ID from the parent
	// request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The instance ID of the source Spanner table.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The database ID of the source Spanner table.
	DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The table name of the Spanner database that needs to be imported.
	TableId string `protobuf:"bytes,4,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Whether to apply data boost on Spanner export. Enabling this option will
	// incur additional cost. More info can be found
	// [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
	EnableDataBoost bool `protobuf:"varint,5,opt,name=enable_data_boost,json=enableDataBoost,proto3" json:"enable_data_boost,omitempty"`
	// contains filtered or unexported fields
}

The Spanner source for importing data

func (*SpannerSource) Descriptor

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 {

	// Required. Phrase to block from suggestions served. Can be maximum 125
	// characters.
	BlockPhrase string `protobuf:"bytes,1,opt,name=block_phrase,json=blockPhrase,proto3" json:"block_phrase,omitempty"`
	// Required. The match operator to apply for this phrase. Whether to block the
	// exact phrase, or block any suggestions containing this phrase.
	MatchOperator SuggestionDenyListEntry_MatchOperator `protobuf:"varint,2,opt,name=match_operator,json=matchOperator,proto3,enum=google.cloud.discoveryengine.v1.SuggestionDenyListEntry_MatchOperator" json:"match_operator,omitempty"`
	// contains filtered or unexported fields
}

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

func (*SuggestionDenyListEntry) Descriptor

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

Deprecated: Use SuggestionDenyListEntry.ProtoReflect.Descriptor instead.

func (*SuggestionDenyListEntry) GetBlockPhrase

func (x *SuggestionDenyListEntry) GetBlockPhrase() string

func (*SuggestionDenyListEntry) GetMatchOperator

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) Enum

func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor

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

Deprecated: Use SuggestionDenyListEntry_MatchOperator.Descriptor instead.

func (SuggestionDenyListEntry_MatchOperator) Number

func (SuggestionDenyListEntry_MatchOperator) String

func (SuggestionDenyListEntry_MatchOperator) Type

TargetSite

type TargetSite struct {

	// Output only. The fully qualified resource name of the target site.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
	// The `target_site_id` is system-generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Input only. The user provided URI pattern from which the
	// `generated_uri_pattern` is generated.
	ProvidedUriPattern string `protobuf:"bytes,2,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
	// The type of the target site, e.g., whether the site is to be included or
	// excluded.
	Type TargetSite_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1.TargetSite_Type" json:"type,omitempty"`
	// Immutable. If set to false, a uri_pattern is generated to include all pages
	// whose address contains the provided_uri_pattern. If set to true, an
	// uri_pattern is generated to try to be an exact match of the
	// provided_uri_pattern or just the specific page if the provided_uri_pattern
	// is a specific one. provided_uri_pattern is always normalized to
	// generate the URI pattern to be used by the search engine.
	ExactMatch bool `protobuf:"varint,6,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
	// Output only. This is system-generated based on the provided_uri_pattern.
	GeneratedUriPattern string `protobuf:"bytes,4,opt,name=generated_uri_pattern,json=generatedUriPattern,proto3" json:"generated_uri_pattern,omitempty"`
	// Output only. Root domain of the provided_uri_pattern.
	RootDomainUri string `protobuf:"bytes,10,opt,name=root_domain_uri,json=rootDomainUri,proto3" json:"root_domain_uri,omitempty"`
	// Output only. Site ownership and validity verification status.
	SiteVerificationInfo *SiteVerificationInfo `protobuf:"bytes,7,opt,name=site_verification_info,json=siteVerificationInfo,proto3" json:"site_verification_info,omitempty"`
	// Output only. Indexing status.
	IndexingStatus TargetSite_IndexingStatus `protobuf:"varint,8,opt,name=indexing_status,json=indexingStatus,proto3,enum=google.cloud.discoveryengine.v1.TargetSite_IndexingStatus" json:"indexing_status,omitempty"`
	// Output only. The target site's last updated time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Failure reason.
	FailureReason *TargetSite_FailureReason `protobuf:"bytes,9,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
	// contains filtered or unexported fields
}

A target site for the SiteSearchEngine.

func (*TargetSite) Descriptor

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) GetRootDomainUri

func (x *TargetSite) GetRootDomainUri() 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 (*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 (*TargetSite_FailureReason_QuotaFailure) Reset

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

func (TargetSite_IndexingStatus) EnumDescriptor

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

Deprecated: Use TargetSite_IndexingStatus.Descriptor instead.

func (TargetSite_IndexingStatus) Number

func (TargetSite_IndexingStatus) String

func (x TargetSite_IndexingStatus) String() string

func (TargetSite_IndexingStatus) Type

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.v1.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) 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 (TargetSite_Type) String

func (x TargetSite_Type) String() string

func (TargetSite_Type) Type

TextInput

type TextInput struct {

	// Text input.
	Input string `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// Conversation context of the input.
	Context *ConversationContext `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

Defines text input.

func (*TextInput) Descriptor

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

Deprecated: Use TextInput.ProtoReflect.Descriptor instead.

func (*TextInput) GetContext

func (x *TextInput) GetContext() *ConversationContext

func (*TextInput) GetInput

func (x *TextInput) GetInput() string

func (*TextInput) ProtoMessage

func (*TextInput) ProtoMessage()

func (*TextInput) ProtoReflect

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

func (*TextInput) Reset

func (x *TextInput) Reset()

func (*TextInput) String

func (x *TextInput) String() string

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"`
	// If not provided, a UUID will be generated.
	ModelId string `protobuf:"bytes,5,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.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 (*TrainCustomModelRequest) GetModelId

func (x *TrainCustomModelRequest) GetModelId() string

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) ProtoReflect

func (*TrainCustomModelRequest_GcsTrainingInput) Reset

func (*TrainCustomModelRequest_GcsTrainingInput) 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 {

	// A sample of errors encountered while processing the data.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors in the request if set.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// The trained model status. Possible values are:
	//
	//   - **bad-data**: The training data quality is bad.
	//   - **no-improvement**: Tuning didn't improve performance. Won't deploy.
	//   - **in-progress**: Model training job creation is in progress.
	//   - **training**: Model is actively training.
	//   - **evaluating**: The model is evaluating trained metrics.
	//   - **indexing**: The model trained metrics are indexing.
	//   - **ready**: The model is ready for serving.
	ModelStatus string `protobuf:"bytes,3,opt,name=model_status,json=modelStatus,proto3" json:"model_status,omitempty"`
	// The metrics of the trained model.
	Metrics map[string]float64 `protobuf:"bytes,4,rep,name=metrics,proto3" json:"metrics,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"fixed64,2,opt,name=value,proto3"`
	// Fully qualified name of the CustomTuningModel.
	ModelName string `protobuf:"bytes,5,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// contains filtered or unexported fields
}

Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1.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) GetModelName

func (x *TrainCustomModelResponse) GetModelName() string

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.v1.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1.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.v1.TransactionInfo.value]
	//
	// For example, if a user paid
	// [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
	// amount, then nominal (pre-discount) value of the transaction is the sum of
	// [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
	// and
	// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.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.v1.TransactionInfo.discount_value]
	// can be larger than
	// [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]:
	//
	// * Profit = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] -
	// [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
	// [cost][google.cloud.discoveryengine.v1.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

UnimplementedCompletionServiceServer

type UnimplementedCompletionServiceServer struct {
}

UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCompletionServiceServer) CompleteQuery

func (*UnimplementedCompletionServiceServer) ImportCompletionSuggestions

func (*UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries

func (*UnimplementedCompletionServiceServer) PurgeCompletionSuggestions

func (*UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries

UnimplementedControlServiceServer

type UnimplementedControlServiceServer struct {
}

UnimplementedControlServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedControlServiceServer) CreateControl

func (*UnimplementedControlServiceServer) DeleteControl

func (*UnimplementedControlServiceServer) DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)

func (*UnimplementedControlServiceServer) GetControl

func (*UnimplementedControlServiceServer) ListControls

func (*UnimplementedControlServiceServer) UpdateControl

UnimplementedConversationalSearchServiceServer

type UnimplementedConversationalSearchServiceServer struct {
}

UnimplementedConversationalSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedConversationalSearchServiceServer) AnswerQuery

func (*UnimplementedConversationalSearchServiceServer) ConverseConversation

func (*UnimplementedConversationalSearchServiceServer) CreateConversation

func (*UnimplementedConversationalSearchServiceServer) CreateSession

func (*UnimplementedConversationalSearchServiceServer) DeleteConversation

func (*UnimplementedConversationalSearchServiceServer) DeleteSession

func (*UnimplementedConversationalSearchServiceServer) GetAnswer

func (*UnimplementedConversationalSearchServiceServer) GetConversation

func (*UnimplementedConversationalSearchServiceServer) GetSession

func (*UnimplementedConversationalSearchServiceServer) ListConversations

func (*UnimplementedConversationalSearchServiceServer) ListSessions

func (*UnimplementedConversationalSearchServiceServer) StreamAnswerQuery

func (*UnimplementedConversationalSearchServiceServer) UpdateConversation

func (*UnimplementedConversationalSearchServiceServer) UpdateSession

UnimplementedDataStoreServiceServer

type UnimplementedDataStoreServiceServer struct {
}

UnimplementedDataStoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataStoreServiceServer) CreateDataStore

func (*UnimplementedDataStoreServiceServer) DeleteDataStore

func (*UnimplementedDataStoreServiceServer) GetDataStore

func (*UnimplementedDataStoreServiceServer) ListDataStores

func (*UnimplementedDataStoreServiceServer) UpdateDataStore

UnimplementedDocumentServiceServer

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentServiceServer) BatchGetDocumentsMetadata

func (*UnimplementedDocumentServiceServer) CreateDocument

func (*UnimplementedDocumentServiceServer) DeleteDocument

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

func (*UnimplementedDocumentServiceServer) GetDocument

func (*UnimplementedDocumentServiceServer) ImportDocuments

func (*UnimplementedDocumentServiceServer) ListDocuments

func (*UnimplementedDocumentServiceServer) PurgeDocuments

func (*UnimplementedDocumentServiceServer) UpdateDocument

UnimplementedEngineServiceServer

type UnimplementedEngineServiceServer struct {
}

UnimplementedEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEngineServiceServer) CreateEngine

func (*UnimplementedEngineServiceServer) DeleteEngine

func (*UnimplementedEngineServiceServer) GetEngine

func (*UnimplementedEngineServiceServer) ListEngines

func (*UnimplementedEngineServiceServer) UpdateEngine

UnimplementedGroundedGenerationServiceServer

type UnimplementedGroundedGenerationServiceServer struct {
}

UnimplementedGroundedGenerationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedGroundedGenerationServiceServer) CheckGrounding

func (*UnimplementedGroundedGenerationServiceServer) GenerateGroundedContent

func (*UnimplementedGroundedGenerationServiceServer) StreamGenerateGroundedContent

UnimplementedProjectServiceServer

type UnimplementedProjectServiceServer struct {
}

UnimplementedProjectServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedProjectServiceServer) ProvisionProject

UnimplementedRankServiceServer

type UnimplementedRankServiceServer struct {
}

UnimplementedRankServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRankServiceServer) Rank

UnimplementedRecommendationServiceServer

type UnimplementedRecommendationServiceServer struct {
}

UnimplementedRecommendationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecommendationServiceServer) Recommend

UnimplementedSchemaServiceServer

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSchemaServiceServer) CreateSchema

func (*UnimplementedSchemaServiceServer) DeleteSchema

func (*UnimplementedSchemaServiceServer) GetSchema

func (*UnimplementedSchemaServiceServer) ListSchemas

func (*UnimplementedSchemaServiceServer) UpdateSchema

UnimplementedSearchServiceServer

type UnimplementedSearchServiceServer struct {
}

UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchServiceServer) SearchLite

UnimplementedSearchTuningServiceServer

type UnimplementedSearchTuningServiceServer struct {
}

UnimplementedSearchTuningServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchTuningServiceServer) ListCustomModels

func (*UnimplementedSearchTuningServiceServer) TrainCustomModel

UnimplementedServingConfigServiceServer

type UnimplementedServingConfigServiceServer struct {
}

UnimplementedServingConfigServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig

UnimplementedSiteSearchEngineServiceServer

type UnimplementedSiteSearchEngineServiceServer struct {
}

UnimplementedSiteSearchEngineServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites

func (*UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites

func (*UnimplementedSiteSearchEngineServiceServer) CreateSitemap

func (*UnimplementedSiteSearchEngineServiceServer) CreateTargetSite

func (*UnimplementedSiteSearchEngineServiceServer) DeleteSitemap

func (*UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite

func (*UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch

func (*UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch

func (*UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus

func (*UnimplementedSiteSearchEngineServiceServer) FetchSitemaps

func (*UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine

func (*UnimplementedSiteSearchEngineServiceServer) GetTargetSite

func (*UnimplementedSiteSearchEngineServiceServer) ListTargetSites

func (*UnimplementedSiteSearchEngineServiceServer) RecrawlUris

func (*UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite

UnimplementedUserEventServiceServer

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent

func (*UnimplementedUserEventServiceServer) ImportUserEvents

func (*UnimplementedUserEventServiceServer) PurgeUserEvents

func (*UnimplementedUserEventServiceServer) WriteUserEvent

UpdateControlRequest

type UpdateControlRequest struct {

	// Required. The Control to update.
	Control *Control `protobuf:"bytes,1,opt,name=control,proto3" json:"control,omitempty"`
	// Optional. Indicates which fields in the provided
	// [Control][google.cloud.discoveryengine.v1.Control] to update. The following
	// are NOT supported:
	//
	// * [Control.name][google.cloud.discoveryengine.v1.Control.name]
	// * [Control.solution_type][google.cloud.discoveryengine.v1.Control.solution_type]
	//
	// If not set or empty, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateControl method.

func (*UpdateControlRequest) Descriptor

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

Deprecated: Use UpdateControlRequest.ProtoReflect.Descriptor instead.

func (*UpdateControlRequest) GetControl

func (x *UpdateControlRequest) GetControl() *Control

func (*UpdateControlRequest) GetUpdateMask

func (x *UpdateControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateControlRequest) ProtoMessage

func (*UpdateControlRequest) ProtoMessage()

func (*UpdateControlRequest) ProtoReflect

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

func (*UpdateControlRequest) Reset

func (x *UpdateControlRequest) Reset()

func (*UpdateControlRequest) String

func (x *UpdateControlRequest) String() string

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.v1.Conversation] to update. The
	// following are NOT supported:
	//
	// * [Conversation.name][google.cloud.discoveryengine.v1.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 (*UpdateConversationRequest) Reset

func (x *UpdateConversationRequest) Reset()

func (*UpdateConversationRequest) String

func (x *UpdateConversationRequest) String() string

UpdateDataStoreRequest

type UpdateDataStoreRequest struct {

	// Required. The [DataStore][google.cloud.discoveryengine.v1.DataStore] to
	// update.
	//
	// If the caller does not have permission to update the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [DataStore][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.Document], regardless of whether
	// or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [Document][google.cloud.discoveryengine.v1.Document] to update does
	// not exist and
	// [allow_missing][google.cloud.discoveryengine.v1.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.v1.Document] is not found, a new
	// [Document][google.cloud.discoveryengine.v1.Document] is be created.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// Indicates which fields in the provided imported 'document' to update. If
	// not set, by default updates all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.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.v1.Engine] to update.
	//
	// If the caller does not have permission to update the
	// [Engine][google.cloud.discoveryengine.v1.Engine], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Engine][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.Schema] is
	// not found, a new [Schema][google.cloud.discoveryengine.v1.Schema] is
	// created. In this situation, `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.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.v1.ServingConfig] to update.
	// The following are NOT supported:
	//
	// * [ServingConfig.name][google.cloud.discoveryengine.v1.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 (*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.v1.Session] to update. The following
	// are NOT supported:
	//
	// * [Session.name][google.cloud.discoveryengine.v1.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.v1.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.v1.TargetSite], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [TargetSite][google.cloud.discoveryengine.v1.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.v1.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 {

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

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

func (*UserEvent) Descriptor

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

Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.

func (*UserEvent) GetAttributes

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

func (*UserEvent) GetAttributionToken

func (x *UserEvent) GetAttributionToken() string

func (*UserEvent) GetCompletionInfo

func (x *UserEvent) GetCompletionInfo() *CompletionInfo

func (*UserEvent) GetConversionType

func (x *UserEvent) GetConversionType() string

func (*UserEvent) GetDataStore

func (x *UserEvent) GetDataStore() string

func (*UserEvent) GetDirectUserRequest

func (x *UserEvent) GetDirectUserRequest() bool

func (*UserEvent) GetDocuments

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

func (*UserEvent) GetEngine

func (x *UserEvent) GetEngine() string

func (*UserEvent) GetEventTime

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

func (*UserEvent) GetEventType

func (x *UserEvent) GetEventType() string

func (*UserEvent) GetFilter

func (x *UserEvent) GetFilter() string

func (*UserEvent) GetMediaInfo

func (x *UserEvent) GetMediaInfo() *MediaInfo

func (*UserEvent) GetPageInfo

func (x *UserEvent) GetPageInfo() *PageInfo

func (*UserEvent) GetPanel

func (x *UserEvent) GetPanel() *PanelInfo

func (*UserEvent) GetPanels

func (x *UserEvent) GetPanels() []*PanelInfo

func (*UserEvent) GetPromotionIds

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

func (*UserEvent) GetSearchInfo

func (x *UserEvent) GetSearchInfo() *SearchInfo

func (*UserEvent) GetSessionId

func (x *UserEvent) GetSessionId() string

func (*UserEvent) GetTagIds

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

func (*UserEvent) GetTransactionInfo

func (x *UserEvent) GetTransactionInfo() *TransactionInfo

func (*UserEvent) GetUserInfo

func (x *UserEvent) GetUserInfo() *UserInfo

func (*UserEvent) GetUserPseudoId

func (x *UserEvent) GetUserPseudoId() string

func (*UserEvent) ProtoMessage

func (*UserEvent) ProtoMessage()

func (*UserEvent) ProtoReflect

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

func (*UserEvent) Reset

func (x *UserEvent) Reset()

func (*UserEvent) String

func (x *UserEvent) String() string

UserEventServiceClient

type UserEventServiceClient interface {
	// Writes a single user event.
	WriteUserEvent(ctx context.Context, in *WriteUserEventRequest, opts ...grpc.CallOption) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a third-party domain.
	//
	// This method is used only by the Discovery Engine API JavaScript pixel and
	// Google Tag Manager. Users should not call this method directly.
	CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(ctx context.Context, in *PurgeUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Bulk import of user events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// Operation.metadata is of type ImportMetadata.
	ImportUserEvents(ctx context.Context, in *ImportUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

UserEventServiceClient is the client API for UserEventService service.

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

func NewUserEventServiceClient

func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClient

UserEventServiceServer

type UserEventServiceServer interface {
	// Writes a single user event.
	WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a third-party domain.
	//
	// This method is used only by the Discovery Engine API JavaScript pixel and
	// Google Tag Manager. Users should not call this method directly.
	CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)
	// Bulk import of user events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// Operation.metadata is of type ImportMetadata.
	ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)
}

UserEventServiceServer is the server API for UserEventService service.

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.v1.UserEventService.CollectUserEvent]
	// or if
	// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
	// is set.
	UserAgent string `protobuf:"bytes,2,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// Optional. IANA time zone, e.g. Europe/Budapest.
	TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// contains filtered or unexported fields
}

Information of an end user.

func (*UserInfo) Descriptor

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

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetTimeZone

func (x *UserInfo) GetTimeZone() string

func (*UserInfo) GetUserAgent

func (x *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId

func (x *UserInfo) GetUserId() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect

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

func (*UserInfo) Reset

func (x *UserInfo) Reset()

func (*UserInfo) String

func (x *UserInfo) String() string

WorkspaceConfig

type WorkspaceConfig struct {

	// The Google Workspace data source.
	Type WorkspaceConfig_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1.WorkspaceConfig_Type" json:"type,omitempty"`
	// Obfuscated Dasher customer ID.
	DasherCustomerId string `protobuf:"bytes,2,opt,name=dasher_customer_id,json=dasherCustomerId,proto3" json:"dasher_customer_id,omitempty"`
	// Optional. The super admin service account for the workspace that will be
	// used for access token generation. For now we only use it for Native Google
	// Drive connector data ingestion.
	SuperAdminServiceAccount string `protobuf:"bytes,4,opt,name=super_admin_service_account,json=superAdminServiceAccount,proto3" json:"super_admin_service_account,omitempty"`
	// Optional. The super admin email address for the workspace that will be used
	// for access token generation. For now we only use it for Native Google Drive
	// connector data ingestion.
	SuperAdminEmailAddress string `protobuf:"bytes,5,opt,name=super_admin_email_address,json=superAdminEmailAddress,proto3" json:"super_admin_email_address,omitempty"`
	// contains filtered or unexported fields
}

Config to store data store type configuration for workspace data

func (*WorkspaceConfig) Descriptor

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

Deprecated: Use WorkspaceConfig.ProtoReflect.Descriptor instead.

func (*WorkspaceConfig) GetDasherCustomerId

func (x *WorkspaceConfig) GetDasherCustomerId() string

func (*WorkspaceConfig) GetSuperAdminEmailAddress

func (x *WorkspaceConfig) GetSuperAdminEmailAddress() string

func (*WorkspaceConfig) GetSuperAdminServiceAccount

func (x *WorkspaceConfig) GetSuperAdminServiceAccount() string

func (*WorkspaceConfig) GetType

func (*WorkspaceConfig) ProtoMessage

func (*WorkspaceConfig) ProtoMessage()

func (*WorkspaceConfig) ProtoReflect

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

func (*WorkspaceConfig) Reset

func (x *WorkspaceConfig) Reset()

func (*WorkspaceConfig) String

func (x *WorkspaceConfig) String() string

WorkspaceConfig_Type

type WorkspaceConfig_Type int32

Specifies the type of Workspace App supported by this DataStore

WorkspaceConfig_TYPE_UNSPECIFIED, WorkspaceConfig_GOOGLE_DRIVE, WorkspaceConfig_GOOGLE_MAIL, WorkspaceConfig_GOOGLE_SITES, WorkspaceConfig_GOOGLE_CALENDAR, WorkspaceConfig_GOOGLE_CHAT, WorkspaceConfig_GOOGLE_GROUPS, WorkspaceConfig_GOOGLE_KEEP, WorkspaceConfig_GOOGLE_PEOPLE

const (
	// Defaults to an unspecified Workspace type.
	WorkspaceConfig_TYPE_UNSPECIFIED WorkspaceConfig_Type = 0
	// Workspace Data Store contains Drive data
	WorkspaceConfig_GOOGLE_DRIVE WorkspaceConfig_Type = 1
	// Workspace Data Store contains Mail data
	WorkspaceConfig_GOOGLE_MAIL WorkspaceConfig_Type = 2
	// Workspace Data Store contains Sites data
	WorkspaceConfig_GOOGLE_SITES WorkspaceConfig_Type = 3
	// Workspace Data Store contains Calendar data
	WorkspaceConfig_GOOGLE_CALENDAR WorkspaceConfig_Type = 4
	// Workspace Data Store contains Chat data
	WorkspaceConfig_GOOGLE_CHAT WorkspaceConfig_Type = 5
	// Workspace Data Store contains Groups data
	WorkspaceConfig_GOOGLE_GROUPS WorkspaceConfig_Type = 6
	// Workspace Data Store contains Keep data
	WorkspaceConfig_GOOGLE_KEEP WorkspaceConfig_Type = 7
	// Workspace Data Store contains People data
	WorkspaceConfig_GOOGLE_PEOPLE WorkspaceConfig_Type = 8
)

func (WorkspaceConfig_Type) Descriptor

func (WorkspaceConfig_Type) Enum

func (WorkspaceConfig_Type) EnumDescriptor

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

Deprecated: Use WorkspaceConfig_Type.Descriptor instead.

func (WorkspaceConfig_Type) Number

func (WorkspaceConfig_Type) String

func (x WorkspaceConfig_Type) String() string

func (WorkspaceConfig_Type) Type

WriteUserEventRequest

type WriteUserEventRequest struct {

	// Required. The parent resource name.
	// If the write user event action is applied in
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
	// is:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	// If the write user event action is applied in
	// [Location][google.cloud.location.Location] level, for example, the event
	// with [Document][google.cloud.discoveryengine.v1.Document] across multiple
	// [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
	// `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User event to write.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3,oneof" json:"user_event,omitempty"`
	// If set to true, the user event is written asynchronously after
	// validation, and the API responds without waiting for the write.
	WriteAsync bool `protobuf:"varint,3,opt,name=write_async,json=writeAsync,proto3" json:"write_async,omitempty"`
	// contains filtered or unexported fields
}

Request message for WriteUserEvent method.

func (*WriteUserEventRequest) Descriptor

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

Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.

func (*WriteUserEventRequest) GetParent

func (x *WriteUserEventRequest) GetParent() string

func (*WriteUserEventRequest) GetUserEvent

func (x *WriteUserEventRequest) GetUserEvent() *UserEvent

func (*WriteUserEventRequest) GetWriteAsync

func (x *WriteUserEventRequest) GetWriteAsync() bool

func (*WriteUserEventRequest) ProtoMessage

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) ProtoReflect

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

func (*WriteUserEventRequest) Reset

func (x *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String

func (x *WriteUserEventRequest) String() string