discoveryenginepb

package
v1.21.1 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2025 License: Apache-2.0 Imports: 18 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	CmekConfigService_UpdateCmekConfig_FullMethodName = "/google.cloud.discoveryengine.v1.CmekConfigService/UpdateCmekConfig"
	CmekConfigService_GetCmekConfig_FullMethodName    = "/google.cloud.discoveryengine.v1.CmekConfigService/GetCmekConfig"
	CmekConfigService_ListCmekConfigs_FullMethodName  = "/google.cloud.discoveryengine.v1.CmekConfigService/ListCmekConfigs"
	CmekConfigService_DeleteCmekConfig_FullMethodName = "/google.cloud.discoveryengine.v1.CmekConfigService/DeleteCmekConfig"
)
View Source 
const (
	CompletionService_CompleteQuery_FullMethodName                   = "/google.cloud.discoveryengine.v1.CompletionService/CompleteQuery"
	CompletionService_ImportSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1.CompletionService/ImportSuggestionDenyListEntries"
	CompletionService_PurgeSuggestionDenyListEntries_FullMethodName  = "/google.cloud.discoveryengine.v1.CompletionService/PurgeSuggestionDenyListEntries"
	CompletionService_ImportCompletionSuggestions_FullMethodName     = "/google.cloud.discoveryengine.v1.CompletionService/ImportCompletionSuggestions"
	CompletionService_PurgeCompletionSuggestions_FullMethodName      = "/google.cloud.discoveryengine.v1.CompletionService/PurgeCompletionSuggestions"
)
View Source 
const (
	ControlService_CreateControl_FullMethodName = "/google.cloud.discoveryengine.v1.ControlService/CreateControl"
	ControlService_DeleteControl_FullMethodName = "/google.cloud.discoveryengine.v1.ControlService/DeleteControl"
	ControlService_UpdateControl_FullMethodName = "/google.cloud.discoveryengine.v1.ControlService/UpdateControl"
	ControlService_GetControl_FullMethodName    = "/google.cloud.discoveryengine.v1.ControlService/GetControl"
	ControlService_ListControls_FullMethodName  = "/google.cloud.discoveryengine.v1.ControlService/ListControls"
)
View Source 
const (
	ConversationalSearchService_ConverseConversation_FullMethodName = "/google.cloud.discoveryengine.v1.ConversationalSearchService/ConverseConversation"
	ConversationalSearchService_CreateConversation_FullMethodName   = "/google.cloud.discoveryengine.v1.ConversationalSearchService/CreateConversation"
	ConversationalSearchService_DeleteConversation_FullMethodName   = "/google.cloud.discoveryengine.v1.ConversationalSearchService/DeleteConversation"
	ConversationalSearchService_UpdateConversation_FullMethodName   = "/google.cloud.discoveryengine.v1.ConversationalSearchService/UpdateConversation"
	ConversationalSearchService_GetConversation_FullMethodName      = "/google.cloud.discoveryengine.v1.ConversationalSearchService/GetConversation"
	ConversationalSearchService_ListConversations_FullMethodName    = "/google.cloud.discoveryengine.v1.ConversationalSearchService/ListConversations"
	ConversationalSearchService_AnswerQuery_FullMethodName          = "/google.cloud.discoveryengine.v1.ConversationalSearchService/AnswerQuery"
	ConversationalSearchService_StreamAnswerQuery_FullMethodName    = "/google.cloud.discoveryengine.v1.ConversationalSearchService/StreamAnswerQuery"
	ConversationalSearchService_GetAnswer_FullMethodName            = "/google.cloud.discoveryengine.v1.ConversationalSearchService/GetAnswer"
	ConversationalSearchService_CreateSession_FullMethodName        = "/google.cloud.discoveryengine.v1.ConversationalSearchService/CreateSession"
	ConversationalSearchService_DeleteSession_FullMethodName        = "/google.cloud.discoveryengine.v1.ConversationalSearchService/DeleteSession"
	ConversationalSearchService_UpdateSession_FullMethodName        = "/google.cloud.discoveryengine.v1.ConversationalSearchService/UpdateSession"
	ConversationalSearchService_GetSession_FullMethodName           = "/google.cloud.discoveryengine.v1.ConversationalSearchService/GetSession"
	ConversationalSearchService_ListSessions_FullMethodName         = "/google.cloud.discoveryengine.v1.ConversationalSearchService/ListSessions"
)
View Source 
const (
	DataStoreService_CreateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1.DataStoreService/CreateDataStore"
	DataStoreService_GetDataStore_FullMethodName    = "/google.cloud.discoveryengine.v1.DataStoreService/GetDataStore"
	DataStoreService_ListDataStores_FullMethodName  = "/google.cloud.discoveryengine.v1.DataStoreService/ListDataStores"
	DataStoreService_DeleteDataStore_FullMethodName = "/google.cloud.discoveryengine.v1.DataStoreService/DeleteDataStore"
	DataStoreService_UpdateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1.DataStoreService/UpdateDataStore"
)
View Source 
const (
	DocumentService_GetDocument_FullMethodName               = "/google.cloud.discoveryengine.v1.DocumentService/GetDocument"
	DocumentService_ListDocuments_FullMethodName             = "/google.cloud.discoveryengine.v1.DocumentService/ListDocuments"
	DocumentService_CreateDocument_FullMethodName            = "/google.cloud.discoveryengine.v1.DocumentService/CreateDocument"
	DocumentService_UpdateDocument_FullMethodName            = "/google.cloud.discoveryengine.v1.DocumentService/UpdateDocument"
	DocumentService_DeleteDocument_FullMethodName            = "/google.cloud.discoveryengine.v1.DocumentService/DeleteDocument"
	DocumentService_ImportDocuments_FullMethodName           = "/google.cloud.discoveryengine.v1.DocumentService/ImportDocuments"
	DocumentService_PurgeDocuments_FullMethodName            = "/google.cloud.discoveryengine.v1.DocumentService/PurgeDocuments"
	DocumentService_BatchGetDocumentsMetadata_FullMethodName = "/google.cloud.discoveryengine.v1.DocumentService/BatchGetDocumentsMetadata"
)
View Source 
const (
	EngineService_CreateEngine_FullMethodName = "/google.cloud.discoveryengine.v1.EngineService/CreateEngine"
	EngineService_DeleteEngine_FullMethodName = "/google.cloud.discoveryengine.v1.EngineService/DeleteEngine"
	EngineService_UpdateEngine_FullMethodName = "/google.cloud.discoveryengine.v1.EngineService/UpdateEngine"
	EngineService_GetEngine_FullMethodName    = "/google.cloud.discoveryengine.v1.EngineService/GetEngine"
	EngineService_ListEngines_FullMethodName  = "/google.cloud.discoveryengine.v1.EngineService/ListEngines"
)
View Source 
const (
	GroundedGenerationService_StreamGenerateGroundedContent_FullMethodName = "/google.cloud.discoveryengine.v1.GroundedGenerationService/StreamGenerateGroundedContent"
	GroundedGenerationService_GenerateGroundedContent_FullMethodName       = "/google.cloud.discoveryengine.v1.GroundedGenerationService/GenerateGroundedContent"
	GroundedGenerationService_CheckGrounding_FullMethodName                = "/google.cloud.discoveryengine.v1.GroundedGenerationService/CheckGrounding"
)
View Source 
const (
	IdentityMappingStoreService_CreateIdentityMappingStore_FullMethodName = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/CreateIdentityMappingStore"
	IdentityMappingStoreService_GetIdentityMappingStore_FullMethodName    = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/GetIdentityMappingStore"
	IdentityMappingStoreService_DeleteIdentityMappingStore_FullMethodName = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/DeleteIdentityMappingStore"
	IdentityMappingStoreService_ImportIdentityMappings_FullMethodName     = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/ImportIdentityMappings"
	IdentityMappingStoreService_PurgeIdentityMappings_FullMethodName      = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/PurgeIdentityMappings"
	IdentityMappingStoreService_ListIdentityMappings_FullMethodName       = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/ListIdentityMappings"
	IdentityMappingStoreService_ListIdentityMappingStores_FullMethodName  = "/google.cloud.discoveryengine.v1.IdentityMappingStoreService/ListIdentityMappingStores"
)
View Source 
const (
	SchemaService_GetSchema_FullMethodName    = "/google.cloud.discoveryengine.v1.SchemaService/GetSchema"
	SchemaService_ListSchemas_FullMethodName  = "/google.cloud.discoveryengine.v1.SchemaService/ListSchemas"
	SchemaService_CreateSchema_FullMethodName = "/google.cloud.discoveryengine.v1.SchemaService/CreateSchema"
	SchemaService_UpdateSchema_FullMethodName = "/google.cloud.discoveryengine.v1.SchemaService/UpdateSchema"
	SchemaService_DeleteSchema_FullMethodName = "/google.cloud.discoveryengine.v1.SchemaService/DeleteSchema"
)
View Source 
const (
	SearchService_Search_FullMethodName     = "/google.cloud.discoveryengine.v1.SearchService/Search"
	SearchService_SearchLite_FullMethodName = "/google.cloud.discoveryengine.v1.SearchService/SearchLite"
)
View Source 
const (
	SearchTuningService_TrainCustomModel_FullMethodName = "/google.cloud.discoveryengine.v1.SearchTuningService/TrainCustomModel"
	SearchTuningService_ListCustomModels_FullMethodName = "/google.cloud.discoveryengine.v1.SearchTuningService/ListCustomModels"
)
View Source 
const (
	SessionService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1.SessionService/CreateSession"
	SessionService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1.SessionService/DeleteSession"
	SessionService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1.SessionService/UpdateSession"
	SessionService_GetSession_FullMethodName    = "/google.cloud.discoveryengine.v1.SessionService/GetSession"
	SessionService_ListSessions_FullMethodName  = "/google.cloud.discoveryengine.v1.SessionService/ListSessions"
)
View Source 
const (
	SiteSearchEngineService_GetSiteSearchEngine_FullMethodName           = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/GetSiteSearchEngine"
	SiteSearchEngineService_CreateTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/CreateTargetSite"
	SiteSearchEngineService_BatchCreateTargetSites_FullMethodName        = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/BatchCreateTargetSites"
	SiteSearchEngineService_GetTargetSite_FullMethodName                 = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/GetTargetSite"
	SiteSearchEngineService_UpdateTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/UpdateTargetSite"
	SiteSearchEngineService_DeleteTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/DeleteTargetSite"
	SiteSearchEngineService_ListTargetSites_FullMethodName               = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/ListTargetSites"
	SiteSearchEngineService_CreateSitemap_FullMethodName                 = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/CreateSitemap"
	SiteSearchEngineService_DeleteSitemap_FullMethodName                 = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/DeleteSitemap"
	SiteSearchEngineService_FetchSitemaps_FullMethodName                 = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/FetchSitemaps"
	SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName      = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/EnableAdvancedSiteSearch"
	SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName     = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/DisableAdvancedSiteSearch"
	SiteSearchEngineService_RecrawlUris_FullMethodName                   = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/RecrawlUris"
	SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName        = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/BatchVerifyTargetSites"
	SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName = "/google.cloud.discoveryengine.v1.SiteSearchEngineService/FetchDomainVerificationStatus"
)
View Source 
const (
	UserEventService_WriteUserEvent_FullMethodName   = "/google.cloud.discoveryengine.v1.UserEventService/WriteUserEvent"
	UserEventService_CollectUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1.UserEventService/CollectUserEvent"
	UserEventService_PurgeUserEvents_FullMethodName  = "/google.cloud.discoveryengine.v1.UserEventService/PurgeUserEvents"
	UserEventService_ImportUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1.UserEventService/ImportUserEvents"
)
View Source 
const (
	UserLicenseService_ListUserLicenses_FullMethodName        = "/google.cloud.discoveryengine.v1.UserLicenseService/ListUserLicenses"
	UserLicenseService_BatchUpdateUserLicenses_FullMethodName = "/google.cloud.discoveryengine.v1.UserLicenseService/BatchUpdateUserLicenses"
)
View Source 
const (
	AssistantService_StreamAssist_FullMethodName = "/google.cloud.discoveryengine.v1.AssistantService/StreamAssist"
)
View Source 
const (
	ProjectService_ProvisionProject_FullMethodName = "/google.cloud.discoveryengine.v1.ProjectService/ProvisionProject"
)
View Source 
const (
	RankService_Rank_FullMethodName = "/google.cloud.discoveryengine.v1.RankService/Rank"
)
View Source 
const (
	RecommendationService_Recommend_FullMethodName = "/google.cloud.discoveryengine.v1.RecommendationService/Recommend"
)
View Source 
const (
	ServingConfigService_UpdateServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1.ServingConfigService/UpdateServingConfig"
)

Variables

View Source 
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.

View Source 
var (
	Answer_AnswerSkippedReason_name = map[int32]string{
		0:  "ANSWER_SKIPPED_REASON_UNSPECIFIED",
		1:  "ADVERSARIAL_QUERY_IGNORED",
		2:  "NON_ANSWER_SEEKING_QUERY_IGNORED",
		3:  "OUT_OF_DOMAIN_QUERY_IGNORED",
		4:  "POTENTIAL_POLICY_VIOLATION",
		5:  "NO_RELEVANT_CONTENT",
		6:  "JAIL_BREAKING_QUERY_IGNORED",
		7:  "CUSTOMER_POLICY_VIOLATION",
		8:  "NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
		9:  "LOW_GROUNDED_ANSWER",
		10: "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED",
		11: "UNHELPFUL_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,
		"USER_DEFINED_CLASSIFICATION_QUERY_IGNORED": 10,
		"UNHELPFUL_ANSWER":                          11,
	}
)

Enum value maps for Answer_AnswerSkippedReason.

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

Enum value maps for Answer_Step_State.

View Source 
var (
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY",
		2: "NON_ANSWER_SEEKING_QUERY",
		3: "JAIL_BREAKING_QUERY",
		4: "NON_ANSWER_SEEKING_QUERY_V2",
		5: "USER_DEFINED_CLASSIFICATION_QUERY",
	}
	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,
		"USER_DEFINED_CLASSIFICATION_QUERY": 5,
	}
)

Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.

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

Enum value maps for AssistAnswer_State.

View Source 
var (
	AssistAnswer_AssistSkippedReason_name = map[int32]string{
		0: "ASSIST_SKIPPED_REASON_UNSPECIFIED",
		1: "NON_ASSIST_SEEKING_QUERY_IGNORED",
		2: "CUSTOMER_POLICY_VIOLATION",
	}
	AssistAnswer_AssistSkippedReason_value = map[string]int32{
		"ASSIST_SKIPPED_REASON_UNSPECIFIED": 0,
		"NON_ASSIST_SEEKING_QUERY_IGNORED":  1,
		"CUSTOMER_POLICY_VIOLATION":         2,
	}
)

Enum value maps for AssistAnswer_AssistSkippedReason.

View Source 
var (
	AssistantContent_CodeExecutionResult_Outcome_name = map[int32]string{
		0: "OUTCOME_UNSPECIFIED",
		1: "OUTCOME_OK",
		2: "OUTCOME_FAILED",
		3: "OUTCOME_DEADLINE_EXCEEDED",
	}
	AssistantContent_CodeExecutionResult_Outcome_value = map[string]int32{
		"OUTCOME_UNSPECIFIED":       0,
		"OUTCOME_OK":                1,
		"OUTCOME_FAILED":            2,
		"OUTCOME_DEADLINE_EXCEEDED": 3,
	}
)

Enum value maps for AssistantContent_CodeExecutionResult_Outcome.

View Source 
var (
	Chunk_StructureType_name = map[int32]string{
		0: "STRUCTURE_TYPE_UNSPECIFIED",
		1: "SHAREHOLDER_STRUCTURE",
		2: "SIGNATURE_STRUCTURE",
		3: "CHECKBOX_STRUCTURE",
	}
	Chunk_StructureType_value = map[string]int32{
		"STRUCTURE_TYPE_UNSPECIFIED": 0,
		"SHAREHOLDER_STRUCTURE":      1,
		"SIGNATURE_STRUCTURE":        2,
		"CHECKBOX_STRUCTURE":         3,
	}
)

Enum value maps for Chunk_StructureType.

View Source 
var (
	CmekConfig_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "KEY_ISSUE",
		4: "DELETING",
		7: "DELETE_FAILED",
		5: "UNUSABLE",
		6: "ACTIVE_ROTATING",
		8: "DELETED",
	}
	CmekConfig_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"KEY_ISSUE":         3,
		"DELETING":          4,
		"DELETE_FAILED":     7,
		"UNUSABLE":          5,
		"ACTIVE_ROTATING":   6,
		"DELETED":           8,
	}
)

Enum value maps for CmekConfig_State.

View Source 
var (
	CmekConfig_NotebookLMState_name = map[int32]string{
		0: "NOTEBOOK_LM_STATE_UNSPECIFIED",
		1: "NOTEBOOK_LM_NOT_READY",
		2: "NOTEBOOK_LM_READY",
		3: "NOTEBOOK_LM_NOT_ENABLED",
	}
	CmekConfig_NotebookLMState_value = map[string]int32{
		"NOTEBOOK_LM_STATE_UNSPECIFIED": 0,
		"NOTEBOOK_LM_NOT_READY":         1,
		"NOTEBOOK_LM_READY":             2,
		"NOTEBOOK_LM_NOT_ENABLED":       3,
	}
)

Enum value maps for CmekConfig_NotebookLMState.

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

Enum value maps for IndustryVertical.

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

Enum value maps for SolutionType.

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

Enum value maps for SearchUseCase.

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

Enum value maps for SearchTier.

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

Enum value maps for SearchAddOn.

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

Enum value maps for SuggestionDenyListEntry_MatchOperator.

View Source 
var (
	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.

View Source 
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.

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

Enum value maps for Conversation_State.

View Source 
var (
	AnswerQueryRequest_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.

View Source 
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.

View Source 
var (
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "ADVERSARIAL_QUERY",
		2: "NON_ANSWER_SEEKING_QUERY",
		3: "JAIL_BREAKING_QUERY",
		4: "NON_ANSWER_SEEKING_QUERY_V2",
		5: "USER_DEFINED_CLASSIFICATION_QUERY",
	}
	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,
		"USER_DEFINED_CLASSIFICATION_QUERY": 5,
	}
)

Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.

View Source 
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.

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

Enum value maps for CustomTuningModel_ModelState.

View Source 
var (
	DataStore_ContentConfig_name = map[int32]string{
		0: "CONTENT_CONFIG_UNSPECIFIED",
		1: "NO_CONTENT",
		2: "CONTENT_REQUIRED",
		3: "PUBLIC_WEBSITE",
		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.

View Source 
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.

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

Enum value maps for BatchGetDocumentsMetadataResponse_State.

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

Enum value maps for Engine_MediaRecommendationEngineConfig_TrainingState.

View Source 
var (
	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.

View Source 
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.

View Source 
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.

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

Enum value maps for BigtableOptions_Type.

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

Enum value maps for BigtableOptions_Encoding.

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

Enum value maps for ImportDocumentsRequest_ReconciliationMode.

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

Enum value maps for Project_ServiceTerms_State.

View Source 
var (
	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.

View Source 
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.

View Source 
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.

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

Enum value maps for SearchRequest_RelevanceThreshold.

View Source 
var (
	SearchRequest_RankingExpressionBackend_name = map[int32]string{
		0: "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
		3: "RANK_BY_EMBEDDING",
		4: "RANK_BY_FORMULA",
	}
	SearchRequest_RankingExpressionBackend_value = map[string]int32{
		"RANKING_EXPRESSION_BACKEND_UNSPECIFIED": 0,
		"RANK_BY_EMBEDDING":                      3,
		"RANK_BY_FORMULA":                        4,
	}
)

Enum value maps for SearchRequest_RankingExpressionBackend.

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

Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.

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

Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.

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

Enum value maps for SearchRequest_QueryExpansionSpec_Condition.

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

Enum value maps for SearchRequest_SpellCorrectionSpec_Mode.

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

Enum value maps for SearchRequest_ContentSearchSpec_SearchResultMode.

View Source 
var (
	SearchRequest_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.

View Source 
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.

View Source 
var (
	SearchResponse_Summary_SummarySkippedReason_name = map[int32]string{
		0:  "SUMMARY_SKIPPED_REASON_UNSPECIFIED",
		1:  "ADVERSARIAL_QUERY_IGNORED",
		2:  "NON_SUMMARY_SEEKING_QUERY_IGNORED",
		3:  "OUT_OF_DOMAIN_QUERY_IGNORED",
		4:  "POTENTIAL_POLICY_VIOLATION",
		5:  "LLM_ADDON_NOT_ENABLED",
		6:  "NO_RELEVANT_CONTENT",
		7:  "JAIL_BREAKING_QUERY_IGNORED",
		8:  "CUSTOMER_POLICY_VIOLATION",
		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.

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

Enum value maps for Session_State.

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

Enum value maps for TargetSite_Type.

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

Enum value maps for TargetSite_IndexingStatus.

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

Enum value maps for SiteVerificationInfo_SiteVerificationState.

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

Enum value maps for RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.

View Source 
var (
	UserLicense_LicenseAssignmentState_name = map[int32]string{
		0: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
		1: "ASSIGNED",
		2: "UNASSIGNED",
		3: "NO_LICENSE",
		4: "NO_LICENSE_ATTEMPTED_LOGIN",
	}
	UserLicense_LicenseAssignmentState_value = map[string]int32{
		"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED": 0,
		"ASSIGNED":                             1,
		"UNASSIGNED":                           2,
		"NO_LICENSE":                           3,
		"NO_LICENSE_ATTEMPTED_LOGIN":           4,
	}
)

Enum value maps for UserLicense_LicenseAssignmentState.

View Source 
var AssistantService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.AssistantService",
	HandlerType: (*AssistantServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamAssist",
			Handler:       _AssistantService_StreamAssist_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "google/cloud/discoveryengine/v1/assistant_service.proto",
}

AssistantService_ServiceDesc is the grpc.ServiceDesc for AssistantService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var CmekConfigService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.CmekConfigService",
	HandlerType: (*CmekConfigServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UpdateCmekConfig",
			Handler:    _CmekConfigService_UpdateCmekConfig_Handler,
		},
		{
			MethodName: "GetCmekConfig",
			Handler:    _CmekConfigService_GetCmekConfig_Handler,
		},
		{
			MethodName: "ListCmekConfigs",
			Handler:    _CmekConfigService_ListCmekConfigs_Handler,
		},
		{
			MethodName: "DeleteCmekConfig",
			Handler:    _CmekConfigService_DeleteCmekConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/cmek_config_service.proto",
}

CmekConfigService_ServiceDesc is the grpc.ServiceDesc for CmekConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var CompletionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.CompletionService",
	HandlerType: (*CompletionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CompleteQuery",
			Handler:    _CompletionService_CompleteQuery_Handler,
		},
		{
			MethodName: "ImportSuggestionDenyListEntries",
			Handler:    _CompletionService_ImportSuggestionDenyListEntries_Handler,
		},
		{
			MethodName: "PurgeSuggestionDenyListEntries",
			Handler:    _CompletionService_PurgeSuggestionDenyListEntries_Handler,
		},
		{
			MethodName: "ImportCompletionSuggestions",
			Handler:    _CompletionService_ImportCompletionSuggestions_Handler,
		},
		{
			MethodName: "PurgeCompletionSuggestions",
			Handler:    _CompletionService_PurgeCompletionSuggestions_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/completion_service.proto",
}

CompletionService_ServiceDesc is the grpc.ServiceDesc for CompletionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var ControlService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.ControlService",
	HandlerType: (*ControlServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateControl",
			Handler:    _ControlService_CreateControl_Handler,
		},
		{
			MethodName: "DeleteControl",
			Handler:    _ControlService_DeleteControl_Handler,
		},
		{
			MethodName: "UpdateControl",
			Handler:    _ControlService_UpdateControl_Handler,
		},
		{
			MethodName: "GetControl",
			Handler:    _ControlService_GetControl_Handler,
		},
		{
			MethodName: "ListControls",
			Handler:    _ControlService_ListControls_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/control_service.proto",
}

ControlService_ServiceDesc is the grpc.ServiceDesc for ControlService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var ConversationalSearchService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.ConversationalSearchService",
	HandlerType: (*ConversationalSearchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ConverseConversation",
			Handler:    _ConversationalSearchService_ConverseConversation_Handler,
		},
		{
			MethodName: "CreateConversation",
			Handler:    _ConversationalSearchService_CreateConversation_Handler,
		},
		{
			MethodName: "DeleteConversation",
			Handler:    _ConversationalSearchService_DeleteConversation_Handler,
		},
		{
			MethodName: "UpdateConversation",
			Handler:    _ConversationalSearchService_UpdateConversation_Handler,
		},
		{
			MethodName: "GetConversation",
			Handler:    _ConversationalSearchService_GetConversation_Handler,
		},
		{
			MethodName: "ListConversations",
			Handler:    _ConversationalSearchService_ListConversations_Handler,
		},
		{
			MethodName: "AnswerQuery",
			Handler:    _ConversationalSearchService_AnswerQuery_Handler,
		},
		{
			MethodName: "GetAnswer",
			Handler:    _ConversationalSearchService_GetAnswer_Handler,
		},
		{
			MethodName: "CreateSession",
			Handler:    _ConversationalSearchService_CreateSession_Handler,
		},
		{
			MethodName: "DeleteSession",
			Handler:    _ConversationalSearchService_DeleteSession_Handler,
		},
		{
			MethodName: "UpdateSession",
			Handler:    _ConversationalSearchService_UpdateSession_Handler,
		},
		{
			MethodName: "GetSession",
			Handler:    _ConversationalSearchService_GetSession_Handler,
		},
		{
			MethodName: "ListSessions",
			Handler:    _ConversationalSearchService_ListSessions_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamAnswerQuery",
			Handler:       _ConversationalSearchService_StreamAnswerQuery_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "google/cloud/discoveryengine/v1/conversational_search_service.proto",
}

ConversationalSearchService_ServiceDesc is the grpc.ServiceDesc for ConversationalSearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var DataStoreService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.DataStoreService",
	HandlerType: (*DataStoreServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateDataStore",
			Handler:    _DataStoreService_CreateDataStore_Handler,
		},
		{
			MethodName: "GetDataStore",
			Handler:    _DataStoreService_GetDataStore_Handler,
		},
		{
			MethodName: "ListDataStores",
			Handler:    _DataStoreService_ListDataStores_Handler,
		},
		{
			MethodName: "DeleteDataStore",
			Handler:    _DataStoreService_DeleteDataStore_Handler,
		},
		{
			MethodName: "UpdateDataStore",
			Handler:    _DataStoreService_UpdateDataStore_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/data_store_service.proto",
}

DataStoreService_ServiceDesc is the grpc.ServiceDesc for DataStoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var DocumentService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.DocumentService",
	HandlerType: (*DocumentServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetDocument",
			Handler:    _DocumentService_GetDocument_Handler,
		},
		{
			MethodName: "ListDocuments",
			Handler:    _DocumentService_ListDocuments_Handler,
		},
		{
			MethodName: "CreateDocument",
			Handler:    _DocumentService_CreateDocument_Handler,
		},
		{
			MethodName: "UpdateDocument",
			Handler:    _DocumentService_UpdateDocument_Handler,
		},
		{
			MethodName: "DeleteDocument",
			Handler:    _DocumentService_DeleteDocument_Handler,
		},
		{
			MethodName: "ImportDocuments",
			Handler:    _DocumentService_ImportDocuments_Handler,
		},
		{
			MethodName: "PurgeDocuments",
			Handler:    _DocumentService_PurgeDocuments_Handler,
		},
		{
			MethodName: "BatchGetDocumentsMetadata",
			Handler:    _DocumentService_BatchGetDocumentsMetadata_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/document_service.proto",
}

DocumentService_ServiceDesc is the grpc.ServiceDesc for DocumentService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var EngineService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.EngineService",
	HandlerType: (*EngineServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateEngine",
			Handler:    _EngineService_CreateEngine_Handler,
		},
		{
			MethodName: "DeleteEngine",
			Handler:    _EngineService_DeleteEngine_Handler,
		},
		{
			MethodName: "UpdateEngine",
			Handler:    _EngineService_UpdateEngine_Handler,
		},
		{
			MethodName: "GetEngine",
			Handler:    _EngineService_GetEngine_Handler,
		},
		{
			MethodName: "ListEngines",
			Handler:    _EngineService_ListEngines_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/engine_service.proto",
}

EngineService_ServiceDesc is the grpc.ServiceDesc for EngineService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_google_cloud_discoveryengine_v1_answer_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_assist_answer_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_assistant_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_assistant_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_chunk_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_cmek_config_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_common_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_completion_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_completion_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_control_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_control_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_conversation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_conversational_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_custom_tuning_model_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_data_store_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_data_store_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_document_processing_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_document_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_document_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_grounded_generation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_grounding_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_identity_mapping_store_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_identity_mapping_store_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_import_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_project_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_project_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_purge_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_rank_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_recommendation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_safety_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_schema_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_schema_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_search_tuning_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_serving_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_serving_config_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_session_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_session_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_site_search_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_site_search_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_user_event_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_user_event_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_user_license_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1_user_license_service_proto protoreflect.FileDescriptor
View Source 
var GroundedGenerationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.GroundedGenerationService",
	HandlerType: (*GroundedGenerationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GenerateGroundedContent",
			Handler:    _GroundedGenerationService_GenerateGroundedContent_Handler,
		},
		{
			MethodName: "CheckGrounding",
			Handler:    _GroundedGenerationService_CheckGrounding_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamGenerateGroundedContent",
			Handler:       _GroundedGenerationService_StreamGenerateGroundedContent_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "google/cloud/discoveryengine/v1/grounded_generation_service.proto",
}

GroundedGenerationService_ServiceDesc is the grpc.ServiceDesc for GroundedGenerationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var IdentityMappingStoreService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.IdentityMappingStoreService",
	HandlerType: (*IdentityMappingStoreServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateIdentityMappingStore",
			Handler:    _IdentityMappingStoreService_CreateIdentityMappingStore_Handler,
		},
		{
			MethodName: "GetIdentityMappingStore",
			Handler:    _IdentityMappingStoreService_GetIdentityMappingStore_Handler,
		},
		{
			MethodName: "DeleteIdentityMappingStore",
			Handler:    _IdentityMappingStoreService_DeleteIdentityMappingStore_Handler,
		},
		{
			MethodName: "ImportIdentityMappings",
			Handler:    _IdentityMappingStoreService_ImportIdentityMappings_Handler,
		},
		{
			MethodName: "PurgeIdentityMappings",
			Handler:    _IdentityMappingStoreService_PurgeIdentityMappings_Handler,
		},
		{
			MethodName: "ListIdentityMappings",
			Handler:    _IdentityMappingStoreService_ListIdentityMappings_Handler,
		},
		{
			MethodName: "ListIdentityMappingStores",
			Handler:    _IdentityMappingStoreService_ListIdentityMappingStores_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
}

IdentityMappingStoreService_ServiceDesc is the grpc.ServiceDesc for IdentityMappingStoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var ProjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.ProjectService",
	HandlerType: (*ProjectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ProvisionProject",
			Handler:    _ProjectService_ProvisionProject_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/project_service.proto",
}

ProjectService_ServiceDesc is the grpc.ServiceDesc for ProjectService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var RankService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.RankService",
	HandlerType: (*RankServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Rank",
			Handler:    _RankService_Rank_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/rank_service.proto",
}

RankService_ServiceDesc is the grpc.ServiceDesc for RankService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var RecommendationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.RecommendationService",
	HandlerType: (*RecommendationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Recommend",
			Handler:    _RecommendationService_Recommend_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/recommendation_service.proto",
}

RecommendationService_ServiceDesc is the grpc.ServiceDesc for RecommendationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var SchemaService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.SchemaService",
	HandlerType: (*SchemaServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSchema",
			Handler:    _SchemaService_GetSchema_Handler,
		},
		{
			MethodName: "ListSchemas",
			Handler:    _SchemaService_ListSchemas_Handler,
		},
		{
			MethodName: "CreateSchema",
			Handler:    _SchemaService_CreateSchema_Handler,
		},
		{
			MethodName: "UpdateSchema",
			Handler:    _SchemaService_UpdateSchema_Handler,
		},
		{
			MethodName: "DeleteSchema",
			Handler:    _SchemaService_DeleteSchema_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/schema_service.proto",
}

SchemaService_ServiceDesc is the grpc.ServiceDesc for SchemaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var SearchService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.SearchService",
	HandlerType: (*SearchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Search",
			Handler:    _SearchService_Search_Handler,
		},
		{
			MethodName: "SearchLite",
			Handler:    _SearchService_SearchLite_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/search_service.proto",
}

SearchService_ServiceDesc is the grpc.ServiceDesc for SearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var SearchTuningService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.SearchTuningService",
	HandlerType: (*SearchTuningServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "TrainCustomModel",
			Handler:    _SearchTuningService_TrainCustomModel_Handler,
		},
		{
			MethodName: "ListCustomModels",
			Handler:    _SearchTuningService_ListCustomModels_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/search_tuning_service.proto",
}

SearchTuningService_ServiceDesc is the grpc.ServiceDesc for SearchTuningService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var ServingConfigService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.ServingConfigService",
	HandlerType: (*ServingConfigServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UpdateServingConfig",
			Handler:    _ServingConfigService_UpdateServingConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/serving_config_service.proto",
}

ServingConfigService_ServiceDesc is the grpc.ServiceDesc for ServingConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var SessionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.SessionService",
	HandlerType: (*SessionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateSession",
			Handler:    _SessionService_CreateSession_Handler,
		},
		{
			MethodName: "DeleteSession",
			Handler:    _SessionService_DeleteSession_Handler,
		},
		{
			MethodName: "UpdateSession",
			Handler:    _SessionService_UpdateSession_Handler,
		},
		{
			MethodName: "GetSession",
			Handler:    _SessionService_GetSession_Handler,
		},
		{
			MethodName: "ListSessions",
			Handler:    _SessionService_ListSessions_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/session_service.proto",
}

SessionService_ServiceDesc is the grpc.ServiceDesc for SessionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var SiteSearchEngineService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.SiteSearchEngineService",
	HandlerType: (*SiteSearchEngineServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSiteSearchEngine",
			Handler:    _SiteSearchEngineService_GetSiteSearchEngine_Handler,
		},
		{
			MethodName: "CreateTargetSite",
			Handler:    _SiteSearchEngineService_CreateTargetSite_Handler,
		},
		{
			MethodName: "BatchCreateTargetSites",
			Handler:    _SiteSearchEngineService_BatchCreateTargetSites_Handler,
		},
		{
			MethodName: "GetTargetSite",
			Handler:    _SiteSearchEngineService_GetTargetSite_Handler,
		},
		{
			MethodName: "UpdateTargetSite",
			Handler:    _SiteSearchEngineService_UpdateTargetSite_Handler,
		},
		{
			MethodName: "DeleteTargetSite",
			Handler:    _SiteSearchEngineService_DeleteTargetSite_Handler,
		},
		{
			MethodName: "ListTargetSites",
			Handler:    _SiteSearchEngineService_ListTargetSites_Handler,
		},
		{
			MethodName: "CreateSitemap",
			Handler:    _SiteSearchEngineService_CreateSitemap_Handler,
		},
		{
			MethodName: "DeleteSitemap",
			Handler:    _SiteSearchEngineService_DeleteSitemap_Handler,
		},
		{
			MethodName: "FetchSitemaps",
			Handler:    _SiteSearchEngineService_FetchSitemaps_Handler,
		},
		{
			MethodName: "EnableAdvancedSiteSearch",
			Handler:    _SiteSearchEngineService_EnableAdvancedSiteSearch_Handler,
		},
		{
			MethodName: "DisableAdvancedSiteSearch",
			Handler:    _SiteSearchEngineService_DisableAdvancedSiteSearch_Handler,
		},
		{
			MethodName: "RecrawlUris",
			Handler:    _SiteSearchEngineService_RecrawlUris_Handler,
		},
		{
			MethodName: "BatchVerifyTargetSites",
			Handler:    _SiteSearchEngineService_BatchVerifyTargetSites_Handler,
		},
		{
			MethodName: "FetchDomainVerificationStatus",
			Handler:    _SiteSearchEngineService_FetchDomainVerificationStatus_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/site_search_engine_service.proto",
}

SiteSearchEngineService_ServiceDesc is the grpc.ServiceDesc for SiteSearchEngineService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var UserEventService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.UserEventService",
	HandlerType: (*UserEventServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "WriteUserEvent",
			Handler:    _UserEventService_WriteUserEvent_Handler,
		},
		{
			MethodName: "CollectUserEvent",
			Handler:    _UserEventService_CollectUserEvent_Handler,
		},
		{
			MethodName: "PurgeUserEvents",
			Handler:    _UserEventService_PurgeUserEvents_Handler,
		},
		{
			MethodName: "ImportUserEvents",
			Handler:    _UserEventService_ImportUserEvents_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/user_event_service.proto",
}

UserEventService_ServiceDesc is the grpc.ServiceDesc for UserEventService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var UserLicenseService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1.UserLicenseService",
	HandlerType: (*UserLicenseServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListUserLicenses",
			Handler:    _UserLicenseService_ListUserLicenses_Handler,
		},
		{
			MethodName: "BatchUpdateUserLicenses",
			Handler:    _UserLicenseService_BatchUpdateUserLicenses_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1/user_license_service.proto",
}

UserLicenseService_ServiceDesc is the grpc.ServiceDesc for UserLicenseService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterAssistantServiceServer added in v1.19.0 

func RegisterAssistantServiceServer(s grpc.ServiceRegistrar, srv AssistantServiceServer)

func RegisterCmekConfigServiceServer added in v1.18.0 

func RegisterCmekConfigServiceServer(s grpc.ServiceRegistrar, srv CmekConfigServiceServer)

func RegisterCompletionServiceServer 

func RegisterCompletionServiceServer(s grpc.ServiceRegistrar, srv CompletionServiceServer)

func RegisterControlServiceServer added in v1.8.0 

func RegisterControlServiceServer(s grpc.ServiceRegistrar, srv ControlServiceServer)

func RegisterConversationalSearchServiceServer added in v1.2.0 

func RegisterConversationalSearchServiceServer(s grpc.ServiceRegistrar, srv ConversationalSearchServiceServer)

func RegisterDataStoreServiceServer added in v1.5.0 

func RegisterDataStoreServiceServer(s grpc.ServiceRegistrar, srv DataStoreServiceServer)

func RegisterDocumentServiceServer 

func RegisterDocumentServiceServer(s grpc.ServiceRegistrar, srv DocumentServiceServer)

func RegisterEngineServiceServer added in v1.5.0 

func RegisterEngineServiceServer(s grpc.ServiceRegistrar, srv EngineServiceServer)

func RegisterGroundedGenerationServiceServer added in v1.8.0 

func RegisterGroundedGenerationServiceServer(s grpc.ServiceRegistrar, srv GroundedGenerationServiceServer)

func RegisterIdentityMappingStoreServiceServer added in v1.18.0 

func RegisterIdentityMappingStoreServiceServer(s grpc.ServiceRegistrar, srv IdentityMappingStoreServiceServer)

func RegisterProjectServiceServer added in v1.8.0 

func RegisterProjectServiceServer(s grpc.ServiceRegistrar, srv ProjectServiceServer)

func RegisterRankServiceServer added in v1.8.0 

func RegisterRankServiceServer(s grpc.ServiceRegistrar, srv RankServiceServer)

func RegisterRecommendationServiceServer added in v1.7.0 

func RegisterRecommendationServiceServer(s grpc.ServiceRegistrar, srv RecommendationServiceServer)

func RegisterSchemaServiceServer 

func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)

func RegisterSearchServiceServer 

func RegisterSearchServiceServer(s grpc.ServiceRegistrar, srv SearchServiceServer)

func RegisterSearchTuningServiceServer added in v1.14.0 

func RegisterSearchTuningServiceServer(s grpc.ServiceRegistrar, srv SearchTuningServiceServer)

func RegisterServingConfigServiceServer added in v1.17.0 

func RegisterServingConfigServiceServer(s grpc.ServiceRegistrar, srv ServingConfigServiceServer)

func RegisterSessionServiceServer added in v1.19.0 

func RegisterSessionServiceServer(s grpc.ServiceRegistrar, srv SessionServiceServer)

func RegisterSiteSearchEngineServiceServer added in v1.5.0 

func RegisterSiteSearchEngineServiceServer(s grpc.ServiceRegistrar, srv SiteSearchEngineServiceServer)

func RegisterUserEventServiceServer 

func RegisterUserEventServiceServer(s grpc.ServiceRegistrar, srv UserEventServiceServer)

func RegisterUserLicenseServiceServer added in v1.18.0 

func RegisterUserLicenseServiceServer(s grpc.ServiceRegistrar, srv UserLicenseServiceServer)

Types

type AdvancedSiteSearchConfig added in v1.17.0 

type AdvancedSiteSearchConfig struct {

	// If set true, initial indexing is disabled for the DataStore.
	DisableInitialIndex *bool `` /* 127-byte string literal not displayed */
	// If set true, automatic refresh is disabled for the DataStore.
	DisableAutomaticRefresh *bool `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration data for advance site search.

func (*AdvancedSiteSearchConfig) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use AdvancedSiteSearchConfig.ProtoReflect.Descriptor instead.

func (*AdvancedSiteSearchConfig) GetDisableAutomaticRefresh added in v1.17.0 

func (x *AdvancedSiteSearchConfig) GetDisableAutomaticRefresh() bool

func (*AdvancedSiteSearchConfig) GetDisableInitialIndex added in v1.17.0 

func (x *AdvancedSiteSearchConfig) GetDisableInitialIndex() bool

func (*AdvancedSiteSearchConfig) ProtoMessage added in v1.17.0 

func (*AdvancedSiteSearchConfig) ProtoMessage()

func (*AdvancedSiteSearchConfig) ProtoReflect added in v1.17.0 

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

func (*AdvancedSiteSearchConfig) Reset added in v1.17.0 

func (x *AdvancedSiteSearchConfig) Reset()

func (*AdvancedSiteSearchConfig) String added in v1.17.0 

func (x *AdvancedSiteSearchConfig) String() string

type AlloyDbSource added in v1.9.0 

type AlloyDbSource struct {

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

AlloyDB source import data from.

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

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

Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.

func (*AlloyDbSource) GetClusterId added in v1.9.0 

func (x *AlloyDbSource) GetClusterId() string

func (*AlloyDbSource) GetDatabaseId added in v1.9.0 

func (x *AlloyDbSource) GetDatabaseId() string

func (*AlloyDbSource) GetGcsStagingDir added in v1.9.0 

func (x *AlloyDbSource) GetGcsStagingDir() string

func (*AlloyDbSource) GetLocationId added in v1.9.0 

func (x *AlloyDbSource) GetLocationId() string

func (*AlloyDbSource) GetProjectId added in v1.9.0 

func (x *AlloyDbSource) GetProjectId() string

func (*AlloyDbSource) GetTableId added in v1.9.0 

func (x *AlloyDbSource) GetTableId() string

func (*AlloyDbSource) ProtoMessage added in v1.9.0 

func (*AlloyDbSource) ProtoMessage()

func (*AlloyDbSource) ProtoReflect added in v1.9.0 

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

func (*AlloyDbSource) Reset added in v1.9.0 

func (x *AlloyDbSource) Reset()

func (*AlloyDbSource) String added in v1.9.0 

func (x *AlloyDbSource) String() string

type Answer added in v1.8.0 

type Answer struct {

	// Immutable. Fully qualified name
	// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The state of the answer generation.
	State Answer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.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 `` /* 130-byte string literal not displayed */
	// Additional answer-skipped reasons. This provides the reason for ignored
	// cases. If nothing is skipped, this field is not set.
	AnswerSkippedReasons []Answer_AnswerSkippedReason `` /* 196-byte string literal not displayed */
	// Output only. Answer creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Answer completed timestamp.
	CompleteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
	// 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 deprecated added in v1.8.0 

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

Deprecated: Use Answer.ProtoReflect.Descriptor instead.

func (*Answer) GetAnswerSkippedReasons added in v1.8.0 

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

func (*Answer) GetAnswerText added in v1.8.0 

func (x *Answer) GetAnswerText() string

func (*Answer) GetCitations added in v1.8.0 

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

func (*Answer) GetCompleteTime added in v1.8.0 

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

func (*Answer) GetCreateTime added in v1.8.0 

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

func (*Answer) GetGroundingScore added in v1.17.0 

func (x *Answer) GetGroundingScore() float64

func (*Answer) GetGroundingSupports added in v1.17.0 

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

func (*Answer) GetName added in v1.8.0 

func (x *Answer) GetName() string

func (*Answer) GetQueryUnderstandingInfo added in v1.8.0 

func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfo

func (*Answer) GetReferences added in v1.8.0 

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

func (*Answer) GetRelatedQuestions added in v1.8.0 

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

func (*Answer) GetSafetyRatings added in v1.17.0 

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

func (*Answer) GetState added in v1.8.0 

func (x *Answer) GetState() Answer_State

func (*Answer) GetSteps added in v1.8.0 

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

func (*Answer) ProtoMessage added in v1.8.0 

func (*Answer) ProtoMessage()

func (*Answer) ProtoReflect added in v1.8.0 

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

func (*Answer) Reset added in v1.8.0 

func (x *Answer) Reset()

func (*Answer) String added in v1.8.0 

func (x *Answer) String() string

type AnswerQueryRequest added in v1.8.0 

type AnswerQueryRequest struct {

	// Required. The resource name of the Search serving config, such as
	// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
	// or
	// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
	// This field is used to identify the serving configuration name, set
	// of models used to make the search.
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. Current user query.
	Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The session resource name. Not required.
	//
	// When session field is not set, the API is in sessionless mode.
	//
	// We support auto session mode: users can use the wildcard symbol `-` as
	// session ID.  A new ID will be automatically generated and assigned.
	Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
	// Model specification.
	SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
	// Related questions specification.
	RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
	// 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 `` /* 129-byte string literal not displayed */
	// 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 `` /* 180-byte string literal not displayed */
	// 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 deprecated added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest) GetAnswerGenerationSpec added in v1.8.0 

func (x *AnswerQueryRequest) GetAnswerGenerationSpec() *AnswerQueryRequest_AnswerGenerationSpec

func (*AnswerQueryRequest) GetAsynchronousMode deprecated added in v1.8.0 

func (x *AnswerQueryRequest) GetAsynchronousMode() bool

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

func (*AnswerQueryRequest) GetEndUserSpec added in v1.17.0 

func (x *AnswerQueryRequest) GetEndUserSpec() *AnswerQueryRequest_EndUserSpec

func (*AnswerQueryRequest) GetGroundingSpec added in v1.17.0 

func (x *AnswerQueryRequest) GetGroundingSpec() *AnswerQueryRequest_GroundingSpec

func (*AnswerQueryRequest) GetQuery added in v1.8.0 

func (x *AnswerQueryRequest) GetQuery() *Query

func (*AnswerQueryRequest) GetQueryUnderstandingSpec added in v1.8.0 

func (x *AnswerQueryRequest) GetQueryUnderstandingSpec() *AnswerQueryRequest_QueryUnderstandingSpec

func (*AnswerQueryRequest) GetRelatedQuestionsSpec added in v1.8.0 

func (x *AnswerQueryRequest) GetRelatedQuestionsSpec() *AnswerQueryRequest_RelatedQuestionsSpec

func (*AnswerQueryRequest) GetSafetySpec added in v1.8.0 

func (x *AnswerQueryRequest) GetSafetySpec() *AnswerQueryRequest_SafetySpec

func (*AnswerQueryRequest) GetSearchSpec added in v1.8.0 

func (x *AnswerQueryRequest) GetSearchSpec() *AnswerQueryRequest_SearchSpec

func (*AnswerQueryRequest) GetServingConfig added in v1.8.0 

func (x *AnswerQueryRequest) GetServingConfig() string

func (*AnswerQueryRequest) GetSession added in v1.8.0 

func (x *AnswerQueryRequest) GetSession() string

func (*AnswerQueryRequest) GetUserLabels added in v1.9.0 

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

func (*AnswerQueryRequest) GetUserPseudoId added in v1.8.0 

func (x *AnswerQueryRequest) GetUserPseudoId() string

func (*AnswerQueryRequest) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest) ProtoMessage()

func (*AnswerQueryRequest) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest) Reset added in v1.8.0 

func (x *AnswerQueryRequest) Reset()

func (*AnswerQueryRequest) String added in v1.8.0 

func (x *AnswerQueryRequest) String() string

type AnswerQueryRequest_AnswerGenerationSpec added in v1.8.0 

type AnswerQueryRequest_AnswerGenerationSpec struct {

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

Answer generation specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode() string

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreJailBreakingQuery added in v1.15.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreJailBreakingQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec() *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec() *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec added in v1.8.0 

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec struct {

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

Answer Generation Model specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion() string

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec added in v1.8.0 

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec struct {

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

Answer generation prompt specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble() string

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String() string

type AnswerQueryRequest_EndUserSpec added in v1.17.0 

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

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

Deprecated: Use AnswerQueryRequest_EndUserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec) GetEndUserMetadata added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec) GetEndUserMetadata() []*AnswerQueryRequest_EndUserSpec_EndUserMetaData

func (*AnswerQueryRequest_EndUserSpec) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_EndUserSpec) ProtoMessage()

func (*AnswerQueryRequest_EndUserSpec) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_EndUserSpec) Reset added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec) Reset()

func (*AnswerQueryRequest_EndUserSpec) String added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec) String() string

type AnswerQueryRequest_EndUserSpec_EndUserMetaData added in v1.17.0 

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

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

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetChunkInfo added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetChunkInfo() *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent added in v1.17.0 

func (m *AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent() isAnswerQueryRequest_EndUserSpec_EndUserMetaData_Content

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoMessage()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Reset added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) Reset()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) String added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) String() string

type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo added in v1.17.0 

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

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

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetContent added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetContent() string

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetDocumentMetadata added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetDocumentMetadata() *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoMessage()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Reset added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Reset()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) String added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) String() string

type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_ added in v1.17.0 

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

type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata added in v1.17.0 

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

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

Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) GetTitle added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) GetTitle() string

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoMessage()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Reset added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Reset()

func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) String added in v1.17.0 

func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) String() string

type AnswerQueryRequest_GroundingSpec added in v1.17.0 

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 `` /* 136-byte string literal not displayed */
	// Optional. Specifies whether to enable the filtering based on grounding
	// score and at what level.
	FilteringLevel AnswerQueryRequest_GroundingSpec_FilteringLevel `` /* 189-byte string literal not displayed */
	// contains filtered or unexported fields
}

Grounding specification.

func (*AnswerQueryRequest_GroundingSpec) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_GroundingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_GroundingSpec) GetFilteringLevel added in v1.17.0 

func (x *AnswerQueryRequest_GroundingSpec) GetFilteringLevel() AnswerQueryRequest_GroundingSpec_FilteringLevel

func (*AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports added in v1.17.0 

func (x *AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports() bool

func (*AnswerQueryRequest_GroundingSpec) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_GroundingSpec) ProtoMessage()

func (*AnswerQueryRequest_GroundingSpec) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_GroundingSpec) Reset added in v1.17.0 

func (x *AnswerQueryRequest_GroundingSpec) Reset()

func (*AnswerQueryRequest_GroundingSpec) String added in v1.17.0 

func (x *AnswerQueryRequest_GroundingSpec) String() string

type AnswerQueryRequest_GroundingSpec_FilteringLevel added in v1.17.0 

type AnswerQueryRequest_GroundingSpec_FilteringLevel int32

Level to filter based on answer grounding. 

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

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Enum added in v1.17.0 

func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) Enum() *AnswerQueryRequest_GroundingSpec_FilteringLevel

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_GroundingSpec_FilteringLevel.Descriptor instead.

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Number added in v1.17.0 

func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) String added in v1.17.0 

func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) String() string

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Type added in v1.17.0 

func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Type() protoreflect.EnumType

type AnswerQueryRequest_QueryUnderstandingSpec added in v1.8.0 

type AnswerQueryRequest_QueryUnderstandingSpec struct {

	// Query classification specification.
	QueryClassificationSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec `` /* 132-byte string literal not displayed */
	// Query rephraser specification.
	QueryRephraserSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec `protobuf:"bytes,2,opt,name=query_rephraser_spec,json=queryRephraserSpec,proto3" json:"query_rephraser_spec,omitempty"`
	// Optional. Whether to disable spell correction.
	// The default value is `false`.
	DisableSpellCorrection bool `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Query understanding specification.

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

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection added in v1.17.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection() bool

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec added in v1.8.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {

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

Query classification specification.

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

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes added in v1.8.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type added in v1.8.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type int32

Query classification types. 

const (
	// Unspecified query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 0
	// Adversarial query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 1
	// Non-answer-seeking query classification type, 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
	// User defined query classification type.
	AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_USER_DEFINED_CLASSIFICATION_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 5
)

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor added in v1.8.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum added in v1.8.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number added in v1.8.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String added in v1.8.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String() string

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type added in v1.8.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type() protoreflect.EnumType

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec added in v1.8.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec struct {

	// Disable query rephraser.
	Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
	// Max rephrase steps.
	// The max number is 5 steps.
	// If not set or set to < 1, it will be set to 1 by default.
	MaxRephraseSteps int32 `protobuf:"varint,2,opt,name=max_rephrase_steps,json=maxRephraseSteps,proto3" json:"max_rephrase_steps,omitempty"`
	// 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 added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable() bool

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps added in v1.9.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps() int32

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetModelSpec added in v1.17.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetModelSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec added in v1.17.0 

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 `` /* 207-byte string literal not displayed */
	// contains filtered or unexported fields
}

Query Rephraser Model specification.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) GetModelType added in v1.17.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) GetModelType() AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Reset added in v1.17.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) String added in v1.17.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType added in v1.17.0 

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. 

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

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Enum added in v1.17.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Number added in v1.17.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) String added in v1.17.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) String() string

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Type added in v1.17.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Type() protoreflect.EnumType

type AnswerQueryRequest_RelatedQuestionsSpec added in v1.8.0 

type AnswerQueryRequest_RelatedQuestionsSpec struct {

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

Related questions specification.

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

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

Deprecated: Use AnswerQueryRequest_RelatedQuestionsSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_RelatedQuestionsSpec) GetEnable added in v1.8.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) GetEnable() bool

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage()

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_RelatedQuestionsSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) Reset()

func (*AnswerQueryRequest_RelatedQuestionsSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) String() string

type AnswerQueryRequest_SafetySpec added in v1.8.0 

type AnswerQueryRequest_SafetySpec struct {

	// Enable the safety filtering on the answer response. It is false by
	// default.
	Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
	// 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 deprecated added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SafetySpec) GetEnable added in v1.8.0 

func (x *AnswerQueryRequest_SafetySpec) GetEnable() bool

func (*AnswerQueryRequest_SafetySpec) GetSafetySettings added in v1.17.0 

func (x *AnswerQueryRequest_SafetySpec) GetSafetySettings() []*AnswerQueryRequest_SafetySpec_SafetySetting

func (*AnswerQueryRequest_SafetySpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SafetySpec) ProtoMessage()

func (*AnswerQueryRequest_SafetySpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SafetySpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SafetySpec) Reset()

func (*AnswerQueryRequest_SafetySpec) String added in v1.8.0 

func (x *AnswerQueryRequest_SafetySpec) String() string

type AnswerQueryRequest_SafetySpec_SafetySetting added in v1.17.0 

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 `` /* 172-byte string literal not displayed */
	// contains filtered or unexported fields
}

Safety settings.

func (*AnswerQueryRequest_SafetySpec_SafetySetting) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SafetySpec_SafetySetting) GetCategory added in v1.17.0 

func (x *AnswerQueryRequest_SafetySpec_SafetySetting) GetCategory() HarmCategory

func (*AnswerQueryRequest_SafetySpec_SafetySetting) GetThreshold added in v1.17.0 

func (x *AnswerQueryRequest_SafetySpec_SafetySetting) GetThreshold() AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold

func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoMessage added in v1.17.0 

func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoMessage()

func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoReflect added in v1.17.0 

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

func (*AnswerQueryRequest_SafetySpec_SafetySetting) Reset added in v1.17.0 

func (x *AnswerQueryRequest_SafetySpec_SafetySetting) Reset()

func (*AnswerQueryRequest_SafetySpec_SafetySetting) String added in v1.17.0 

func (x *AnswerQueryRequest_SafetySpec_SafetySetting) String() string

type AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold added in v1.17.0 

type AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold int32

Probability based thresholds levels for blocking. 

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

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Enum added in v1.17.0 

func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Enum() *AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold.Descriptor instead.

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Number added in v1.17.0 

func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) String added in v1.17.0 

func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) String() string

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Type added in v1.17.0 

func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Type() protoreflect.EnumType

type AnswerQueryRequest_SearchSpec added in v1.8.0 

type AnswerQueryRequest_SearchSpec struct {

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

Search specification.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec) GetInput added in v1.8.0 

func (m *AnswerQueryRequest_SearchSpec) GetInput() isAnswerQueryRequest_SearchSpec_Input

func (*AnswerQueryRequest_SearchSpec) GetSearchParams added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchParams() *AnswerQueryRequest_SearchSpec_SearchParams

func (*AnswerQueryRequest_SearchSpec) GetSearchResultList added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchResultList() *AnswerQueryRequest_SearchSpec_SearchResultList

func (*AnswerQueryRequest_SearchSpec) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec) Reset()

func (*AnswerQueryRequest_SearchSpec) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec) String() string

type AnswerQueryRequest_SearchSpec_SearchParams added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchParams struct {

	// Number of search results to return.
	// The default value is 10.
	MaxReturnResults int32 `protobuf:"varint,1,opt,name=max_return_results,json=maxReturnResults,proto3" json:"max_return_results,omitempty"`
	// The filter syntax consists of an expression language for constructing
	// a predicate from one or more fields of the documents being filtered.
	// Filter expression is case-sensitive. This will be used to filter
	// search results which may affect the Answer response.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key
	// to a key property defined in the Vertex AI Search backend -- this
	// mapping is defined by the customer in their schema. For example a
	// media customers might have a field 'name' in their schema. In this
	// case the filter would look like this: filter --> name:'ANY("king
	// kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Boost specification to boost certain documents in search results which
	// may affect the answer query response. For more information on boosting,
	// see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,3,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// The order in which documents are returned. Documents can be ordered
	// by a field in an [Document][google.cloud.discoveryengine.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 `` /* 198-byte string literal not displayed */
	// Specs defining dataStores to filter on in a search call and
	// configurations for those dataStores. This is only considered for
	// engines with multiple dataStores use case. For single dataStore within
	// an engine, they should use the specs at the top level.
	DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,7,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
	// contains filtered or unexported fields
}

Search parameters.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec() *SearchRequest_BoostSpec

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetFilter() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode added in v1.9.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultMode

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchParams) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) String() string

type AnswerQueryRequest_SearchSpec_SearchParams_ added in v1.8.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList struct {

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

Search result list.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_ added in v1.8.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult struct {

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

Search result.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent added in v1.8.0 

func (m *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent() isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo struct {

	// Chunk resource name.
	Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Chunk textual content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// 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 added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetDocumentMetadata added in v1.15.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetDocumentMetadata() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_ added in v1.8.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata added in v1.15.0 

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetTitle added in v1.15.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetTitle() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetUri added in v1.15.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetUri() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoMessage added in v1.15.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoReflect added in v1.15.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Reset added in v1.15.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) String added in v1.15.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// URI for the document.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// List of document contexts. 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 added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers deprecated added in v1.8.0 

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

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ added in v1.8.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext struct {

	// Page identifier.
	PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
	// Document content 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 added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer struct {

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

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

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment added in v1.8.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment struct {

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

Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) 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 added in v1.8.0 

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage added in v1.8.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String added in v1.8.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String() string

type AnswerQueryResponse added in v1.8.0 

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

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

Deprecated: Use AnswerQueryResponse.ProtoReflect.Descriptor instead.

func (*AnswerQueryResponse) GetAnswer added in v1.8.0 

func (x *AnswerQueryResponse) GetAnswer() *Answer

func (*AnswerQueryResponse) GetAnswerQueryToken added in v1.8.0 

func (x *AnswerQueryResponse) GetAnswerQueryToken() string

func (*AnswerQueryResponse) GetSession added in v1.8.0 

func (x *AnswerQueryResponse) GetSession() *Session

func (*AnswerQueryResponse) ProtoMessage added in v1.8.0 

func (*AnswerQueryResponse) ProtoMessage()

func (*AnswerQueryResponse) ProtoReflect added in v1.8.0 

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

func (*AnswerQueryResponse) Reset added in v1.8.0 

func (x *AnswerQueryResponse) Reset()

func (*AnswerQueryResponse) String added in v1.8.0 

func (x *AnswerQueryResponse) String() string

type Answer_AnswerSkippedReason added in v1.8.0 

type Answer_AnswerSkippedReason int32

An enum for answer skipped reasons. 

const (
	// Default value. The answer skipped reason is not specified.
	Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED Answer_AnswerSkippedReason = 0
	// The adversarial query ignored case.
	Answer_ADVERSARIAL_QUERY_IGNORED Answer_AnswerSkippedReason = 1
	// The non-answer seeking query ignored case
	//
	// 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
	// The user defined query classification ignored case.
	//
	// Google skips the answer if the query is classified as a user defined
	// query classification.
	Answer_USER_DEFINED_CLASSIFICATION_QUERY_IGNORED Answer_AnswerSkippedReason = 10
	// The unhelpful answer case.
	//
	// Google skips the answer if the answer is not helpful. This can be due to
	// a variety of factors, including but not limited to: the query is not
	// answerable, the answer is not relevant to the query, or the answer is
	// not well-formatted.
	Answer_UNHELPFUL_ANSWER Answer_AnswerSkippedReason = 11
)

func (Answer_AnswerSkippedReason) Descriptor added in v1.8.0 

func (Answer_AnswerSkippedReason) Descriptor() protoreflect.EnumDescriptor

func (Answer_AnswerSkippedReason) Enum added in v1.8.0 

func (x Answer_AnswerSkippedReason) Enum() *Answer_AnswerSkippedReason

func (Answer_AnswerSkippedReason) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.

func (Answer_AnswerSkippedReason) Number added in v1.8.0 

func (x Answer_AnswerSkippedReason) Number() protoreflect.EnumNumber

func (Answer_AnswerSkippedReason) String added in v1.8.0 

func (x Answer_AnswerSkippedReason) String() string

func (Answer_AnswerSkippedReason) Type added in v1.8.0 

func (Answer_AnswerSkippedReason) Type() protoreflect.EnumType

type Answer_Citation added in v1.8.0 

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

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

Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.

func (*Answer_Citation) GetEndIndex added in v1.8.0 

func (x *Answer_Citation) GetEndIndex() int64

func (*Answer_Citation) GetSources added in v1.8.0 

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

func (*Answer_Citation) GetStartIndex added in v1.8.0 

func (x *Answer_Citation) GetStartIndex() int64

func (*Answer_Citation) ProtoMessage added in v1.8.0 

func (*Answer_Citation) ProtoMessage()

func (*Answer_Citation) ProtoReflect added in v1.8.0 

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

func (*Answer_Citation) Reset added in v1.8.0 

func (x *Answer_Citation) Reset()

func (*Answer_Citation) String added in v1.8.0 

func (x *Answer_Citation) String() string

type Answer_CitationSource added in v1.8.0 

type Answer_CitationSource struct {

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

Citation source.

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

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

Deprecated: Use Answer_CitationSource.ProtoReflect.Descriptor instead.

func (*Answer_CitationSource) GetReferenceId added in v1.8.0 

func (x *Answer_CitationSource) GetReferenceId() string

func (*Answer_CitationSource) ProtoMessage added in v1.8.0 

func (*Answer_CitationSource) ProtoMessage()

func (*Answer_CitationSource) ProtoReflect added in v1.8.0 

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

func (*Answer_CitationSource) Reset added in v1.8.0 

func (x *Answer_CitationSource) Reset()

func (*Answer_CitationSource) String added in v1.8.0 

func (x *Answer_CitationSource) String() string

type Answer_GroundingSupport added in v1.17.0 

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 `` /* 136-byte string literal not displayed */
	// 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 deprecated added in v1.17.0 

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

Deprecated: Use Answer_GroundingSupport.ProtoReflect.Descriptor instead.

func (*Answer_GroundingSupport) GetEndIndex added in v1.17.0 

func (x *Answer_GroundingSupport) GetEndIndex() int64

func (*Answer_GroundingSupport) GetGroundingCheckRequired added in v1.17.0 

func (x *Answer_GroundingSupport) GetGroundingCheckRequired() bool

func (*Answer_GroundingSupport) GetGroundingScore added in v1.17.0 

func (x *Answer_GroundingSupport) GetGroundingScore() float64

func (*Answer_GroundingSupport) GetSources added in v1.17.0 

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

func (*Answer_GroundingSupport) GetStartIndex added in v1.17.0 

func (x *Answer_GroundingSupport) GetStartIndex() int64

func (*Answer_GroundingSupport) ProtoMessage added in v1.17.0 

func (*Answer_GroundingSupport) ProtoMessage()

func (*Answer_GroundingSupport) ProtoReflect added in v1.17.0 

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

func (*Answer_GroundingSupport) Reset added in v1.17.0 

func (x *Answer_GroundingSupport) Reset()

func (*Answer_GroundingSupport) String added in v1.17.0 

func (x *Answer_GroundingSupport) String() string

type Answer_QueryUnderstandingInfo added in v1.8.0 

type Answer_QueryUnderstandingInfo struct {

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

Query understanding information.

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

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

Deprecated: Use Answer_QueryUnderstandingInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo) GetQueryClassificationInfo added in v1.8.0 

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

func (*Answer_QueryUnderstandingInfo) ProtoMessage added in v1.8.0 

func (*Answer_QueryUnderstandingInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_QueryUnderstandingInfo) Reset added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo) Reset()

func (*Answer_QueryUnderstandingInfo) String added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo added in v1.8.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {

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

Query classification information.

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

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive() bool

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType() Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage added in v1.8.0 

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) String added in v1.8.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type added in v1.8.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type int32

Query classification types. 

const (
	// Unspecified query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 0
	// Adversarial query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 1
	// Non-answer-seeking query classification type, 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
	// User defined query classification type.
	Answer_QueryUnderstandingInfo_QueryClassificationInfo_USER_DEFINED_CLASSIFICATION_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 5
)

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor added in v1.8.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor() protoreflect.EnumDescriptor

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum added in v1.8.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum() *Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number added in v1.8.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number() protoreflect.EnumNumber

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String added in v1.8.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String() string

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type added in v1.8.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type() protoreflect.EnumType

type Answer_Reference added in v1.8.0 

type Answer_Reference struct {

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

Reference.

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

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

Deprecated: Use Answer_Reference.ProtoReflect.Descriptor instead.

func (*Answer_Reference) GetChunkInfo added in v1.8.0 

func (x *Answer_Reference) GetChunkInfo() *Answer_Reference_ChunkInfo

func (*Answer_Reference) GetContent added in v1.8.0 

func (m *Answer_Reference) GetContent() isAnswer_Reference_Content

func (*Answer_Reference) GetStructuredDocumentInfo added in v1.14.0 

func (x *Answer_Reference) GetStructuredDocumentInfo() *Answer_Reference_StructuredDocumentInfo

func (*Answer_Reference) GetUnstructuredDocumentInfo added in v1.8.0 

func (x *Answer_Reference) GetUnstructuredDocumentInfo() *Answer_Reference_UnstructuredDocumentInfo

func (*Answer_Reference) ProtoMessage added in v1.8.0 

func (*Answer_Reference) ProtoMessage()

func (*Answer_Reference) ProtoReflect added in v1.8.0 

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

func (*Answer_Reference) Reset added in v1.8.0 

func (x *Answer_Reference) Reset()

func (*Answer_Reference) String added in v1.8.0 

func (x *Answer_Reference) String() string

type Answer_Reference_ChunkInfo added in v1.8.0 

type Answer_Reference_ChunkInfo struct {

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

Chunk information.

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

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

Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo) GetChunk added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) GetChunk() string

func (*Answer_Reference_ChunkInfo) GetContent added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) GetContent() string

func (*Answer_Reference_ChunkInfo) GetDocumentMetadata added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) GetDocumentMetadata() *Answer_Reference_ChunkInfo_DocumentMetadata

func (*Answer_Reference_ChunkInfo) GetRelevanceScore added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Reference_ChunkInfo) ProtoMessage added in v1.8.0 

func (*Answer_Reference_ChunkInfo) ProtoMessage()

func (*Answer_Reference_ChunkInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_Reference_ChunkInfo) Reset added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) Reset()

func (*Answer_Reference_ChunkInfo) String added in v1.8.0 

func (x *Answer_Reference_ChunkInfo) String() string

type Answer_Reference_ChunkInfo_ added in v1.8.0 

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

type Answer_Reference_ChunkInfo_DocumentMetadata added in v1.8.0 

type Answer_Reference_ChunkInfo_DocumentMetadata struct {

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

Document metadata.

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

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

Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData added in v1.8.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetUri() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage added in v1.8.0 

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect added in v1.8.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) Reset()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) String added in v1.8.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) String() string

type Answer_Reference_StructuredDocumentInfo added in v1.14.0 

type Answer_Reference_StructuredDocumentInfo struct {

	// Document resource name.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Structured search data.
	StructData *structpb.Struct `protobuf:"bytes,2,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
	// 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 deprecated added in v1.14.0 

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

Deprecated: Use Answer_Reference_StructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_StructuredDocumentInfo) GetDocument added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_StructuredDocumentInfo) GetStructData added in v1.14.0 

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

func (*Answer_Reference_StructuredDocumentInfo) GetTitle added in v1.17.0 

func (x *Answer_Reference_StructuredDocumentInfo) GetTitle() string

func (*Answer_Reference_StructuredDocumentInfo) GetUri added in v1.17.0 

func (x *Answer_Reference_StructuredDocumentInfo) GetUri() string

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage added in v1.14.0 

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_StructuredDocumentInfo) ProtoReflect added in v1.14.0 

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

func (*Answer_Reference_StructuredDocumentInfo) Reset added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) Reset()

func (*Answer_Reference_StructuredDocumentInfo) String added in v1.14.0 

func (x *Answer_Reference_StructuredDocumentInfo) String() string

type Answer_Reference_StructuredDocumentInfo_ added in v1.14.0 

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

type Answer_Reference_UnstructuredDocumentInfo added in v1.8.0 

type Answer_Reference_UnstructuredDocumentInfo struct {

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

Unstructured document information.

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

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) GetDocument added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetStructData added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) GetTitle added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetTitle() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetUri added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetUri() string

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage added in v1.8.0 

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) Reset added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo) String added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) String() string

type Answer_Reference_UnstructuredDocumentInfo_ added in v1.8.0 

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

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent added in v1.8.0 

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent struct {

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

Chunk content.

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

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore added in v1.14.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore() float32

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage added in v1.8.0 

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String added in v1.8.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String() string

type Answer_State added in v1.8.0 

type Answer_State int32

Enumeration of the state of the answer generation. 

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

func (Answer_State) Descriptor added in v1.8.0 

func (Answer_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_State) Enum added in v1.8.0 

func (x Answer_State) Enum() *Answer_State

func (Answer_State) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use Answer_State.Descriptor instead.

func (Answer_State) Number added in v1.8.0 

func (x Answer_State) Number() protoreflect.EnumNumber

func (Answer_State) String added in v1.8.0 

func (x Answer_State) String() string

func (Answer_State) Type added in v1.8.0 

func (Answer_State) Type() protoreflect.EnumType

type Answer_Step added in v1.8.0 

type Answer_Step struct {

	// The state of the step.
	State Answer_Step_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.discoveryengine.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 deprecated added in v1.8.0 

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

Deprecated: Use Answer_Step.ProtoReflect.Descriptor instead.

func (*Answer_Step) GetActions added in v1.8.0 

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

func (*Answer_Step) GetDescription added in v1.8.0 

func (x *Answer_Step) GetDescription() string

func (*Answer_Step) GetState added in v1.8.0 

func (x *Answer_Step) GetState() Answer_Step_State

func (*Answer_Step) GetThought added in v1.8.0 

func (x *Answer_Step) GetThought() string

func (*Answer_Step) ProtoMessage added in v1.8.0 

func (*Answer_Step) ProtoMessage()

func (*Answer_Step) ProtoReflect added in v1.8.0 

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

func (*Answer_Step) Reset added in v1.8.0 

func (x *Answer_Step) Reset()

func (*Answer_Step) String added in v1.8.0 

func (x *Answer_Step) String() string

type Answer_Step_Action added in v1.8.0 

type Answer_Step_Action struct {

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

Action.

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

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

Deprecated: Use Answer_Step_Action.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action) GetAction added in v1.8.0 

func (m *Answer_Step_Action) GetAction() isAnswer_Step_Action_Action

func (*Answer_Step_Action) GetObservation added in v1.8.0 

func (x *Answer_Step_Action) GetObservation() *Answer_Step_Action_Observation

func (*Answer_Step_Action) GetSearchAction added in v1.8.0 

func (x *Answer_Step_Action) GetSearchAction() *Answer_Step_Action_SearchAction

func (*Answer_Step_Action) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action) ProtoMessage()

func (*Answer_Step_Action) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action) Reset added in v1.8.0 

func (x *Answer_Step_Action) Reset()

func (*Answer_Step_Action) String added in v1.8.0 

func (x *Answer_Step_Action) String() string

type Answer_Step_Action_Observation added in v1.8.0 

type Answer_Step_Action_Observation struct {

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

Observation.

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

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

Deprecated: Use Answer_Step_Action_Observation.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation) GetSearchResults added in v1.8.0 

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

func (*Answer_Step_Action_Observation) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action_Observation) ProtoMessage()

func (*Answer_Step_Action_Observation) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action_Observation) Reset added in v1.8.0 

func (x *Answer_Step_Action_Observation) Reset()

func (*Answer_Step_Action_Observation) String added in v1.8.0 

func (x *Answer_Step_Action_Observation) String() string

type Answer_Step_Action_Observation_SearchResult added in v1.8.0 

type Answer_Step_Action_Observation_SearchResult struct {

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

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult) GetChunkInfo added in v1.8.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetDocument added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetDocument() string

func (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo added in v1.8.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetStructData added in v1.9.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetTitle added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetTitle() string

func (*Answer_Step_Action_Observation_SearchResult) GetUri added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetUri() string

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action_Observation_SearchResult) Reset added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult) Reset()

func (*Answer_Step_Action_Observation_SearchResult) String added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult) String() string

type Answer_Step_Action_Observation_SearchResult_ChunkInfo added in v1.8.0 

type Answer_Step_Action_Observation_SearchResult_ChunkInfo struct {

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

Chunk information.

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) String added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) String() string

type Answer_Step_Action_Observation_SearchResult_SnippetInfo added in v1.8.0 

type Answer_Step_Action_Observation_SearchResult_SnippetInfo struct {

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

Snippet information.

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_SnippetInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) String added in v1.8.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) String() string

type Answer_Step_Action_SearchAction added in v1.8.0 

type Answer_Step_Action_SearchAction struct {

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

Search action.

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

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

Deprecated: Use Answer_Step_Action_SearchAction.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_SearchAction) GetQuery added in v1.8.0 

func (x *Answer_Step_Action_SearchAction) GetQuery() string

func (*Answer_Step_Action_SearchAction) ProtoMessage added in v1.8.0 

func (*Answer_Step_Action_SearchAction) ProtoMessage()

func (*Answer_Step_Action_SearchAction) ProtoReflect added in v1.8.0 

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

func (*Answer_Step_Action_SearchAction) Reset added in v1.8.0 

func (x *Answer_Step_Action_SearchAction) Reset()

func (*Answer_Step_Action_SearchAction) String added in v1.8.0 

func (x *Answer_Step_Action_SearchAction) String() string

type Answer_Step_Action_SearchAction_ added in v1.8.0 

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

type Answer_Step_State added in v1.8.0 

type Answer_Step_State int32

Enumeration of the state of the step. 

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

func (Answer_Step_State) Descriptor added in v1.8.0 

func (Answer_Step_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_Step_State) Enum added in v1.8.0 

func (x Answer_Step_State) Enum() *Answer_Step_State

func (Answer_Step_State) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use Answer_Step_State.Descriptor instead.

func (Answer_Step_State) Number added in v1.8.0 

func (x Answer_Step_State) Number() protoreflect.EnumNumber

func (Answer_Step_State) String added in v1.8.0 

func (x Answer_Step_State) String() string

func (Answer_Step_State) Type added in v1.8.0 

func (Answer_Step_State) Type() protoreflect.EnumType

type AssistAnswer added in v1.19.0 

type AssistAnswer struct {

	// Immutable. Resource name of the `AssistAnswer`.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
	//
	// 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"`
	// State of the answer generation.
	State AssistAnswer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.AssistAnswer_State" json:"state,omitempty"`
	// Replies of the assistant.
	Replies []*AssistAnswer_Reply `protobuf:"bytes,3,rep,name=replies,proto3" json:"replies,omitempty"`
	// Reasons for not answering the assist call.
	AssistSkippedReasons []AssistAnswer_AssistSkippedReason `` /* 201-byte string literal not displayed */
	// contains filtered or unexported fields
}

AssistAnswer resource, main part of [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].

func (*AssistAnswer) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistAnswer.ProtoReflect.Descriptor instead.

func (*AssistAnswer) GetAssistSkippedReasons added in v1.19.0 

func (x *AssistAnswer) GetAssistSkippedReasons() []AssistAnswer_AssistSkippedReason

func (*AssistAnswer) GetName added in v1.19.0 

func (x *AssistAnswer) GetName() string

func (*AssistAnswer) GetReplies added in v1.19.0 

func (x *AssistAnswer) GetReplies() []*AssistAnswer_Reply

func (*AssistAnswer) GetState added in v1.19.0 

func (x *AssistAnswer) GetState() AssistAnswer_State

func (*AssistAnswer) ProtoMessage added in v1.19.0 

func (*AssistAnswer) ProtoMessage()

func (*AssistAnswer) ProtoReflect added in v1.19.0 

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

func (*AssistAnswer) Reset added in v1.19.0 

func (x *AssistAnswer) Reset()

func (*AssistAnswer) String added in v1.19.0 

func (x *AssistAnswer) String() string

type AssistAnswer_AssistSkippedReason added in v1.19.0 

type AssistAnswer_AssistSkippedReason int32

Possible reasons for not answering an assist call. 

const (
	// Default value. Skip reason is not specified.
	AssistAnswer_ASSIST_SKIPPED_REASON_UNSPECIFIED AssistAnswer_AssistSkippedReason = 0
	// The assistant ignored the query, because it did not appear to be
	// answer-seeking.
	AssistAnswer_NON_ASSIST_SEEKING_QUERY_IGNORED AssistAnswer_AssistSkippedReason = 1
	// The assistant ignored the query or refused to answer because of a
	// customer policy violation (e.g., the query or the answer contained a
	// banned phrase).
	AssistAnswer_CUSTOMER_POLICY_VIOLATION AssistAnswer_AssistSkippedReason = 2
)

func (AssistAnswer_AssistSkippedReason) Descriptor added in v1.19.0 

func (AssistAnswer_AssistSkippedReason) Descriptor() protoreflect.EnumDescriptor

func (AssistAnswer_AssistSkippedReason) Enum added in v1.19.0 

func (x AssistAnswer_AssistSkippedReason) Enum() *AssistAnswer_AssistSkippedReason

func (AssistAnswer_AssistSkippedReason) EnumDescriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistAnswer_AssistSkippedReason.Descriptor instead.

func (AssistAnswer_AssistSkippedReason) Number added in v1.19.0 

func (x AssistAnswer_AssistSkippedReason) Number() protoreflect.EnumNumber

func (AssistAnswer_AssistSkippedReason) String added in v1.19.0 

func (x AssistAnswer_AssistSkippedReason) String() string

func (AssistAnswer_AssistSkippedReason) Type added in v1.19.0 

func (AssistAnswer_AssistSkippedReason) Type() protoreflect.EnumType

type AssistAnswer_Reply added in v1.19.0 

type AssistAnswer_Reply struct {

	// Alternatives for the assistant reply.
	//
	// Types that are assignable to Reply:
	//
	//	*AssistAnswer_Reply_GroundedContent
	Reply isAssistAnswer_Reply_Reply `protobuf_oneof:"reply"`
	// contains filtered or unexported fields
}

One part of the multi-part response of the assist call.

func (*AssistAnswer_Reply) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistAnswer_Reply.ProtoReflect.Descriptor instead.

func (*AssistAnswer_Reply) GetGroundedContent added in v1.19.0 

func (x *AssistAnswer_Reply) GetGroundedContent() *AssistantGroundedContent

func (*AssistAnswer_Reply) GetReply added in v1.19.0 

func (m *AssistAnswer_Reply) GetReply() isAssistAnswer_Reply_Reply

func (*AssistAnswer_Reply) ProtoMessage added in v1.19.0 

func (*AssistAnswer_Reply) ProtoMessage()

func (*AssistAnswer_Reply) ProtoReflect added in v1.19.0 

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

func (*AssistAnswer_Reply) Reset added in v1.19.0 

func (x *AssistAnswer_Reply) Reset()

func (*AssistAnswer_Reply) String added in v1.19.0 

func (x *AssistAnswer_Reply) String() string

type AssistAnswer_Reply_GroundedContent added in v1.19.0 

type AssistAnswer_Reply_GroundedContent struct {
	// Possibly grounded response text or media from the assistant.
	GroundedContent *AssistantGroundedContent `protobuf:"bytes,1,opt,name=grounded_content,json=groundedContent,proto3,oneof"`
}

type AssistAnswer_State added in v1.19.0 

type AssistAnswer_State int32

State of the answer generation. 

const (
	// Unknown.
	AssistAnswer_STATE_UNSPECIFIED AssistAnswer_State = 0
	// Assist operation is currently in progress.
	AssistAnswer_IN_PROGRESS AssistAnswer_State = 1
	// Assist operation has failed.
	AssistAnswer_FAILED AssistAnswer_State = 2
	// Assist operation has succeeded.
	AssistAnswer_SUCCEEDED AssistAnswer_State = 3
	// Assist operation has been skipped.
	AssistAnswer_SKIPPED AssistAnswer_State = 4
)

func (AssistAnswer_State) Descriptor added in v1.19.0 

func (AssistAnswer_State) Descriptor() protoreflect.EnumDescriptor

func (AssistAnswer_State) Enum added in v1.19.0 

func (x AssistAnswer_State) Enum() *AssistAnswer_State

func (AssistAnswer_State) EnumDescriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistAnswer_State.Descriptor instead.

func (AssistAnswer_State) Number added in v1.19.0 

func (x AssistAnswer_State) Number() protoreflect.EnumNumber

func (AssistAnswer_State) String added in v1.19.0 

func (x AssistAnswer_State) String() string

func (AssistAnswer_State) Type added in v1.19.0 

func (AssistAnswer_State) Type() protoreflect.EnumType

type AssistUserMetadata added in v1.19.0 

type AssistUserMetadata struct {

	// Optional. IANA time zone, e.g. Europe/Budapest.
	TimeZone string `protobuf:"bytes,1,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// Optional. Preferred language to be used for answering if language detection
	// fails. Also used as the language of error messages created by actions,
	// regardless of language detection results.
	PreferredLanguageCode string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

User metadata of the request.

func (*AssistUserMetadata) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistUserMetadata.ProtoReflect.Descriptor instead.

func (*AssistUserMetadata) GetPreferredLanguageCode added in v1.19.0 

func (x *AssistUserMetadata) GetPreferredLanguageCode() string

func (*AssistUserMetadata) GetTimeZone added in v1.19.0 

func (x *AssistUserMetadata) GetTimeZone() string

func (*AssistUserMetadata) ProtoMessage added in v1.19.0 

func (*AssistUserMetadata) ProtoMessage()

func (*AssistUserMetadata) ProtoReflect added in v1.19.0 

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

func (*AssistUserMetadata) Reset added in v1.19.0 

func (x *AssistUserMetadata) Reset()

func (*AssistUserMetadata) String added in v1.19.0 

func (x *AssistUserMetadata) String() string

type Assistant added in v1.19.0 

type Assistant struct {

	// Immutable. Resource name of the assistant.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
	//
	// It 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
}

Discovery Engine Assistant resource.

func (*Assistant) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use Assistant.ProtoReflect.Descriptor instead.

func (*Assistant) GetName added in v1.19.0 

func (x *Assistant) GetName() string

func (*Assistant) ProtoMessage added in v1.19.0 

func (*Assistant) ProtoMessage()

func (*Assistant) ProtoReflect added in v1.19.0 

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

func (*Assistant) Reset added in v1.19.0 

func (x *Assistant) Reset()

func (*Assistant) String added in v1.19.0 

func (x *Assistant) String() string

type AssistantContent added in v1.19.0 

type AssistantContent struct {

	// Contained data.
	//
	// Types that are assignable to Data:
	//
	//	*AssistantContent_Text
	//	*AssistantContent_InlineData
	//	*AssistantContent_File_
	//	*AssistantContent_ExecutableCode_
	//	*AssistantContent_CodeExecutionResult_
	Data isAssistantContent_Data `protobuf_oneof:"data"`
	// The producer of the content. Can be "model" or "user".
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// Optional. Indicates if the part is thought from the model.
	Thought bool `protobuf:"varint,6,opt,name=thought,proto3" json:"thought,omitempty"`
	// contains filtered or unexported fields
}

Multi-modal content.

func (*AssistantContent) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent.ProtoReflect.Descriptor instead.

func (*AssistantContent) GetCodeExecutionResult added in v1.19.0 

func (x *AssistantContent) GetCodeExecutionResult() *AssistantContent_CodeExecutionResult

func (*AssistantContent) GetData added in v1.19.0 

func (m *AssistantContent) GetData() isAssistantContent_Data

func (*AssistantContent) GetExecutableCode added in v1.19.0 

func (x *AssistantContent) GetExecutableCode() *AssistantContent_ExecutableCode

func (*AssistantContent) GetFile added in v1.19.0 

func (x *AssistantContent) GetFile() *AssistantContent_File

func (*AssistantContent) GetInlineData added in v1.19.0 

func (x *AssistantContent) GetInlineData() *AssistantContent_Blob

func (*AssistantContent) GetRole added in v1.19.0 

func (x *AssistantContent) GetRole() string

func (*AssistantContent) GetText added in v1.19.0 

func (x *AssistantContent) GetText() string

func (*AssistantContent) GetThought added in v1.19.0 

func (x *AssistantContent) GetThought() bool

func (*AssistantContent) ProtoMessage added in v1.19.0 

func (*AssistantContent) ProtoMessage()

func (*AssistantContent) ProtoReflect added in v1.19.0 

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

func (*AssistantContent) Reset added in v1.19.0 

func (x *AssistantContent) Reset()

func (*AssistantContent) String added in v1.19.0 

func (x *AssistantContent) String() string

type AssistantContent_Blob added in v1.19.0 

type AssistantContent_Blob struct {

	// Required. The media type (MIME type) of the generated data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. Raw bytes.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Inline blob.

func (*AssistantContent_Blob) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent_Blob.ProtoReflect.Descriptor instead.

func (*AssistantContent_Blob) GetData added in v1.19.0 

func (x *AssistantContent_Blob) GetData() []byte

func (*AssistantContent_Blob) GetMimeType added in v1.19.0 

func (x *AssistantContent_Blob) GetMimeType() string

func (*AssistantContent_Blob) ProtoMessage added in v1.19.0 

func (*AssistantContent_Blob) ProtoMessage()

func (*AssistantContent_Blob) ProtoReflect added in v1.19.0 

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

func (*AssistantContent_Blob) Reset added in v1.19.0 

func (x *AssistantContent_Blob) Reset()

func (*AssistantContent_Blob) String added in v1.19.0 

func (x *AssistantContent_Blob) String() string

type AssistantContent_CodeExecutionResult added in v1.19.0 

type AssistantContent_CodeExecutionResult struct {

	// Required. Outcome of the code execution.
	Outcome AssistantContent_CodeExecutionResult_Outcome `` /* 150-byte string literal not displayed */
	// Optional. Contains stdout when code execution is successful, stderr or
	// other description otherwise.
	Output string `protobuf:"bytes,2,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Result of executing ExecutableCode.

func (*AssistantContent_CodeExecutionResult) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent_CodeExecutionResult.ProtoReflect.Descriptor instead.

func (*AssistantContent_CodeExecutionResult) GetOutcome added in v1.19.0 

func (x *AssistantContent_CodeExecutionResult) GetOutcome() AssistantContent_CodeExecutionResult_Outcome

func (*AssistantContent_CodeExecutionResult) GetOutput added in v1.19.0 

func (x *AssistantContent_CodeExecutionResult) GetOutput() string

func (*AssistantContent_CodeExecutionResult) ProtoMessage added in v1.19.0 

func (*AssistantContent_CodeExecutionResult) ProtoMessage()

func (*AssistantContent_CodeExecutionResult) ProtoReflect added in v1.19.0 

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

func (*AssistantContent_CodeExecutionResult) Reset added in v1.19.0 

func (x *AssistantContent_CodeExecutionResult) Reset()

func (*AssistantContent_CodeExecutionResult) String added in v1.19.0 

func (x *AssistantContent_CodeExecutionResult) String() string

type AssistantContent_CodeExecutionResult_ added in v1.19.0 

type AssistantContent_CodeExecutionResult_ struct {
	// Result of executing an ExecutableCode.
	CodeExecutionResult *AssistantContent_CodeExecutionResult `protobuf:"bytes,8,opt,name=code_execution_result,json=codeExecutionResult,proto3,oneof"`
}

type AssistantContent_CodeExecutionResult_Outcome added in v1.19.0 

type AssistantContent_CodeExecutionResult_Outcome int32

Enumeration of possible outcomes of the code execution. 

const (
	// Unspecified status. This value should not be used.
	AssistantContent_CodeExecutionResult_OUTCOME_UNSPECIFIED AssistantContent_CodeExecutionResult_Outcome = 0
	// Code execution completed successfully.
	AssistantContent_CodeExecutionResult_OUTCOME_OK AssistantContent_CodeExecutionResult_Outcome = 1
	// Code execution finished but with a failure. `stderr` should contain the
	// reason.
	AssistantContent_CodeExecutionResult_OUTCOME_FAILED AssistantContent_CodeExecutionResult_Outcome = 2
	// Code execution ran for too long, and was cancelled. There may or may
	// not be a partial output present.
	AssistantContent_CodeExecutionResult_OUTCOME_DEADLINE_EXCEEDED AssistantContent_CodeExecutionResult_Outcome = 3
)

func (AssistantContent_CodeExecutionResult_Outcome) Descriptor added in v1.19.0 

func (AssistantContent_CodeExecutionResult_Outcome) Descriptor() protoreflect.EnumDescriptor

func (AssistantContent_CodeExecutionResult_Outcome) Enum added in v1.19.0 

func (x AssistantContent_CodeExecutionResult_Outcome) Enum() *AssistantContent_CodeExecutionResult_Outcome

func (AssistantContent_CodeExecutionResult_Outcome) EnumDescriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent_CodeExecutionResult_Outcome.Descriptor instead.

func (AssistantContent_CodeExecutionResult_Outcome) Number added in v1.19.0 

func (x AssistantContent_CodeExecutionResult_Outcome) Number() protoreflect.EnumNumber

func (AssistantContent_CodeExecutionResult_Outcome) String added in v1.19.0 

func (x AssistantContent_CodeExecutionResult_Outcome) String() string

func (AssistantContent_CodeExecutionResult_Outcome) Type added in v1.19.0 

func (AssistantContent_CodeExecutionResult_Outcome) Type() protoreflect.EnumType

type AssistantContent_ExecutableCode added in v1.19.0 

type AssistantContent_ExecutableCode struct {

	// Required. The code content. Currently only supports Python.
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

Code generated by the model that is meant to be executed by the model.

func (*AssistantContent_ExecutableCode) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent_ExecutableCode.ProtoReflect.Descriptor instead.

func (*AssistantContent_ExecutableCode) GetCode added in v1.19.0 

func (x *AssistantContent_ExecutableCode) GetCode() string

func (*AssistantContent_ExecutableCode) ProtoMessage added in v1.19.0 

func (*AssistantContent_ExecutableCode) ProtoMessage()

func (*AssistantContent_ExecutableCode) ProtoReflect added in v1.19.0 

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

func (*AssistantContent_ExecutableCode) Reset added in v1.19.0 

func (x *AssistantContent_ExecutableCode) Reset()

func (*AssistantContent_ExecutableCode) String added in v1.19.0 

func (x *AssistantContent_ExecutableCode) String() string

type AssistantContent_ExecutableCode_ added in v1.19.0 

type AssistantContent_ExecutableCode_ struct {
	// Code generated by the model that is meant to be executed.
	ExecutableCode *AssistantContent_ExecutableCode `protobuf:"bytes,7,opt,name=executable_code,json=executableCode,proto3,oneof"`
}

type AssistantContent_File added in v1.19.0 

type AssistantContent_File struct {

	// Required. The media type (MIME type) of the file.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. The file ID.
	FileId string `protobuf:"bytes,2,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
	// contains filtered or unexported fields
}

A file, e.g., an audio summary.

func (*AssistantContent_File) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantContent_File.ProtoReflect.Descriptor instead.

func (*AssistantContent_File) GetFileId added in v1.19.0 

func (x *AssistantContent_File) GetFileId() string

func (*AssistantContent_File) GetMimeType added in v1.19.0 

func (x *AssistantContent_File) GetMimeType() string

func (*AssistantContent_File) ProtoMessage added in v1.19.0 

func (*AssistantContent_File) ProtoMessage()

func (*AssistantContent_File) ProtoReflect added in v1.19.0 

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

func (*AssistantContent_File) Reset added in v1.19.0 

func (x *AssistantContent_File) Reset()

func (*AssistantContent_File) String added in v1.19.0 

func (x *AssistantContent_File) String() string

type AssistantContent_File_ added in v1.19.0 

type AssistantContent_File_ struct {
	// A file, e.g., an audio summary.
	File *AssistantContent_File `protobuf:"bytes,4,opt,name=file,proto3,oneof"`
}

type AssistantContent_InlineData added in v1.19.0 

type AssistantContent_InlineData struct {
	// Inline binary data.
	InlineData *AssistantContent_Blob `protobuf:"bytes,3,opt,name=inline_data,json=inlineData,proto3,oneof"`
}

type AssistantContent_Text added in v1.19.0 

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

type AssistantGroundedContent added in v1.19.0 

type AssistantGroundedContent struct {

	// Grounding metadata for various modals. It only supports text for now.
	//
	// Types that are assignable to Metadata:
	//
	//	*AssistantGroundedContent_TextGroundingMetadata_
	Metadata isAssistantGroundedContent_Metadata `protobuf_oneof:"metadata"`
	// The content.
	Content *AssistantContent `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

A piece of content and possibly its grounding information.

Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.

func (*AssistantGroundedContent) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantGroundedContent.ProtoReflect.Descriptor instead.

func (*AssistantGroundedContent) GetContent added in v1.19.0 

func (x *AssistantGroundedContent) GetContent() *AssistantContent

func (*AssistantGroundedContent) GetMetadata added in v1.19.0 

func (m *AssistantGroundedContent) GetMetadata() isAssistantGroundedContent_Metadata

func (*AssistantGroundedContent) GetTextGroundingMetadata added in v1.19.0 

func (x *AssistantGroundedContent) GetTextGroundingMetadata() *AssistantGroundedContent_TextGroundingMetadata

func (*AssistantGroundedContent) ProtoMessage added in v1.19.0 

func (*AssistantGroundedContent) ProtoMessage()

func (*AssistantGroundedContent) ProtoReflect added in v1.19.0 

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

func (*AssistantGroundedContent) Reset added in v1.19.0 

func (x *AssistantGroundedContent) Reset()

func (*AssistantGroundedContent) String added in v1.19.0 

func (x *AssistantGroundedContent) String() string

type AssistantGroundedContent_TextGroundingMetadata added in v1.19.0 

type AssistantGroundedContent_TextGroundingMetadata struct {

	// Grounding information for parts of the text.
	Segments []*AssistantGroundedContent_TextGroundingMetadata_Segment `protobuf:"bytes,4,rep,name=segments,proto3" json:"segments,omitempty"`
	// References for the grounded text.
	References []*AssistantGroundedContent_TextGroundingMetadata_Reference `protobuf:"bytes,2,rep,name=references,proto3" json:"references,omitempty"`
	// contains filtered or unexported fields
}

Grounding details for text sources.

func (*AssistantGroundedContent_TextGroundingMetadata) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantGroundedContent_TextGroundingMetadata.ProtoReflect.Descriptor instead.

func (*AssistantGroundedContent_TextGroundingMetadata) GetReferences added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata) GetReferences() []*AssistantGroundedContent_TextGroundingMetadata_Reference

func (*AssistantGroundedContent_TextGroundingMetadata) GetSegments added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata) GetSegments() []*AssistantGroundedContent_TextGroundingMetadata_Segment

func (*AssistantGroundedContent_TextGroundingMetadata) ProtoMessage added in v1.19.0 

func (*AssistantGroundedContent_TextGroundingMetadata) ProtoMessage()

func (*AssistantGroundedContent_TextGroundingMetadata) ProtoReflect added in v1.19.0 

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

func (*AssistantGroundedContent_TextGroundingMetadata) Reset added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata) Reset()

func (*AssistantGroundedContent_TextGroundingMetadata) String added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata) String() string

type AssistantGroundedContent_TextGroundingMetadata_ added in v1.19.0 

type AssistantGroundedContent_TextGroundingMetadata_ struct {
	// Metadata for grounding based on text sources.
	TextGroundingMetadata *AssistantGroundedContent_TextGroundingMetadata `protobuf:"bytes,3,opt,name=text_grounding_metadata,json=textGroundingMetadata,proto3,oneof"`
}

type AssistantGroundedContent_TextGroundingMetadata_Reference added in v1.19.0 

type AssistantGroundedContent_TextGroundingMetadata_Reference struct {

	// Referenced text content.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Document metadata.
	DocumentMetadata *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata `protobuf:"bytes,2,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// contains filtered or unexported fields
}

Referenced content and related document metadata.

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Reference.ProtoReflect.Descriptor instead.

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) GetContent added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) GetContent() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) GetDocumentMetadata added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) GetDocumentMetadata() *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoMessage added in v1.19.0 

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoMessage()

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoReflect added in v1.19.0 

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

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) Reset added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) Reset()

func (*AssistantGroundedContent_TextGroundingMetadata_Reference) String added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) String() string

type AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata added in v1.19.0 

type AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata struct {

	// Document resource name.
	Document *string `protobuf:"bytes,1,opt,name=document,proto3,oneof" json:"document,omitempty"`
	// URI for the document. It may contain a URL that redirects to the
	// actual website.
	Uri *string `protobuf:"bytes,2,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
	// Title.
	Title *string `protobuf:"bytes,3,opt,name=title,proto3,oneof" json:"title,omitempty"`
	// Page identifier.
	PageIdentifier *string `protobuf:"bytes,4,opt,name=page_identifier,json=pageIdentifier,proto3,oneof" json:"page_identifier,omitempty"`
	// Domain name from the document URI. Note that the `uri` field may
	// contain a URL that redirects to the actual website, in which case
	// this will contain the domain name of the target site.
	Domain *string `protobuf:"bytes,5,opt,name=domain,proto3,oneof" json:"domain,omitempty"`
	// contains filtered or unexported fields
}

Document metadata.

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDocument added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDocument() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDomain added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDomain() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetPageIdentifier added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetPageIdentifier() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetTitle added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetTitle() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetUri added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetUri() string

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoMessage added in v1.19.0 

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoMessage()

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoReflect added in v1.19.0 

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

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Reset added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Reset()

func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) String added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) String() string

type AssistantGroundedContent_TextGroundingMetadata_Segment added in v1.19.0 

type AssistantGroundedContent_TextGroundingMetadata_Segment struct {

	// Zero-based index indicating the start of the segment, measured in bytes
	// of a UTF-8 string (i.e. characters encoded on multiple bytes have a
	// length of more than one).
	StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// End of the segment, exclusive.
	EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// References for the segment.
	ReferenceIndices []int32 `protobuf:"varint,4,rep,packed,name=reference_indices,json=referenceIndices,proto3" json:"reference_indices,omitempty"`
	// Score for the segment.
	GroundingScore float32 `protobuf:"fixed32,5,opt,name=grounding_score,json=groundingScore,proto3" json:"grounding_score,omitempty"`
	// The text segment itself.
	Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Grounding information for a segment of the text.

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) Descriptor deprecated added in v1.19.0 

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

Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Segment.ProtoReflect.Descriptor instead.

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetEndIndex added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetEndIndex() int64

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetGroundingScore added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetGroundingScore() float32

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetReferenceIndices added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetReferenceIndices() []int32

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetStartIndex added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetStartIndex() int64

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetText added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetText() string

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoMessage added in v1.19.0 

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoMessage()

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoReflect added in v1.19.0 

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

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) Reset added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) Reset()

func (*AssistantGroundedContent_TextGroundingMetadata_Segment) String added in v1.19.0 

func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) String() string

type AssistantServiceClient added in v1.19.0 

type AssistantServiceClient interface {
	// Assists the user with a query in a streaming fashion.
	StreamAssist(ctx context.Context, in *StreamAssistRequest, opts ...grpc.CallOption) (AssistantService_StreamAssistClient, error)
}

AssistantServiceClient is the client API for AssistantService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAssistantServiceClient added in v1.19.0 

func NewAssistantServiceClient(cc grpc.ClientConnInterface) AssistantServiceClient

type AssistantServiceServer added in v1.19.0 

type AssistantServiceServer interface {
	// Assists the user with a query in a streaming fashion.
	StreamAssist(*StreamAssistRequest, AssistantService_StreamAssistServer) error
}

AssistantServiceServer is the server API for AssistantService service. All implementations should embed UnimplementedAssistantServiceServer for forward compatibility

type AssistantService_StreamAssistClient added in v1.19.0 

type AssistantService_StreamAssistClient interface {
	Recv() (*StreamAssistResponse, error)
	grpc.ClientStream
}

type AssistantService_StreamAssistServer added in v1.19.0 

type AssistantService_StreamAssistServer interface {
	Send(*StreamAssistResponse) error
	grpc.ServerStream
}

type BatchCreateTargetSiteMetadata added in v1.5.0 

type BatchCreateTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSiteMetadata) ProtoMessage()

func (*BatchCreateTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSiteMetadata) Reset added in v1.5.0 

func (x *BatchCreateTargetSiteMetadata) Reset()

func (*BatchCreateTargetSiteMetadata) String added in v1.5.0 

func (x *BatchCreateTargetSiteMetadata) String() string

type BatchCreateTargetSitesRequest added in v1.5.0 

type BatchCreateTargetSitesRequest struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesRequest) GetParent added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) GetParent() string

func (*BatchCreateTargetSitesRequest) GetRequests added in v1.5.0 

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

func (*BatchCreateTargetSitesRequest) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSitesRequest) ProtoMessage()

func (*BatchCreateTargetSitesRequest) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSitesRequest) Reset added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) Reset()

func (*BatchCreateTargetSitesRequest) String added in v1.5.0 

func (x *BatchCreateTargetSitesRequest) String() string

type BatchCreateTargetSitesResponse added in v1.5.0 

type BatchCreateTargetSitesResponse struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesResponse) GetTargetSites added in v1.5.0 

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

func (*BatchCreateTargetSitesResponse) ProtoMessage added in v1.5.0 

func (*BatchCreateTargetSitesResponse) ProtoMessage()

func (*BatchCreateTargetSitesResponse) ProtoReflect added in v1.5.0 

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

func (*BatchCreateTargetSitesResponse) Reset added in v1.5.0 

func (x *BatchCreateTargetSitesResponse) Reset()

func (*BatchCreateTargetSitesResponse) String added in v1.5.0 

func (x *BatchCreateTargetSitesResponse) String() string

type BatchGetDocumentsMetadataRequest added in v1.14.0 

type BatchGetDocumentsMetadataRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Matcher for the
	// [Document][google.cloud.discoveryengine.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 deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataRequest.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest) GetMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetMatcher() *BatchGetDocumentsMetadataRequest_Matcher

func (*BatchGetDocumentsMetadataRequest) GetParent added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetParent() string

func (*BatchGetDocumentsMetadataRequest) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) Reset()

func (*BatchGetDocumentsMetadataRequest) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) String() string

type BatchGetDocumentsMetadataRequest_FhirMatcher added in v1.15.0 

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

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

Deprecated: Use BatchGetDocumentsMetadataRequest_FhirMatcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) GetFhirResources added in v1.15.0 

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

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoMessage added in v1.15.0 

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoReflect added in v1.15.0 

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

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) Reset added in v1.15.0 

func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) Reset()

func (*BatchGetDocumentsMetadataRequest_FhirMatcher) String added in v1.15.0 

func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) String() string

type BatchGetDocumentsMetadataRequest_Matcher added in v1.14.0 

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

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

Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_Matcher) GetFhirMatcher added in v1.15.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) GetFhirMatcher() *BatchGetDocumentsMetadataRequest_FhirMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetMatcher added in v1.14.0 

func (m *BatchGetDocumentsMetadataRequest_Matcher) GetMatcher() isBatchGetDocumentsMetadataRequest_Matcher_Matcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher() *BatchGetDocumentsMetadataRequest_UrisMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_Matcher) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) Reset()

func (*BatchGetDocumentsMetadataRequest_Matcher) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) String() string

type BatchGetDocumentsMetadataRequest_Matcher_FhirMatcher added in v1.15.0 

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

type BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher added in v1.14.0 

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

type BatchGetDocumentsMetadataRequest_UrisMatcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_UrisMatcher struct {

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

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

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

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

Deprecated: Use BatchGetDocumentsMetadataRequest_UrisMatcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) GetUris added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) Reset()

func (*BatchGetDocumentsMetadataRequest_UrisMatcher) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) String() string

type BatchGetDocumentsMetadataResponse added in v1.14.0 

type BatchGetDocumentsMetadataResponse struct {

	// The metadata of the [Document][google.cloud.discoveryengine.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 deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse) GetDocumentsMetadata added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse) Reset()

func (*BatchGetDocumentsMetadataResponse) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata struct {

	// The value of the matcher that was used to match the
	// [Document][google.cloud.discoveryengine.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 `` /* 141-byte string literal not displayed */
	// 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 added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue() *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState() BatchGetDocumentsMetadataResponse_State

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue struct {

	// The value of the matcher that was used to match the
	// [Document][google.cloud.discoveryengine.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 added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetFhirResource added in v1.15.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetFhirResource() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue added in v1.14.0 

func (m *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue() isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource added in v1.15.0 

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

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri added in v1.14.0 

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

type BatchGetDocumentsMetadataResponse_State added in v1.14.0 

type BatchGetDocumentsMetadataResponse_State int32

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

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

func (BatchGetDocumentsMetadataResponse_State) Descriptor() protoreflect.EnumDescriptor

func (BatchGetDocumentsMetadataResponse_State) Enum added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Enum() *BatchGetDocumentsMetadataResponse_State

func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_State.Descriptor instead.

func (BatchGetDocumentsMetadataResponse_State) Number added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Number() protoreflect.EnumNumber

func (BatchGetDocumentsMetadataResponse_State) String added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) String() string

func (BatchGetDocumentsMetadataResponse_State) Type added in v1.14.0 

func (BatchGetDocumentsMetadataResponse_State) Type() protoreflect.EnumType

type BatchUpdateUserLicensesMetadata added in v1.18.0 

type BatchUpdateUserLicensesMetadata 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 user licenses successfully updated.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of user licenses that failed to be updated.
	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 [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*BatchUpdateUserLicensesMetadata) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use BatchUpdateUserLicensesMetadata.ProtoReflect.Descriptor instead.

func (*BatchUpdateUserLicensesMetadata) GetCreateTime added in v1.18.0 

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

func (*BatchUpdateUserLicensesMetadata) GetFailureCount added in v1.18.0 

func (x *BatchUpdateUserLicensesMetadata) GetFailureCount() int64

func (*BatchUpdateUserLicensesMetadata) GetSuccessCount added in v1.18.0 

func (x *BatchUpdateUserLicensesMetadata) GetSuccessCount() int64

func (*BatchUpdateUserLicensesMetadata) GetUpdateTime added in v1.18.0 

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

func (*BatchUpdateUserLicensesMetadata) ProtoMessage added in v1.18.0 

func (*BatchUpdateUserLicensesMetadata) ProtoMessage()

func (*BatchUpdateUserLicensesMetadata) ProtoReflect added in v1.18.0 

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

func (*BatchUpdateUserLicensesMetadata) Reset added in v1.18.0 

func (x *BatchUpdateUserLicensesMetadata) Reset()

func (*BatchUpdateUserLicensesMetadata) String added in v1.18.0 

func (x *BatchUpdateUserLicensesMetadata) String() string

type BatchUpdateUserLicensesRequest added in v1.18.0 

type BatchUpdateUserLicensesRequest struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*BatchUpdateUserLicensesRequest_InlineSource_
	Source isBatchUpdateUserLicensesRequest_Source `protobuf_oneof:"source"`
	// Required. The parent [UserStore][] resource name, format:
	// `projects/{project}/locations/{location}/userStores/{user_store_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. If true, if user licenses removed associated license config, the
	// user license will be deleted. By default which is false, the user license
	// will be updated to unassigned state.
	DeleteUnassignedUserLicenses bool `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] method.

func (*BatchUpdateUserLicensesRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use BatchUpdateUserLicensesRequest.ProtoReflect.Descriptor instead.

func (*BatchUpdateUserLicensesRequest) GetDeleteUnassignedUserLicenses added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest) GetDeleteUnassignedUserLicenses() bool

func (*BatchUpdateUserLicensesRequest) GetInlineSource added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest) GetInlineSource() *BatchUpdateUserLicensesRequest_InlineSource

func (*BatchUpdateUserLicensesRequest) GetParent added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest) GetParent() string

func (*BatchUpdateUserLicensesRequest) GetSource added in v1.18.0 

func (m *BatchUpdateUserLicensesRequest) GetSource() isBatchUpdateUserLicensesRequest_Source

func (*BatchUpdateUserLicensesRequest) ProtoMessage added in v1.18.0 

func (*BatchUpdateUserLicensesRequest) ProtoMessage()

func (*BatchUpdateUserLicensesRequest) ProtoReflect added in v1.18.0 

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

func (*BatchUpdateUserLicensesRequest) Reset added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest) Reset()

func (*BatchUpdateUserLicensesRequest) String added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest) String() string

type BatchUpdateUserLicensesRequest_InlineSource added in v1.18.0 

type BatchUpdateUserLicensesRequest_InlineSource struct {

	// Required. A list of user licenses to update. Each user license
	// must have a valid
	// [UserLicense.user_principal][google.cloud.discoveryengine.v1.UserLicense.user_principal].
	UserLicenses []*UserLicense `protobuf:"bytes,1,rep,name=user_licenses,json=userLicenses,proto3" json:"user_licenses,omitempty"`
	// Optional. The list of fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for BatchUpdateUserLicenses method.

func (*BatchUpdateUserLicensesRequest_InlineSource) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use BatchUpdateUserLicensesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*BatchUpdateUserLicensesRequest_InlineSource) GetUpdateMask added in v1.18.0 

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

func (*BatchUpdateUserLicensesRequest_InlineSource) GetUserLicenses added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest_InlineSource) GetUserLicenses() []*UserLicense

func (*BatchUpdateUserLicensesRequest_InlineSource) ProtoMessage added in v1.18.0 

func (*BatchUpdateUserLicensesRequest_InlineSource) ProtoMessage()

func (*BatchUpdateUserLicensesRequest_InlineSource) ProtoReflect added in v1.18.0 

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

func (*BatchUpdateUserLicensesRequest_InlineSource) Reset added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest_InlineSource) Reset()

func (*BatchUpdateUserLicensesRequest_InlineSource) String added in v1.18.0 

func (x *BatchUpdateUserLicensesRequest_InlineSource) String() string

type BatchUpdateUserLicensesRequest_InlineSource_ added in v1.18.0 

type BatchUpdateUserLicensesRequest_InlineSource_ struct {
	// The inline source for the input content for document embeddings.
	InlineSource *BatchUpdateUserLicensesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type BatchUpdateUserLicensesResponse added in v1.18.0 

type BatchUpdateUserLicensesResponse struct {

	// UserLicenses successfully updated.
	UserLicenses []*UserLicense `protobuf:"bytes,1,rep,name=user_licenses,json=userLicenses,proto3" json:"user_licenses,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 [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] method.

func (*BatchUpdateUserLicensesResponse) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use BatchUpdateUserLicensesResponse.ProtoReflect.Descriptor instead.

func (*BatchUpdateUserLicensesResponse) GetErrorSamples added in v1.18.0 

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

func (*BatchUpdateUserLicensesResponse) GetUserLicenses added in v1.18.0 

func (x *BatchUpdateUserLicensesResponse) GetUserLicenses() []*UserLicense

func (*BatchUpdateUserLicensesResponse) ProtoMessage added in v1.18.0 

func (*BatchUpdateUserLicensesResponse) ProtoMessage()

func (*BatchUpdateUserLicensesResponse) ProtoReflect added in v1.18.0 

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

func (*BatchUpdateUserLicensesResponse) Reset added in v1.18.0 

func (x *BatchUpdateUserLicensesResponse) Reset()

func (*BatchUpdateUserLicensesResponse) String added in v1.18.0 

func (x *BatchUpdateUserLicensesResponse) String() string

type BatchVerifyTargetSitesMetadata added in v1.5.0 

type BatchVerifyTargetSitesMetadata struct {

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesMetadata) GetCreateTime added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) GetUpdateTime added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesMetadata) ProtoMessage()

func (*BatchVerifyTargetSitesMetadata) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesMetadata) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesMetadata) Reset()

func (*BatchVerifyTargetSitesMetadata) String added in v1.5.0 

func (x *BatchVerifyTargetSitesMetadata) String() string

type BatchVerifyTargetSitesRequest added in v1.5.0 

type BatchVerifyTargetSitesRequest struct {

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesRequest) GetParent added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) GetParent() string

func (*BatchVerifyTargetSitesRequest) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesRequest) ProtoMessage()

func (*BatchVerifyTargetSitesRequest) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesRequest) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) Reset()

func (*BatchVerifyTargetSitesRequest) String added in v1.5.0 

func (x *BatchVerifyTargetSitesRequest) String() string

type BatchVerifyTargetSitesResponse added in v1.5.0 

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesResponse) ProtoMessage added in v1.5.0 

func (*BatchVerifyTargetSitesResponse) ProtoMessage()

func (*BatchVerifyTargetSitesResponse) ProtoReflect added in v1.5.0 

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

func (*BatchVerifyTargetSitesResponse) Reset added in v1.5.0 

func (x *BatchVerifyTargetSitesResponse) Reset()

func (*BatchVerifyTargetSitesResponse) String added in v1.5.0 

func (x *BatchVerifyTargetSitesResponse) String() string

type BigQuerySource 

type BigQuerySource struct {

	// BigQuery table partition info. Leave this empty if the BigQuery table
	// is not partitioned.
	//
	// Types that are assignable to Partition:
	//
	//	*BigQuerySource_PartitionDate
	Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
	// The project ID or the project number that contains the BigQuery source. Has
	// a length limit of 128 characters. If not specified, inherits the project
	// ID from the parent request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The BigQuery data set to copy the data from with a length limit
	// of 1,024 characters.
	DatasetId string `protobuf:"bytes,2,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The BigQuery table to copy the data from with a length limit of
	// 1,024 characters.
	TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// BigQuery export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for user event imports:
	//
	// * `user_event` (default): One
	// [UserEvent][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetDataSchema 

func (x *BigQuerySource) GetDataSchema() string

func (*BigQuerySource) GetDatasetId 

func (x *BigQuerySource) GetDatasetId() string

func (*BigQuerySource) GetGcsStagingDir 

func (x *BigQuerySource) GetGcsStagingDir() string

func (*BigQuerySource) GetPartition 

func (m *BigQuerySource) GetPartition() isBigQuerySource_Partition

func (*BigQuerySource) GetPartitionDate 

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

func (*BigQuerySource) GetProjectId 

func (x *BigQuerySource) GetProjectId() string

func (*BigQuerySource) GetTableId 

func (x *BigQuerySource) GetTableId() string

func (*BigQuerySource) ProtoMessage 

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect 

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

func (*BigQuerySource) Reset 

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String 

func (x *BigQuerySource) String() string

type BigQuerySource_PartitionDate 

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

type BigtableOptions added in v1.7.0 

type BigtableOptions struct {

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

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

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

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

Deprecated: Use BigtableOptions.ProtoReflect.Descriptor instead.

func (*BigtableOptions) GetFamilies added in v1.7.0 

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

func (*BigtableOptions) GetKeyFieldName added in v1.7.0 

func (x *BigtableOptions) GetKeyFieldName() string

func (*BigtableOptions) ProtoMessage added in v1.7.0 

func (*BigtableOptions) ProtoMessage()

func (*BigtableOptions) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions) Reset added in v1.7.0 

func (x *BigtableOptions) Reset()

func (*BigtableOptions) String added in v1.7.0 

func (x *BigtableOptions) String() string

type BigtableOptions_BigtableColumn added in v1.7.0 

type BigtableOptions_BigtableColumn struct {

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

The column of the Bigtable.

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

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

Deprecated: Use BigtableOptions_BigtableColumn.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumn) GetEncoding added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetEncoding() BigtableOptions_Encoding

func (*BigtableOptions_BigtableColumn) GetFieldName added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetFieldName() string

func (*BigtableOptions_BigtableColumn) GetQualifier added in v1.7.0 

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

func (*BigtableOptions_BigtableColumn) GetType added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) GetType() BigtableOptions_Type

func (*BigtableOptions_BigtableColumn) ProtoMessage added in v1.7.0 

func (*BigtableOptions_BigtableColumn) ProtoMessage()

func (*BigtableOptions_BigtableColumn) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions_BigtableColumn) Reset added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) Reset()

func (*BigtableOptions_BigtableColumn) String added in v1.7.0 

func (x *BigtableOptions_BigtableColumn) String() string

type BigtableOptions_BigtableColumnFamily added in v1.7.0 

type BigtableOptions_BigtableColumnFamily struct {

	// The field name to use for this column family in the document. The
	// name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
	// it is parsed from the family name with best effort. However, due to
	// different naming patterns, field name collisions could happen, where
	// parsing behavior is undefined.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The encoding mode of the values when the type is not STRING.
	// Acceptable encoding values are:
	//
	// * `TEXT`: indicates values are alphanumeric text strings.
	// * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
	// family of functions. This can be overridden for a specific column
	// by listing that column in `columns` and specifying an encoding for it.
	Encoding BigtableOptions_Encoding `` /* 132-byte string literal not displayed */
	// The type of values in this column family.
	// The values are expected to be encoded using `HBase Bytes.toBytes`
	// function when the encoding value is set to `BINARY`.
	Type BigtableOptions_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.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 deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumnFamily) GetColumns added in v1.7.0 

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

func (*BigtableOptions_BigtableColumnFamily) GetEncoding added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetEncoding() BigtableOptions_Encoding

func (*BigtableOptions_BigtableColumnFamily) GetFieldName added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() string

func (*BigtableOptions_BigtableColumnFamily) GetType added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetType() BigtableOptions_Type

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage added in v1.7.0 

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()

func (*BigtableOptions_BigtableColumnFamily) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions_BigtableColumnFamily) Reset added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) Reset()

func (*BigtableOptions_BigtableColumnFamily) String added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) String() string

type BigtableOptions_Encoding added in v1.7.0 

type BigtableOptions_Encoding int32

The encoding mode of a Bigtable column or column family. 

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

func (BigtableOptions_Encoding) Descriptor added in v1.7.0 

func (BigtableOptions_Encoding) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Encoding) Enum added in v1.7.0 

func (x BigtableOptions_Encoding) Enum() *BigtableOptions_Encoding

func (BigtableOptions_Encoding) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Encoding.Descriptor instead.

func (BigtableOptions_Encoding) Number added in v1.7.0 

func (x BigtableOptions_Encoding) Number() protoreflect.EnumNumber

func (BigtableOptions_Encoding) String added in v1.7.0 

func (x BigtableOptions_Encoding) String() string

func (BigtableOptions_Encoding) Type added in v1.7.0 

func (BigtableOptions_Encoding) Type() protoreflect.EnumType

type BigtableOptions_Type added in v1.7.0 

type BigtableOptions_Type int32

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

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

func (BigtableOptions_Type) Descriptor added in v1.7.0 

func (BigtableOptions_Type) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Type) Enum added in v1.7.0 

func (x BigtableOptions_Type) Enum() *BigtableOptions_Type

func (BigtableOptions_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Type.Descriptor instead.

func (BigtableOptions_Type) Number added in v1.7.0 

func (x BigtableOptions_Type) Number() protoreflect.EnumNumber

func (BigtableOptions_Type) String added in v1.7.0 

func (x BigtableOptions_Type) String() string

func (BigtableOptions_Type) Type added in v1.7.0 

func (BigtableOptions_Type) Type() protoreflect.EnumType

type BigtableSource added in v1.7.0 

type BigtableSource struct {

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

The Cloud Bigtable source for importing data.

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

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

Deprecated: Use BigtableSource.ProtoReflect.Descriptor instead.

func (*BigtableSource) GetBigtableOptions added in v1.7.0 

func (x *BigtableSource) GetBigtableOptions() *BigtableOptions

func (*BigtableSource) GetInstanceId added in v1.7.0 

func (x *BigtableSource) GetInstanceId() string

func (*BigtableSource) GetProjectId added in v1.7.0 

func (x *BigtableSource) GetProjectId() string

func (*BigtableSource) GetTableId added in v1.7.0 

func (x *BigtableSource) GetTableId() string

func (*BigtableSource) ProtoMessage added in v1.7.0 

func (*BigtableSource) ProtoMessage()

func (*BigtableSource) ProtoReflect added in v1.7.0 

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

func (*BigtableSource) Reset added in v1.7.0 

func (x *BigtableSource) Reset()

func (*BigtableSource) String added in v1.7.0 

func (x *BigtableSource) String() string

type CheckGroundingRequest added in v1.8.0 

type CheckGroundingRequest struct {

	// Required. The resource name of the grounding config, such as
	// `projects/*/locations/global/groundingConfigs/default_grounding_config`.
	GroundingConfig string `protobuf:"bytes,1,opt,name=grounding_config,json=groundingConfig,proto3" json:"grounding_config,omitempty"`
	// Answer candidate to check. 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 `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CheckGroundingRequest.ProtoReflect.Descriptor instead.

func (*CheckGroundingRequest) GetAnswerCandidate added in v1.8.0 

func (x *CheckGroundingRequest) GetAnswerCandidate() string

func (*CheckGroundingRequest) GetFacts added in v1.8.0 

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

func (*CheckGroundingRequest) GetGroundingConfig added in v1.8.0 

func (x *CheckGroundingRequest) GetGroundingConfig() string

func (*CheckGroundingRequest) GetGroundingSpec added in v1.8.0 

func (x *CheckGroundingRequest) GetGroundingSpec() *CheckGroundingSpec

func (*CheckGroundingRequest) GetUserLabels added in v1.8.0 

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

func (*CheckGroundingRequest) ProtoMessage added in v1.8.0 

func (*CheckGroundingRequest) ProtoMessage()

func (*CheckGroundingRequest) ProtoReflect added in v1.8.0 

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

func (*CheckGroundingRequest) Reset added in v1.8.0 

func (x *CheckGroundingRequest) Reset()

func (*CheckGroundingRequest) String added in v1.8.0 

func (x *CheckGroundingRequest) String() string

type CheckGroundingResponse added in v1.8.0 

type CheckGroundingResponse struct {

	// The support score for the input answer candidate.
	// Higher the score, higher is the fraction of claims that are supported by
	// the provided facts. This is always set when a response is returned.
	SupportScore *float32 `protobuf:"fixed32,1,opt,name=support_score,json=supportScore,proto3,oneof" json:"support_score,omitempty"`
	// List of facts cited across all claims in the answer candidate.
	// These are derived from the facts supplied in the request.
	CitedChunks []*FactChunk `protobuf:"bytes,3,rep,name=cited_chunks,json=citedChunks,proto3" json:"cited_chunks,omitempty"`
	// 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 deprecated added in v1.8.0 

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

Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse) GetCitedChunks added in v1.8.0 

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

func (*CheckGroundingResponse) GetCitedFacts added in v1.17.0 

func (x *CheckGroundingResponse) GetCitedFacts() []*CheckGroundingResponse_CheckGroundingFactChunk

func (*CheckGroundingResponse) GetClaims added in v1.8.0 

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

func (*CheckGroundingResponse) GetSupportScore added in v1.8.0 

func (x *CheckGroundingResponse) GetSupportScore() float32

func (*CheckGroundingResponse) ProtoMessage added in v1.8.0 

func (*CheckGroundingResponse) ProtoMessage()

func (*CheckGroundingResponse) ProtoReflect added in v1.8.0 

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

func (*CheckGroundingResponse) Reset added in v1.8.0 

func (x *CheckGroundingResponse) Reset()

func (*CheckGroundingResponse) String added in v1.8.0 

func (x *CheckGroundingResponse) String() string

type CheckGroundingResponse_CheckGroundingFactChunk added in v1.17.0 

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

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

Deprecated: Use CheckGroundingResponse_CheckGroundingFactChunk.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse_CheckGroundingFactChunk) GetChunkText added in v1.17.0 

func (x *CheckGroundingResponse_CheckGroundingFactChunk) GetChunkText() string

func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoMessage added in v1.17.0 

func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoMessage()

func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoReflect added in v1.17.0 

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

func (*CheckGroundingResponse_CheckGroundingFactChunk) Reset added in v1.17.0 

func (x *CheckGroundingResponse_CheckGroundingFactChunk) Reset()

func (*CheckGroundingResponse_CheckGroundingFactChunk) String added in v1.17.0 

func (x *CheckGroundingResponse_CheckGroundingFactChunk) String() string

type CheckGroundingResponse_Claim added in v1.8.0 

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 `` /* 136-byte string literal not displayed */
	// Confidence score for the claim in the answer candidate, in the range of
	// [0, 1]. This is set only when
	// `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
	Score *float64 `protobuf:"fixed64,7,opt,name=score,proto3,oneof" json:"score,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse_Claim) GetCitationIndices added in v1.8.0 

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

func (*CheckGroundingResponse_Claim) GetClaimText added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetClaimText() string

func (*CheckGroundingResponse_Claim) GetEndPos added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetEndPos() int32

func (*CheckGroundingResponse_Claim) GetGroundingCheckRequired added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetGroundingCheckRequired() bool

func (*CheckGroundingResponse_Claim) GetScore added in v1.18.0 

func (x *CheckGroundingResponse_Claim) GetScore() float64

func (*CheckGroundingResponse_Claim) GetStartPos added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetStartPos() int32

func (*CheckGroundingResponse_Claim) ProtoMessage added in v1.8.0 

func (*CheckGroundingResponse_Claim) ProtoMessage()

func (*CheckGroundingResponse_Claim) ProtoReflect added in v1.8.0 

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

func (*CheckGroundingResponse_Claim) Reset added in v1.8.0 

func (x *CheckGroundingResponse_Claim) Reset()

func (*CheckGroundingResponse_Claim) String added in v1.8.0 

func (x *CheckGroundingResponse_Claim) String() string

type CheckGroundingSpec added in v1.8.0 

type CheckGroundingSpec struct {

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

Specification for the grounding check.

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

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

Deprecated: Use CheckGroundingSpec.ProtoReflect.Descriptor instead.

func (*CheckGroundingSpec) GetCitationThreshold added in v1.8.0 

func (x *CheckGroundingSpec) GetCitationThreshold() float64

func (*CheckGroundingSpec) GetEnableClaimLevelScore added in v1.18.0 

func (x *CheckGroundingSpec) GetEnableClaimLevelScore() bool

func (*CheckGroundingSpec) ProtoMessage added in v1.8.0 

func (*CheckGroundingSpec) ProtoMessage()

func (*CheckGroundingSpec) ProtoReflect added in v1.8.0 

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

func (*CheckGroundingSpec) Reset added in v1.8.0 

func (x *CheckGroundingSpec) Reset()

func (*CheckGroundingSpec) String added in v1.8.0 

func (x *CheckGroundingSpec) String() string

type Chunk added in v1.9.0 

type Chunk struct {

	// The full resource name of the chunk.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Unique chunk ID of the current chunk.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Content is a string from a document (parsed content).
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// Output only. Represents the relevance score based on similarity.
	// Higher score indicates higher chunk relevance.
	// The score is in range [-1.0, 1.0].
	// Only populated on
	// [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"`
	// Output only. Image Data URLs if the current chunk contains images.
	// Data URLs are composed of four parts: a prefix (data:), a MIME type
	// indicating the type of data, an optional base64 token if non-textual,
	// and the data itself:
	// data:[<mediatype>][;base64],<data>
	DataUrls []string `protobuf:"bytes,9,rep,name=data_urls,json=dataUrls,proto3" json:"data_urls,omitempty"`
	// Output only. Annotation contents if the current chunk contains annotations.
	AnnotationContents []string `protobuf:"bytes,11,rep,name=annotation_contents,json=annotationContents,proto3" json:"annotation_contents,omitempty"`
	// Output only. The annotation metadata includes structured content in the
	// current chunk.
	AnnotationMetadata []*Chunk_AnnotationMetadata `protobuf:"bytes,12,rep,name=annotation_metadata,json=annotationMetadata,proto3" json:"annotation_metadata,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetAnnotationContents added in v1.18.0 

func (x *Chunk) GetAnnotationContents() []string

func (*Chunk) GetAnnotationMetadata added in v1.18.0 

func (x *Chunk) GetAnnotationMetadata() []*Chunk_AnnotationMetadata

func (*Chunk) GetChunkMetadata added in v1.9.0 

func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadata

func (*Chunk) GetContent added in v1.9.0 

func (x *Chunk) GetContent() string

func (*Chunk) GetDataUrls added in v1.18.0 

func (x *Chunk) GetDataUrls() []string

func (*Chunk) GetDerivedStructData added in v1.9.0 

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

func (*Chunk) GetDocumentMetadata added in v1.9.0 

func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadata

func (*Chunk) GetId added in v1.9.0 

func (x *Chunk) GetId() string

func (*Chunk) GetName added in v1.9.0 

func (x *Chunk) GetName() string

func (*Chunk) GetPageSpan added in v1.9.0 

func (x *Chunk) GetPageSpan() *Chunk_PageSpan

func (*Chunk) GetRelevanceScore added in v1.9.0 

func (x *Chunk) GetRelevanceScore() float64

func (*Chunk) ProtoMessage added in v1.9.0 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect added in v1.9.0 

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

func (*Chunk) Reset added in v1.9.0 

func (x *Chunk) Reset()

func (*Chunk) String added in v1.9.0 

func (x *Chunk) String() string

type Chunk_AnnotationMetadata added in v1.18.0 

type Chunk_AnnotationMetadata struct {

	// Output only. The structured content information.
	StructuredContent *Chunk_StructuredContent `protobuf:"bytes,1,opt,name=structured_content,json=structuredContent,proto3" json:"structured_content,omitempty"`
	// Output only. Image id is provided if the structured content is based on
	// an image.
	ImageId string `protobuf:"bytes,2,opt,name=image_id,json=imageId,proto3" json:"image_id,omitempty"`
	// contains filtered or unexported fields
}

The annotation metadata includes structured content in the current chunk.

func (*Chunk_AnnotationMetadata) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use Chunk_AnnotationMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_AnnotationMetadata) GetImageId added in v1.18.0 

func (x *Chunk_AnnotationMetadata) GetImageId() string

func (*Chunk_AnnotationMetadata) GetStructuredContent added in v1.18.0 

func (x *Chunk_AnnotationMetadata) GetStructuredContent() *Chunk_StructuredContent

func (*Chunk_AnnotationMetadata) ProtoMessage added in v1.18.0 

func (*Chunk_AnnotationMetadata) ProtoMessage()

func (*Chunk_AnnotationMetadata) ProtoReflect added in v1.18.0 

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

func (*Chunk_AnnotationMetadata) Reset added in v1.18.0 

func (x *Chunk_AnnotationMetadata) Reset()

func (*Chunk_AnnotationMetadata) String added in v1.18.0 

func (x *Chunk_AnnotationMetadata) String() string

type Chunk_ChunkMetadata added in v1.9.0 

type Chunk_ChunkMetadata struct {

	// The previous chunks of the current chunk. The number is controlled by
	// [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.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 deprecated added in v1.9.0 

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

Deprecated: Use Chunk_ChunkMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_ChunkMetadata) GetNextChunks added in v1.9.0 

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

func (*Chunk_ChunkMetadata) GetPreviousChunks added in v1.9.0 

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

func (*Chunk_ChunkMetadata) ProtoMessage added in v1.9.0 

func (*Chunk_ChunkMetadata) ProtoMessage()

func (*Chunk_ChunkMetadata) ProtoReflect added in v1.9.0 

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

func (*Chunk_ChunkMetadata) Reset added in v1.9.0 

func (x *Chunk_ChunkMetadata) Reset()

func (*Chunk_ChunkMetadata) String added in v1.9.0 

func (x *Chunk_ChunkMetadata) String() string

type Chunk_DocumentMetadata added in v1.9.0 

type Chunk_DocumentMetadata struct {

	// Uri of the document.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title of the document.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Data representation.
	// The structured JSON data for the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.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 deprecated added in v1.9.0 

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

Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_DocumentMetadata) GetStructData added in v1.9.0 

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

func (*Chunk_DocumentMetadata) GetTitle added in v1.9.0 

func (x *Chunk_DocumentMetadata) GetTitle() string

func (*Chunk_DocumentMetadata) GetUri added in v1.9.0 

func (x *Chunk_DocumentMetadata) GetUri() string

func (*Chunk_DocumentMetadata) ProtoMessage added in v1.9.0 

func (*Chunk_DocumentMetadata) ProtoMessage()

func (*Chunk_DocumentMetadata) ProtoReflect added in v1.9.0 

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

func (*Chunk_DocumentMetadata) Reset added in v1.9.0 

func (x *Chunk_DocumentMetadata) Reset()

func (*Chunk_DocumentMetadata) String added in v1.9.0 

func (x *Chunk_DocumentMetadata) String() string

type Chunk_PageSpan added in v1.9.0 

type Chunk_PageSpan struct {

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

Page span of the chunk.

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

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

Deprecated: Use Chunk_PageSpan.ProtoReflect.Descriptor instead.

func (*Chunk_PageSpan) GetPageEnd added in v1.9.0 

func (x *Chunk_PageSpan) GetPageEnd() int32

func (*Chunk_PageSpan) GetPageStart added in v1.9.0 

func (x *Chunk_PageSpan) GetPageStart() int32

func (*Chunk_PageSpan) ProtoMessage added in v1.9.0 

func (*Chunk_PageSpan) ProtoMessage()

func (*Chunk_PageSpan) ProtoReflect added in v1.9.0 

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

func (*Chunk_PageSpan) Reset added in v1.9.0 

func (x *Chunk_PageSpan) Reset()

func (*Chunk_PageSpan) String added in v1.9.0 

func (x *Chunk_PageSpan) String() string

type Chunk_StructureType added in v1.18.0 

type Chunk_StructureType int32

Defines the types of the structured content that can be extracted. 

const (
	// Default value.
	Chunk_STRUCTURE_TYPE_UNSPECIFIED Chunk_StructureType = 0
	// Shareholder structure.
	Chunk_SHAREHOLDER_STRUCTURE Chunk_StructureType = 1
	// Signature structure.
	Chunk_SIGNATURE_STRUCTURE Chunk_StructureType = 2
	// Checkbox structure.
	Chunk_CHECKBOX_STRUCTURE Chunk_StructureType = 3
)

func (Chunk_StructureType) Descriptor added in v1.18.0 

func (Chunk_StructureType) Descriptor() protoreflect.EnumDescriptor

func (Chunk_StructureType) Enum added in v1.18.0 

func (x Chunk_StructureType) Enum() *Chunk_StructureType

func (Chunk_StructureType) EnumDescriptor deprecated added in v1.18.0 

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

Deprecated: Use Chunk_StructureType.Descriptor instead.

func (Chunk_StructureType) Number added in v1.18.0 

func (x Chunk_StructureType) Number() protoreflect.EnumNumber

func (Chunk_StructureType) String added in v1.18.0 

func (x Chunk_StructureType) String() string

func (Chunk_StructureType) Type added in v1.18.0 

func (Chunk_StructureType) Type() protoreflect.EnumType

type Chunk_StructuredContent added in v1.18.0 

type Chunk_StructuredContent struct {

	// Output only. The structure type of the structured content.
	StructureType Chunk_StructureType `` /* 158-byte string literal not displayed */
	// Output only. The content of the structured content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

The structured content information.

func (*Chunk_StructuredContent) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use Chunk_StructuredContent.ProtoReflect.Descriptor instead.

func (*Chunk_StructuredContent) GetContent added in v1.18.0 

func (x *Chunk_StructuredContent) GetContent() string

func (*Chunk_StructuredContent) GetStructureType added in v1.18.0 

func (x *Chunk_StructuredContent) GetStructureType() Chunk_StructureType

func (*Chunk_StructuredContent) ProtoMessage added in v1.18.0 

func (*Chunk_StructuredContent) ProtoMessage()

func (*Chunk_StructuredContent) ProtoReflect added in v1.18.0 

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

func (*Chunk_StructuredContent) Reset added in v1.18.0 

func (x *Chunk_StructuredContent) Reset()

func (*Chunk_StructuredContent) String added in v1.18.0 

func (x *Chunk_StructuredContent) String() string

type CloudSqlSource added in v1.7.0 

type CloudSqlSource struct {

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

Cloud SQL source import data from.

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

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

Deprecated: Use CloudSqlSource.ProtoReflect.Descriptor instead.

func (*CloudSqlSource) GetDatabaseId added in v1.7.0 

func (x *CloudSqlSource) GetDatabaseId() string

func (*CloudSqlSource) GetGcsStagingDir added in v1.7.0 

func (x *CloudSqlSource) GetGcsStagingDir() string

func (*CloudSqlSource) GetInstanceId added in v1.7.0 

func (x *CloudSqlSource) GetInstanceId() string

func (*CloudSqlSource) GetOffload added in v1.7.0 

func (x *CloudSqlSource) GetOffload() bool

func (*CloudSqlSource) GetProjectId added in v1.7.0 

func (x *CloudSqlSource) GetProjectId() string

func (*CloudSqlSource) GetTableId added in v1.7.0 

func (x *CloudSqlSource) GetTableId() string

func (*CloudSqlSource) ProtoMessage added in v1.7.0 

func (*CloudSqlSource) ProtoMessage()

func (*CloudSqlSource) ProtoReflect added in v1.7.0 

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

func (*CloudSqlSource) Reset added in v1.7.0 

func (x *CloudSqlSource) Reset()

func (*CloudSqlSource) String added in v1.7.0 

func (x *CloudSqlSource) String() string

type CmekConfig added in v1.18.0 

type CmekConfig struct {

	// Required. The name of the CmekConfig of the form
	// `projects/{project}/locations/{location}/cmekConfig` or
	// `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// KMS key resource name which will be used to encrypt resources
	// `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
	KmsKey string `protobuf:"bytes,2,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// KMS key version resource name which will be used to encrypt resources
	// `<kms_key>/cryptoKeyVersions/{keyVersion}`.
	KmsKeyVersion string `protobuf:"bytes,6,opt,name=kms_key_version,json=kmsKeyVersion,proto3" json:"kms_key_version,omitempty"`
	// Output only. The states of the CmekConfig.
	State CmekConfig_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1.CmekConfig_State" json:"state,omitempty"`
	// Output only. The default CmekConfig for the Customer.
	IsDefault bool `protobuf:"varint,4,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// Output only. The timestamp of the last key rotation.
	LastRotationTimestampMicros int64 `` /* 147-byte string literal not displayed */
	// Optional. Single-regional CMEKs that are required for some VAIS features.
	SingleRegionKeys []*SingleRegionKey `protobuf:"bytes,7,rep,name=single_region_keys,json=singleRegionKeys,proto3" json:"single_region_keys,omitempty"`
	// Output only. Whether the NotebookLM Corpus is ready to be used.
	NotebooklmState CmekConfig_NotebookLMState `` /* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configurations used to enable CMEK data encryption with Cloud KMS keys.

func (*CmekConfig) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use CmekConfig.ProtoReflect.Descriptor instead.

func (*CmekConfig) GetIsDefault added in v1.18.0 

func (x *CmekConfig) GetIsDefault() bool

func (*CmekConfig) GetKmsKey added in v1.18.0 

func (x *CmekConfig) GetKmsKey() string

func (*CmekConfig) GetKmsKeyVersion added in v1.18.0 

func (x *CmekConfig) GetKmsKeyVersion() string

func (*CmekConfig) GetLastRotationTimestampMicros added in v1.18.0 

func (x *CmekConfig) GetLastRotationTimestampMicros() int64

func (*CmekConfig) GetName added in v1.18.0 

func (x *CmekConfig) GetName() string

func (*CmekConfig) GetNotebooklmState added in v1.18.0 

func (x *CmekConfig) GetNotebooklmState() CmekConfig_NotebookLMState

func (*CmekConfig) GetSingleRegionKeys added in v1.18.0 

func (x *CmekConfig) GetSingleRegionKeys() []*SingleRegionKey

func (*CmekConfig) GetState added in v1.18.0 

func (x *CmekConfig) GetState() CmekConfig_State

func (*CmekConfig) ProtoMessage added in v1.18.0 

func (*CmekConfig) ProtoMessage()

func (*CmekConfig) ProtoReflect added in v1.18.0 

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

func (*CmekConfig) Reset added in v1.18.0 

func (x *CmekConfig) Reset()

func (*CmekConfig) String added in v1.18.0 

func (x *CmekConfig) String() string

type CmekConfigServiceClient added in v1.18.0 

type CmekConfigServiceClient interface {
	// Provisions a CMEK key for use in a location of a customer's project.
	// This method will also conduct location validation on the provided
	// cmekConfig to make sure the key is valid and can be used in the
	// selected location.
	UpdateCmekConfig(ctx context.Context, in *UpdateCmekConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].
	GetCmekConfig(ctx context.Context, in *GetCmekConfigRequest, opts ...grpc.CallOption) (*CmekConfig, error)
	// Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s
	// with the project.
	ListCmekConfigs(ctx context.Context, in *ListCmekConfigsRequest, opts ...grpc.CallOption) (*ListCmekConfigsResponse, error)
	// De-provisions a CmekConfig.
	DeleteCmekConfig(ctx context.Context, in *DeleteCmekConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

CmekConfigServiceClient is the client API for CmekConfigService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewCmekConfigServiceClient added in v1.18.0 

func NewCmekConfigServiceClient(cc grpc.ClientConnInterface) CmekConfigServiceClient

type CmekConfigServiceServer added in v1.18.0 

type CmekConfigServiceServer interface {
	// Provisions a CMEK key for use in a location of a customer's project.
	// This method will also conduct location validation on the provided
	// cmekConfig to make sure the key is valid and can be used in the
	// selected location.
	UpdateCmekConfig(context.Context, *UpdateCmekConfigRequest) (*longrunningpb.Operation, error)
	// Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].
	GetCmekConfig(context.Context, *GetCmekConfigRequest) (*CmekConfig, error)
	// Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s
	// with the project.
	ListCmekConfigs(context.Context, *ListCmekConfigsRequest) (*ListCmekConfigsResponse, error)
	// De-provisions a CmekConfig.
	DeleteCmekConfig(context.Context, *DeleteCmekConfigRequest) (*longrunningpb.Operation, error)
}

CmekConfigServiceServer is the server API for CmekConfigService service. All implementations should embed UnimplementedCmekConfigServiceServer for forward compatibility

type CmekConfig_NotebookLMState added in v1.18.0 

type CmekConfig_NotebookLMState int32

States of NotebookLM. 

const (
	// The NotebookLM state is unknown.
	CmekConfig_NOTEBOOK_LM_STATE_UNSPECIFIED CmekConfig_NotebookLMState = 0
	// The NotebookLM is not ready.
	CmekConfig_NOTEBOOK_LM_NOT_READY CmekConfig_NotebookLMState = 1
	// The NotebookLM is ready to be used.
	CmekConfig_NOTEBOOK_LM_READY CmekConfig_NotebookLMState = 2
	// The NotebookLM is not enabled.
	CmekConfig_NOTEBOOK_LM_NOT_ENABLED CmekConfig_NotebookLMState = 3
)

func (CmekConfig_NotebookLMState) Descriptor added in v1.18.0 

func (CmekConfig_NotebookLMState) Descriptor() protoreflect.EnumDescriptor

func (CmekConfig_NotebookLMState) Enum added in v1.18.0 

func (x CmekConfig_NotebookLMState) Enum() *CmekConfig_NotebookLMState

func (CmekConfig_NotebookLMState) EnumDescriptor deprecated added in v1.18.0 

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

Deprecated: Use CmekConfig_NotebookLMState.Descriptor instead.

func (CmekConfig_NotebookLMState) Number added in v1.18.0 

func (x CmekConfig_NotebookLMState) Number() protoreflect.EnumNumber

func (CmekConfig_NotebookLMState) String added in v1.18.0 

func (x CmekConfig_NotebookLMState) String() string

func (CmekConfig_NotebookLMState) Type added in v1.18.0 

func (CmekConfig_NotebookLMState) Type() protoreflect.EnumType

type CmekConfig_State added in v1.18.0 

type CmekConfig_State int32

States of the CmekConfig. 

const (
	// The CmekConfig state is unknown.
	CmekConfig_STATE_UNSPECIFIED CmekConfig_State = 0
	// The CmekConfig is creating.
	CmekConfig_CREATING CmekConfig_State = 1
	// The CmekConfig can be used with DataStores.
	CmekConfig_ACTIVE CmekConfig_State = 2
	// The CmekConfig is unavailable, most likely due to the KMS Key being
	// revoked.
	CmekConfig_KEY_ISSUE CmekConfig_State = 3
	// The CmekConfig is deleting.
	CmekConfig_DELETING CmekConfig_State = 4
	// The CmekConfig deletion process failed.
	CmekConfig_DELETE_FAILED CmekConfig_State = 7
	// The CmekConfig is not usable, most likely due to some internal issue.
	CmekConfig_UNUSABLE CmekConfig_State = 5
	// The KMS key version is being rotated.
	CmekConfig_ACTIVE_ROTATING CmekConfig_State = 6
	// The KMS key is soft deleted. Some cleanup policy will eventually be
	// applied.
	CmekConfig_DELETED CmekConfig_State = 8
)

func (CmekConfig_State) Descriptor added in v1.18.0 

func (CmekConfig_State) Descriptor() protoreflect.EnumDescriptor

func (CmekConfig_State) Enum added in v1.18.0 

func (x CmekConfig_State) Enum() *CmekConfig_State

func (CmekConfig_State) EnumDescriptor deprecated added in v1.18.0 

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

Deprecated: Use CmekConfig_State.Descriptor instead.

func (CmekConfig_State) Number added in v1.18.0 

func (x CmekConfig_State) Number() protoreflect.EnumNumber

func (CmekConfig_State) String added in v1.18.0 

func (x CmekConfig_State) String() string

func (CmekConfig_State) Type added in v1.18.0 

func (CmekConfig_State) Type() protoreflect.EnumType

type 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 deprecated 

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

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetEts 

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent 

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri 

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent 

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage 

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect 

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

func (*CollectUserEventRequest) Reset 

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String 

func (x *CollectUserEventRequest) String() string

type CompleteQueryRequest 

type CompleteQueryRequest struct {

	// Required. The parent data store resource name for which the completion is
	// performed, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The typeahead input used to fetch suggestions. Maximum length is
	// 128 characters.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Specifies the autocomplete data model. This overrides any model specified
	// in the Configuration > Autocomplete section of the Cloud console. Currently
	// supported values:
	//
	// * `document` - Using suggestions generated from user-imported documents.
	// * `search-history` - Using suggestions generated from the past history of
	// [SearchService.Search][google.cloud.discoveryengine.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 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*CompleteQueryRequest) Descriptor deprecated 

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

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetDataStore 

func (x *CompleteQueryRequest) GetDataStore() string

func (*CompleteQueryRequest) GetIncludeTailSuggestions added in v1.2.0 

func (x *CompleteQueryRequest) GetIncludeTailSuggestions() bool

func (*CompleteQueryRequest) GetQuery 

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetQueryModel 

func (x *CompleteQueryRequest) GetQueryModel() string

func (*CompleteQueryRequest) GetUserPseudoId 

func (x *CompleteQueryRequest) GetUserPseudoId() string

func (*CompleteQueryRequest) ProtoMessage 

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect 

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

func (*CompleteQueryRequest) Reset 

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String 

func (x *CompleteQueryRequest) String() string

type CompleteQueryResponse 

type CompleteQueryResponse struct {

	// Results of the matched query suggestions. The result list is ordered and
	// the first result is a top suggestion.
	QuerySuggestions []*CompleteQueryResponse_QuerySuggestion `protobuf:"bytes,1,rep,name=query_suggestions,json=querySuggestions,proto3" json:"query_suggestions,omitempty"`
	// True if the returned suggestions are all tail suggestions.
	//
	// For tail matching to be triggered, include_tail_suggestions in the request
	// must be true and there must be no suggestions that match the full query.
	TailMatchTriggered bool `protobuf:"varint,2,opt,name=tail_match_triggered,json=tailMatchTriggered,proto3" json:"tail_match_triggered,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CompleteQueryResponse) Descriptor deprecated 

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

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions 

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

func (*CompleteQueryResponse) GetTailMatchTriggered added in v1.2.0 

func (x *CompleteQueryResponse) GetTailMatchTriggered() bool

func (*CompleteQueryResponse) ProtoMessage 

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect 

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

func (*CompleteQueryResponse) Reset 

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String 

func (x *CompleteQueryResponse) String() string

type CompleteQueryResponse_QuerySuggestion 

type CompleteQueryResponse_QuerySuggestion struct {

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

Suggestions as search queries.

func (*CompleteQueryResponse_QuerySuggestion) Descriptor deprecated 

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

Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths added in v1.5.0 

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

func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion 

func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage 

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()

func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect 

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

func (*CompleteQueryResponse_QuerySuggestion) Reset 

func (x *CompleteQueryResponse_QuerySuggestion) Reset()

func (*CompleteQueryResponse_QuerySuggestion) String 

func (x *CompleteQueryResponse_QuerySuggestion) String() string

type 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 deprecated 

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

Deprecated: Use CompletionInfo.ProtoReflect.Descriptor instead.

func (*CompletionInfo) GetSelectedPosition 

func (x *CompletionInfo) GetSelectedPosition() int32

func (*CompletionInfo) GetSelectedSuggestion 

func (x *CompletionInfo) GetSelectedSuggestion() string

func (*CompletionInfo) ProtoMessage 

func (*CompletionInfo) ProtoMessage()

func (*CompletionInfo) ProtoReflect 

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

func (*CompletionInfo) Reset 

func (x *CompletionInfo) Reset()

func (*CompletionInfo) String 

func (x *CompletionInfo) String() string

type CompletionServiceClient 

type CompletionServiceClient interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
	// Imports all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewCompletionServiceClient 

func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient

type CompletionServiceServer 

type CompletionServiceServer interface {
	// Completes the specified user input with keyword suggestions.
	CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
	// Imports all
	// [SuggestionDenyListEntry][google.cloud.discoveryengine.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. All implementations should embed UnimplementedCompletionServiceServer for forward compatibility

type CompletionSuggestion added in v1.9.0 

type CompletionSuggestion struct {

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

Autocomplete suggestions that are imported from Customer.

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

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

Deprecated: Use CompletionSuggestion.ProtoReflect.Descriptor instead.

func (*CompletionSuggestion) GetAlternativePhrases added in v1.9.0 

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

func (*CompletionSuggestion) GetFrequency added in v1.9.0 

func (x *CompletionSuggestion) GetFrequency() int64

func (*CompletionSuggestion) GetGlobalScore added in v1.9.0 

func (x *CompletionSuggestion) GetGlobalScore() float64

func (*CompletionSuggestion) GetGroupId added in v1.9.0 

func (x *CompletionSuggestion) GetGroupId() string

func (*CompletionSuggestion) GetGroupScore added in v1.9.0 

func (x *CompletionSuggestion) GetGroupScore() float64

func (*CompletionSuggestion) GetLanguageCode added in v1.9.0 

func (x *CompletionSuggestion) GetLanguageCode() string

func (*CompletionSuggestion) GetRankingInfo added in v1.9.0 

func (m *CompletionSuggestion) GetRankingInfo() isCompletionSuggestion_RankingInfo

func (*CompletionSuggestion) GetSuggestion added in v1.9.0 

func (x *CompletionSuggestion) GetSuggestion() string

func (*CompletionSuggestion) ProtoMessage added in v1.9.0 

func (*CompletionSuggestion) ProtoMessage()

func (*CompletionSuggestion) ProtoReflect added in v1.9.0 

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

func (*CompletionSuggestion) Reset added in v1.9.0 

func (x *CompletionSuggestion) Reset()

func (*CompletionSuggestion) String added in v1.9.0 

func (x *CompletionSuggestion) String() string

type CompletionSuggestion_Frequency added in v1.9.0 

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

type CompletionSuggestion_GlobalScore added in v1.9.0 

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

type Condition added in v1.8.0 

type Condition struct {

	// Search only
	// A list of terms to match the query on.
	// 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. Only supported for Basic Site Search promotion serving controls.
	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 deprecated added in v1.8.0 

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

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetActiveTimeRange added in v1.8.0 

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

func (*Condition) GetQueryRegex added in v1.16.0 

func (x *Condition) GetQueryRegex() string

func (*Condition) GetQueryTerms added in v1.8.0 

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

func (*Condition) ProtoMessage added in v1.8.0 

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect added in v1.8.0 

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

func (*Condition) Reset added in v1.8.0 

func (x *Condition) Reset()

func (*Condition) String added in v1.8.0 

func (x *Condition) String() string

type Condition_QueryTerm added in v1.8.0 

type Condition_QueryTerm struct {

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

Matcher for search request query

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

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

Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.

func (*Condition_QueryTerm) GetFullMatch added in v1.8.0 

func (x *Condition_QueryTerm) GetFullMatch() bool

func (*Condition_QueryTerm) GetValue added in v1.8.0 

func (x *Condition_QueryTerm) GetValue() string

func (*Condition_QueryTerm) ProtoMessage added in v1.8.0 

func (*Condition_QueryTerm) ProtoMessage()

func (*Condition_QueryTerm) ProtoReflect added in v1.8.0 

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

func (*Condition_QueryTerm) Reset added in v1.8.0 

func (x *Condition_QueryTerm) Reset()

func (*Condition_QueryTerm) String added in v1.8.0 

func (x *Condition_QueryTerm) String() string

type Condition_TimeRange added in v1.8.0 

type Condition_TimeRange struct {

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

Used for time-dependent conditions.

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

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

Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.

func (*Condition_TimeRange) GetEndTime added in v1.8.0 

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

func (*Condition_TimeRange) GetStartTime added in v1.8.0 

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

func (*Condition_TimeRange) ProtoMessage added in v1.8.0 

func (*Condition_TimeRange) ProtoMessage()

func (*Condition_TimeRange) ProtoReflect added in v1.8.0 

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

func (*Condition_TimeRange) Reset added in v1.8.0 

func (x *Condition_TimeRange) Reset()

func (*Condition_TimeRange) String added in v1.8.0 

func (x *Condition_TimeRange) String() string

type Control added in v1.8.0 

type Control struct {

	// Actions are restricted by Vertical and Solution
	//
	// Required.
	//
	// Types that are assignable to Action:
	//
	//	*Control_BoostAction_
	//	*Control_FilterAction_
	//	*Control_RedirectAction_
	//	*Control_SynonymsAction_
	//	*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 `` /* 143-byte string literal not displayed */
	// Required. Immutable. What solution the control belongs to.
	//
	// Must be compatible with vertical of resource.
	// Otherwise an INVALID ARGUMENT error is thrown.
	SolutionType SolutionType `` /* 148-byte string literal not displayed */
	// Specifies the use case for the control.
	// Affects what condition fields can be set.
	// Only applies to
	// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.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 `` /* 144-byte string literal not displayed */
	// Determines when the associated action will trigger.
	//
	// Omit to always apply the action.
	// Currently only a single condition may be specified.
	// Otherwise an INVALID ARGUMENT error is thrown.
	Conditions []*Condition `protobuf:"bytes,5,rep,name=conditions,proto3" json:"conditions,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetAction added in v1.8.0 

func (m *Control) GetAction() isControl_Action

func (*Control) GetAssociatedServingConfigIds added in v1.8.0 

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

func (*Control) GetBoostAction added in v1.8.0 

func (x *Control) GetBoostAction() *Control_BoostAction

func (*Control) GetConditions added in v1.8.0 

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

func (*Control) GetDisplayName added in v1.8.0 

func (x *Control) GetDisplayName() string

func (*Control) GetFilterAction added in v1.8.0 

func (x *Control) GetFilterAction() *Control_FilterAction

func (*Control) GetName added in v1.8.0 

func (x *Control) GetName() string

func (*Control) GetPromoteAction added in v1.17.0 

func (x *Control) GetPromoteAction() *Control_PromoteAction

func (*Control) GetRedirectAction added in v1.8.0 

func (x *Control) GetRedirectAction() *Control_RedirectAction

func (*Control) GetSolutionType added in v1.8.0 

func (x *Control) GetSolutionType() SolutionType

func (*Control) GetSynonymsAction added in v1.8.0 

func (x *Control) GetSynonymsAction() *Control_SynonymsAction

func (*Control) GetUseCases added in v1.8.0 

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

func (*Control) ProtoMessage added in v1.8.0 

func (*Control) ProtoMessage()

func (*Control) ProtoReflect added in v1.8.0 

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

func (*Control) Reset added in v1.8.0 

func (x *Control) Reset()

func (*Control) String added in v1.8.0 

func (x *Control) String() string

type ControlServiceClient added in v1.8.0 

type ControlServiceClient interface {
	// Creates a Control.
	//
	// By default 1000 controls are allowed for a data store.
	// A request can be submitted to adjust this limit.
	// If the [Control][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewControlServiceClient added in v1.8.0 

func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient

type ControlServiceServer added in v1.8.0 

type ControlServiceServer interface {
	// Creates a Control.
	//
	// By default 1000 controls are allowed for a data store.
	// A request can be submitted to adjust this limit.
	// If the [Control][google.cloud.discoveryengine.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. All implementations should embed UnimplementedControlServiceServer for forward compatibility

type Control_BoostAction added in v1.8.0 

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

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

Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.

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

func (x *Control_BoostAction) GetBoost() float32

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

func (*Control_BoostAction) GetBoostSpec added in v1.17.0 

func (m *Control_BoostAction) GetBoostSpec() isControl_BoostAction_BoostSpec

func (*Control_BoostAction) GetDataStore added in v1.8.0 

func (x *Control_BoostAction) GetDataStore() string

func (*Control_BoostAction) GetFilter added in v1.8.0 

func (x *Control_BoostAction) GetFilter() string

func (*Control_BoostAction) GetFixedBoost added in v1.17.0 

func (x *Control_BoostAction) GetFixedBoost() float32

func (*Control_BoostAction) GetInterpolationBoostSpec added in v1.17.0 

func (x *Control_BoostAction) GetInterpolationBoostSpec() *Control_BoostAction_InterpolationBoostSpec

func (*Control_BoostAction) ProtoMessage added in v1.8.0 

func (*Control_BoostAction) ProtoMessage()

func (*Control_BoostAction) ProtoReflect added in v1.8.0 

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

func (*Control_BoostAction) Reset added in v1.8.0 

func (x *Control_BoostAction) Reset()

func (*Control_BoostAction) String added in v1.8.0 

func (x *Control_BoostAction) String() string

type Control_BoostAction_ added in v1.8.0 

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

type Control_BoostAction_FixedBoost added in v1.17.0 

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

type Control_BoostAction_InterpolationBoostSpec added in v1.17.0 

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 `` /* 195-byte string literal not displayed */
	// Optional. The interpolation type to be applied to connect the control
	// points listed below.
	InterpolationType Control_BoostAction_InterpolationBoostSpec_InterpolationType `` /* 211-byte string literal not displayed */
	// 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 added in v1.17.0 

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

Deprecated: Use Control_BoostAction_InterpolationBoostSpec.ProtoReflect.Descriptor instead.

func (*Control_BoostAction_InterpolationBoostSpec) GetAttributeType added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) GetAttributeType() Control_BoostAction_InterpolationBoostSpec_AttributeType

func (*Control_BoostAction_InterpolationBoostSpec) GetControlPoints added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) GetControlPoints() []*Control_BoostAction_InterpolationBoostSpec_ControlPoint

func (*Control_BoostAction_InterpolationBoostSpec) GetFieldName added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) GetFieldName() string

func (*Control_BoostAction_InterpolationBoostSpec) GetInterpolationType added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) GetInterpolationType() Control_BoostAction_InterpolationBoostSpec_InterpolationType

func (*Control_BoostAction_InterpolationBoostSpec) ProtoMessage added in v1.17.0 

func (*Control_BoostAction_InterpolationBoostSpec) ProtoMessage()

func (*Control_BoostAction_InterpolationBoostSpec) ProtoReflect added in v1.17.0 

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

func (*Control_BoostAction_InterpolationBoostSpec) Reset added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) Reset()

func (*Control_BoostAction_InterpolationBoostSpec) String added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec) String() string

type Control_BoostAction_InterpolationBoostSpec_ added in v1.17.0 

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

type Control_BoostAction_InterpolationBoostSpec_AttributeType added in v1.17.0 

type Control_BoostAction_InterpolationBoostSpec_AttributeType int32

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

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

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Descriptor() protoreflect.EnumDescriptor

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Enum added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) Enum() *Control_BoostAction_InterpolationBoostSpec_AttributeType

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_AttributeType.Descriptor instead.

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Number added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) Number() protoreflect.EnumNumber

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) String added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) String() string

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Type added in v1.17.0 

func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Type() protoreflect.EnumType

type Control_BoostAction_InterpolationBoostSpec_ControlPoint added in v1.17.0 

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

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

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_ControlPoint.ProtoReflect.Descriptor instead.

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetAttributeValue added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetAttributeValue() string

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetBoostAmount added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetBoostAmount() float32

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoMessage added in v1.17.0 

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoMessage()

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoReflect added in v1.17.0 

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

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Reset added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) Reset()

func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) String added in v1.17.0 

func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) String() string

type Control_BoostAction_InterpolationBoostSpec_InterpolationType added in v1.17.0 

type Control_BoostAction_InterpolationBoostSpec_InterpolationType int32

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

const (
	// Interpolation type is unspecified. In this case, it defaults to
	// Linear.
	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 added in v1.17.0 

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptor

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Enum added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) Enum() *Control_BoostAction_InterpolationBoostSpec_InterpolationType

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use Control_BoostAction_InterpolationBoostSpec_InterpolationType.Descriptor instead.

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Number added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) Number() protoreflect.EnumNumber

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) String added in v1.17.0 

func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) String() string

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Type added in v1.17.0 

func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Type() protoreflect.EnumType

type Control_FilterAction added in v1.8.0 

type Control_FilterAction struct {

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

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

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

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

Deprecated: Use Control_FilterAction.ProtoReflect.Descriptor instead.

func (*Control_FilterAction) GetDataStore added in v1.8.0 

func (x *Control_FilterAction) GetDataStore() string

func (*Control_FilterAction) GetFilter added in v1.8.0 

func (x *Control_FilterAction) GetFilter() string

func (*Control_FilterAction) ProtoMessage added in v1.8.0 

func (*Control_FilterAction) ProtoMessage()

func (*Control_FilterAction) ProtoReflect added in v1.8.0 

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

func (*Control_FilterAction) Reset added in v1.8.0 

func (x *Control_FilterAction) Reset()

func (*Control_FilterAction) String added in v1.8.0 

func (x *Control_FilterAction) String() string

type Control_FilterAction_ added in v1.8.0 

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

type Control_PromoteAction added in v1.17.0 

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

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

Deprecated: Use Control_PromoteAction.ProtoReflect.Descriptor instead.

func (*Control_PromoteAction) GetDataStore added in v1.17.0 

func (x *Control_PromoteAction) GetDataStore() string

func (*Control_PromoteAction) GetSearchLinkPromotion added in v1.17.0 

func (x *Control_PromoteAction) GetSearchLinkPromotion() *SearchLinkPromotion

func (*Control_PromoteAction) ProtoMessage added in v1.17.0 

func (*Control_PromoteAction) ProtoMessage()

func (*Control_PromoteAction) ProtoReflect added in v1.17.0 

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

func (*Control_PromoteAction) Reset added in v1.17.0 

func (x *Control_PromoteAction) Reset()

func (*Control_PromoteAction) String added in v1.17.0 

func (x *Control_PromoteAction) String() string

type Control_PromoteAction_ added in v1.17.0 

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

type Control_RedirectAction added in v1.8.0 

type Control_RedirectAction struct {

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

Redirects a shopper to the provided URI.

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

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

Deprecated: Use Control_RedirectAction.ProtoReflect.Descriptor instead.

func (*Control_RedirectAction) GetRedirectUri added in v1.8.0 

func (x *Control_RedirectAction) GetRedirectUri() string

func (*Control_RedirectAction) ProtoMessage added in v1.8.0 

func (*Control_RedirectAction) ProtoMessage()

func (*Control_RedirectAction) ProtoReflect added in v1.8.0 

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

func (*Control_RedirectAction) Reset added in v1.8.0 

func (x *Control_RedirectAction) Reset()

func (*Control_RedirectAction) String added in v1.8.0 

func (x *Control_RedirectAction) String() string

type Control_RedirectAction_ added in v1.8.0 

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

type Control_SynonymsAction added in v1.8.0 

type Control_SynonymsAction struct {

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

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

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

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

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

Deprecated: Use Control_SynonymsAction.ProtoReflect.Descriptor instead.

func (*Control_SynonymsAction) GetSynonyms added in v1.8.0 

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

func (*Control_SynonymsAction) ProtoMessage added in v1.8.0 

func (*Control_SynonymsAction) ProtoMessage()

func (*Control_SynonymsAction) ProtoReflect added in v1.8.0 

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

func (*Control_SynonymsAction) Reset added in v1.8.0 

func (x *Control_SynonymsAction) Reset()

func (*Control_SynonymsAction) String added in v1.8.0 

func (x *Control_SynonymsAction) String() string

type Control_SynonymsAction_ added in v1.8.0 

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

type Conversation added in v1.2.0 

type Conversation struct {

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

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

Deprecated: Use Conversation.ProtoReflect.Descriptor instead.

func (*Conversation) GetEndTime added in v1.2.0 

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

func (*Conversation) GetMessages added in v1.2.0 

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

func (*Conversation) GetName added in v1.2.0 

func (x *Conversation) GetName() string

func (*Conversation) GetStartTime added in v1.2.0 

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

func (*Conversation) GetState added in v1.2.0 

func (x *Conversation) GetState() Conversation_State

func (*Conversation) GetUserPseudoId added in v1.2.0 

func (x *Conversation) GetUserPseudoId() string

func (*Conversation) ProtoMessage added in v1.2.0 

func (*Conversation) ProtoMessage()

func (*Conversation) ProtoReflect added in v1.2.0 

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

func (*Conversation) Reset added in v1.2.0 

func (x *Conversation) Reset()

func (*Conversation) String added in v1.2.0 

func (x *Conversation) String() string

type ConversationContext added in v1.2.0 

type ConversationContext struct {

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

Defines context of the conversation

func (*ConversationContext) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.

func (*ConversationContext) GetActiveDocument added in v1.2.0 

func (x *ConversationContext) GetActiveDocument() string

func (*ConversationContext) GetContextDocuments added in v1.2.0 

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

func (*ConversationContext) ProtoMessage added in v1.2.0 

func (*ConversationContext) ProtoMessage()

func (*ConversationContext) ProtoReflect added in v1.2.0 

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

func (*ConversationContext) Reset added in v1.2.0 

func (x *ConversationContext) Reset()

func (*ConversationContext) String added in v1.2.0 

func (x *ConversationContext) String() string

type ConversationMessage added in v1.2.0 

type ConversationMessage struct {

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

Defines a conversation message.

func (*ConversationMessage) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.

func (*ConversationMessage) GetCreateTime added in v1.2.0 

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

func (*ConversationMessage) GetMessage added in v1.2.0 

func (m *ConversationMessage) GetMessage() isConversationMessage_Message

func (*ConversationMessage) GetReply added in v1.2.0 

func (x *ConversationMessage) GetReply() *Reply

func (*ConversationMessage) GetUserInput added in v1.2.0 

func (x *ConversationMessage) GetUserInput() *TextInput

func (*ConversationMessage) ProtoMessage added in v1.2.0 

func (*ConversationMessage) ProtoMessage()

func (*ConversationMessage) ProtoReflect added in v1.2.0 

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

func (*ConversationMessage) Reset added in v1.2.0 

func (x *ConversationMessage) Reset()

func (*ConversationMessage) String added in v1.2.0 

func (x *ConversationMessage) String() string

type ConversationMessage_Reply added in v1.2.0 

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

type ConversationMessage_UserInput added in v1.2.0 

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

type Conversation_State added in v1.2.0 

type Conversation_State int32

Enumeration of the state of the conversation. 

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

func (Conversation_State) Descriptor added in v1.2.0 

func (Conversation_State) Descriptor() protoreflect.EnumDescriptor

func (Conversation_State) Enum added in v1.2.0 

func (x Conversation_State) Enum() *Conversation_State

func (Conversation_State) EnumDescriptor deprecated added in v1.2.0 

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

Deprecated: Use Conversation_State.Descriptor instead.

func (Conversation_State) Number added in v1.2.0 

func (x Conversation_State) Number() protoreflect.EnumNumber

func (Conversation_State) String added in v1.2.0 

func (x Conversation_State) String() string

func (Conversation_State) Type added in v1.2.0 

func (Conversation_State) Type() protoreflect.EnumType

type ConversationalSearchServiceClient added in v1.2.0 

type ConversationalSearchServiceClient interface {
	// Converses a conversation.
	ConverseConversation(ctx context.Context, in *ConverseConversationRequest, opts ...grpc.CallOption) (*ConverseConversationResponse, error)
	// Creates a Conversation.
	//
	// If the [Conversation][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConversationalSearchServiceClient added in v1.2.0 

func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClient

type ConversationalSearchServiceServer added in v1.2.0 

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. All implementations should embed UnimplementedConversationalSearchServiceServer for forward compatibility

type ConversationalSearchService_StreamAnswerQueryClient added in v1.17.0 

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

type ConversationalSearchService_StreamAnswerQueryServer added in v1.17.0 

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

type ConverseConversationRequest added in v1.2.0 

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 `` /* 179-byte string literal not displayed */
	// A specification for configuring the summary returned in the response.
	SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,8,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
	// The filter syntax consists of an expression language for constructing a
	// predicate from one or more fields of the documents being filtered. Filter
	// expression is case-sensitive. This will be used to filter search results
	// which may affect the summary response.
	//
	// If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
	//
	// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
	// key property defined in the Vertex AI Search backend -- this mapping is
	// defined by the customer in their schema. For example a media customer might
	// have a field 'name' in their schema. In this case the filter would look
	// like this: filter --> name:'ANY("king kong")'
	//
	// For more information about filtering including syntax and filter
	// operators, see
	// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
	Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
	// Boost specification to boost certain documents in search results which may
	// affect the converse response. For more information on boosting, see
	// [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.

func (*ConverseConversationRequest) GetBoostSpec added in v1.7.0 

func (x *ConverseConversationRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*ConverseConversationRequest) GetConversation added in v1.2.0 

func (x *ConverseConversationRequest) GetConversation() *Conversation

func (*ConverseConversationRequest) GetFilter added in v1.5.0 

func (x *ConverseConversationRequest) GetFilter() string

func (*ConverseConversationRequest) GetName added in v1.2.0 

func (x *ConverseConversationRequest) GetName() string

func (*ConverseConversationRequest) GetQuery added in v1.2.0 

func (x *ConverseConversationRequest) GetQuery() *TextInput

func (*ConverseConversationRequest) GetSafeSearch added in v1.2.0 

func (x *ConverseConversationRequest) GetSafeSearch() bool

func (*ConverseConversationRequest) GetServingConfig added in v1.2.0 

func (x *ConverseConversationRequest) GetServingConfig() string

func (*ConverseConversationRequest) GetSummarySpec added in v1.2.0 

func (x *ConverseConversationRequest) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec

func (*ConverseConversationRequest) GetUserLabels added in v1.2.0 

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

func (*ConverseConversationRequest) ProtoMessage added in v1.2.0 

func (*ConverseConversationRequest) ProtoMessage()

func (*ConverseConversationRequest) ProtoReflect added in v1.2.0 

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

func (*ConverseConversationRequest) Reset added in v1.2.0 

func (x *ConverseConversationRequest) Reset()

func (*ConverseConversationRequest) String added in v1.2.0 

func (x *ConverseConversationRequest) String() string

type ConverseConversationResponse added in v1.2.0 

type ConverseConversationResponse struct {

	// Answer to the current query.
	Reply *Reply `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
	// Updated conversation including the answer.
	Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
	// 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 deprecated added in v1.2.0 

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

Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.

func (*ConverseConversationResponse) GetConversation added in v1.2.0 

func (x *ConverseConversationResponse) GetConversation() *Conversation

func (*ConverseConversationResponse) GetReply added in v1.2.0 

func (x *ConverseConversationResponse) GetReply() *Reply

func (*ConverseConversationResponse) GetSearchResults added in v1.2.0 

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

func (*ConverseConversationResponse) ProtoMessage added in v1.2.0 

func (*ConverseConversationResponse) ProtoMessage()

func (*ConverseConversationResponse) ProtoReflect added in v1.2.0 

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

func (*ConverseConversationResponse) Reset added in v1.2.0 

func (x *ConverseConversationResponse) Reset()

func (*ConverseConversationResponse) String added in v1.2.0 

func (x *ConverseConversationResponse) String() string

type CreateControlRequest added in v1.8.0 

type CreateControlRequest struct {

	// Required. Full resource name of parent data store. Format:
	// `projects/{project}/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 deprecated added in v1.8.0 

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

Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.

func (*CreateControlRequest) GetControl added in v1.8.0 

func (x *CreateControlRequest) GetControl() *Control

func (*CreateControlRequest) GetControlId added in v1.8.0 

func (x *CreateControlRequest) GetControlId() string

func (*CreateControlRequest) GetParent added in v1.8.0 

func (x *CreateControlRequest) GetParent() string

func (*CreateControlRequest) ProtoMessage added in v1.8.0 

func (*CreateControlRequest) ProtoMessage()

func (*CreateControlRequest) ProtoReflect added in v1.8.0 

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

func (*CreateControlRequest) Reset added in v1.8.0 

func (x *CreateControlRequest) Reset()

func (*CreateControlRequest) String added in v1.8.0 

func (x *CreateControlRequest) String() string

type CreateConversationRequest added in v1.2.0 

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

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

Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.

func (*CreateConversationRequest) GetConversation added in v1.2.0 

func (x *CreateConversationRequest) GetConversation() *Conversation

func (*CreateConversationRequest) GetParent added in v1.2.0 

func (x *CreateConversationRequest) GetParent() string

func (*CreateConversationRequest) ProtoMessage added in v1.2.0 

func (*CreateConversationRequest) ProtoMessage()

func (*CreateConversationRequest) ProtoReflect added in v1.2.0 

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

func (*CreateConversationRequest) Reset added in v1.2.0 

func (x *CreateConversationRequest) Reset()

func (*CreateConversationRequest) String added in v1.2.0 

func (x *CreateConversationRequest) String() string

type CreateDataStoreMetadata added in v1.5.0 

type CreateDataStoreMetadata struct {

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

Metadata related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*CreateDataStoreMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateDataStoreMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateDataStoreMetadata) ProtoMessage added in v1.5.0 

func (*CreateDataStoreMetadata) ProtoMessage()

func (*CreateDataStoreMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateDataStoreMetadata) Reset added in v1.5.0 

func (x *CreateDataStoreMetadata) Reset()

func (*CreateDataStoreMetadata) String added in v1.5.0 

func (x *CreateDataStoreMetadata) String() string

type CreateDataStoreRequest added in v1.5.0 

type CreateDataStoreRequest struct {

	// CMEK options for the DataStore. Setting this field will override the
	// default CmekConfig if one is set for the project.
	//
	// Types that are assignable to CmekOptions:
	//
	//	*CreateDataStoreRequest_CmekConfigName
	//	*CreateDataStoreRequest_DisableCmek
	CmekOptions isCreateDataStoreRequest_CmekOptions `protobuf_oneof:"cmek_options"`
	// 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 `` /* 138-byte string literal not displayed */
	// A boolean flag indicating whether to skip the default schema creation for
	// the data store. Only enable this flag if you are certain that the default
	// schema is incompatible with your use case.
	//
	// If set to true, you must manually create a schema for the data store before
	// any documents can be ingested.
	//
	// This flag cannot be specified if `data_store.starting_schema` is specified.
	SkipDefaultSchemaCreation bool `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateDataStoreRequest) GetCmekConfigName added in v1.18.0 

func (x *CreateDataStoreRequest) GetCmekConfigName() string

func (*CreateDataStoreRequest) GetCmekOptions added in v1.18.0 

func (m *CreateDataStoreRequest) GetCmekOptions() isCreateDataStoreRequest_CmekOptions

func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch added in v1.5.0 

func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() bool

func (*CreateDataStoreRequest) GetDataStore added in v1.5.0 

func (x *CreateDataStoreRequest) GetDataStore() *DataStore

func (*CreateDataStoreRequest) GetDataStoreId added in v1.5.0 

func (x *CreateDataStoreRequest) GetDataStoreId() string

func (*CreateDataStoreRequest) GetDisableCmek added in v1.18.0 

func (x *CreateDataStoreRequest) GetDisableCmek() bool

func (*CreateDataStoreRequest) GetParent added in v1.5.0 

func (x *CreateDataStoreRequest) GetParent() string

func (*CreateDataStoreRequest) GetSkipDefaultSchemaCreation added in v1.14.0 

func (x *CreateDataStoreRequest) GetSkipDefaultSchemaCreation() bool

func (*CreateDataStoreRequest) ProtoMessage added in v1.5.0 

func (*CreateDataStoreRequest) ProtoMessage()

func (*CreateDataStoreRequest) ProtoReflect added in v1.5.0 

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

func (*CreateDataStoreRequest) Reset added in v1.5.0 

func (x *CreateDataStoreRequest) Reset()

func (*CreateDataStoreRequest) String added in v1.5.0 

func (x *CreateDataStoreRequest) String() string

type CreateDataStoreRequest_CmekConfigName added in v1.18.0 

type CreateDataStoreRequest_CmekConfigName struct {
	// Resource name of the CmekConfig to use for protecting this DataStore.
	CmekConfigName string `protobuf:"bytes,5,opt,name=cmek_config_name,json=cmekConfigName,proto3,oneof"`
}

type CreateDataStoreRequest_DisableCmek added in v1.18.0 

type CreateDataStoreRequest_DisableCmek struct {
	// DataStore without CMEK protections. If a default CmekConfig is set for
	// the project, setting this field will override the default CmekConfig as
	// well.
	DisableCmek bool `protobuf:"varint,6,opt,name=disable_cmek,json=disableCmek,proto3,oneof"`
}

type CreateDocumentRequest 

type CreateDocumentRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Document][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocument 

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId 

func (x *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetParent 

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect 

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

func (*CreateDocumentRequest) Reset 

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (x *CreateDocumentRequest) String() string

type CreateEngineMetadata added in v1.5.0 

type CreateEngineMetadata struct {

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

Metadata related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.

func (*CreateEngineMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateEngineMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateEngineMetadata) ProtoMessage added in v1.5.0 

func (*CreateEngineMetadata) ProtoMessage()

func (*CreateEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateEngineMetadata) Reset added in v1.5.0 

func (x *CreateEngineMetadata) Reset()

func (*CreateEngineMetadata) String added in v1.5.0 

func (x *CreateEngineMetadata) String() string

type CreateEngineRequest added in v1.5.0 

type CreateEngineRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Engine][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.

func (*CreateEngineRequest) GetEngine added in v1.5.0 

func (x *CreateEngineRequest) GetEngine() *Engine

func (*CreateEngineRequest) GetEngineId added in v1.5.0 

func (x *CreateEngineRequest) GetEngineId() string

func (*CreateEngineRequest) GetParent added in v1.5.0 

func (x *CreateEngineRequest) GetParent() string

func (*CreateEngineRequest) ProtoMessage added in v1.5.0 

func (*CreateEngineRequest) ProtoMessage()

func (*CreateEngineRequest) ProtoReflect added in v1.5.0 

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

func (*CreateEngineRequest) Reset added in v1.5.0 

func (x *CreateEngineRequest) Reset()

func (*CreateEngineRequest) String added in v1.5.0 

func (x *CreateEngineRequest) String() string

type CreateIdentityMappingStoreRequest added in v1.18.0 

type CreateIdentityMappingStoreRequest struct {

	// CMEK options for the Identity Mapping Store. Setting this field will
	// override the default CmekConfig if one is set for the project.
	//
	// Types that are assignable to CmekOptions:
	//
	//	*CreateIdentityMappingStoreRequest_CmekConfigName
	//	*CreateIdentityMappingStoreRequest_DisableCmek
	CmekOptions isCreateIdentityMappingStoreRequest_CmekOptions `protobuf_oneof:"cmek_options"`
	// Required. The parent collection resource name, such as
	// `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID of the Identity Mapping Store to create.
	//
	// The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
	// (_), and hyphens (-). The maximum length is 63 characters.
	IdentityMappingStoreId string `` /* 131-byte string literal not displayed */
	// Required. The Identity Mapping Store to create.
	IdentityMappingStore *IdentityMappingStore `protobuf:"bytes,3,opt,name=identity_mapping_store,json=identityMappingStore,proto3" json:"identity_mapping_store,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore]

func (*CreateIdentityMappingStoreRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use CreateIdentityMappingStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateIdentityMappingStoreRequest) GetCmekConfigName added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) GetCmekConfigName() string

func (*CreateIdentityMappingStoreRequest) GetCmekOptions added in v1.18.0 

func (m *CreateIdentityMappingStoreRequest) GetCmekOptions() isCreateIdentityMappingStoreRequest_CmekOptions

func (*CreateIdentityMappingStoreRequest) GetDisableCmek added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) GetDisableCmek() bool

func (*CreateIdentityMappingStoreRequest) GetIdentityMappingStore added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) GetIdentityMappingStore() *IdentityMappingStore

func (*CreateIdentityMappingStoreRequest) GetIdentityMappingStoreId added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) GetIdentityMappingStoreId() string

func (*CreateIdentityMappingStoreRequest) GetParent added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) GetParent() string

func (*CreateIdentityMappingStoreRequest) ProtoMessage added in v1.18.0 

func (*CreateIdentityMappingStoreRequest) ProtoMessage()

func (*CreateIdentityMappingStoreRequest) ProtoReflect added in v1.18.0 

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

func (*CreateIdentityMappingStoreRequest) Reset added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) Reset()

func (*CreateIdentityMappingStoreRequest) String added in v1.18.0 

func (x *CreateIdentityMappingStoreRequest) String() string

type CreateIdentityMappingStoreRequest_CmekConfigName added in v1.18.0 

type CreateIdentityMappingStoreRequest_CmekConfigName struct {
	// Resource name of the CmekConfig to use for protecting this Identity
	// Mapping Store.
	CmekConfigName string `protobuf:"bytes,5,opt,name=cmek_config_name,json=cmekConfigName,proto3,oneof"`
}

type CreateIdentityMappingStoreRequest_DisableCmek added in v1.18.0 

type CreateIdentityMappingStoreRequest_DisableCmek struct {
	// Identity Mapping Store without CMEK protections. If a default CmekConfig
	// is set for the project, setting this field will override the default
	// CmekConfig as well.
	DisableCmek bool `protobuf:"varint,6,opt,name=disable_cmek,json=disableCmek,proto3,oneof"`
}

type CreateSchemaMetadata 

type CreateSchemaMetadata struct {

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

Metadata for Create Schema LRO.

func (*CreateSchemaMetadata) Descriptor deprecated 

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

Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*CreateSchemaMetadata) GetCreateTime 

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

func (*CreateSchemaMetadata) GetUpdateTime 

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

func (*CreateSchemaMetadata) ProtoMessage 

func (*CreateSchemaMetadata) ProtoMessage()

func (*CreateSchemaMetadata) ProtoReflect 

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

func (*CreateSchemaMetadata) Reset 

func (x *CreateSchemaMetadata) Reset()

func (*CreateSchemaMetadata) String 

func (x *CreateSchemaMetadata) String() string

type CreateSchemaRequest 

type CreateSchemaRequest struct {

	// Required. The parent data store resource name, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Schema][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent 

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema 

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId 

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage 

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect 

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

func (*CreateSchemaRequest) Reset 

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String 

func (x *CreateSchemaRequest) String() string

type CreateSessionRequest added in v1.8.0 

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

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

Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.

func (*CreateSessionRequest) GetParent added in v1.8.0 

func (x *CreateSessionRequest) GetParent() string

func (*CreateSessionRequest) GetSession added in v1.8.0 

func (x *CreateSessionRequest) GetSession() *Session

func (*CreateSessionRequest) ProtoMessage added in v1.8.0 

func (*CreateSessionRequest) ProtoMessage()

func (*CreateSessionRequest) ProtoReflect added in v1.8.0 

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

func (*CreateSessionRequest) Reset added in v1.8.0 

func (x *CreateSessionRequest) Reset()

func (*CreateSessionRequest) String added in v1.8.0 

func (x *CreateSessionRequest) String() string

type CreateSitemapMetadata added in v1.17.0 

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

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

Deprecated: Use CreateSitemapMetadata.ProtoReflect.Descriptor instead.

func (*CreateSitemapMetadata) GetCreateTime added in v1.17.0 

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

func (*CreateSitemapMetadata) GetUpdateTime added in v1.17.0 

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

func (*CreateSitemapMetadata) ProtoMessage added in v1.17.0 

func (*CreateSitemapMetadata) ProtoMessage()

func (*CreateSitemapMetadata) ProtoReflect added in v1.17.0 

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

func (*CreateSitemapMetadata) Reset added in v1.17.0 

func (x *CreateSitemapMetadata) Reset()

func (*CreateSitemapMetadata) String added in v1.17.0 

func (x *CreateSitemapMetadata) String() string

type CreateSitemapRequest added in v1.17.0 

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

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

Deprecated: Use CreateSitemapRequest.ProtoReflect.Descriptor instead.

func (*CreateSitemapRequest) GetParent added in v1.17.0 

func (x *CreateSitemapRequest) GetParent() string

func (*CreateSitemapRequest) GetSitemap added in v1.17.0 

func (x *CreateSitemapRequest) GetSitemap() *Sitemap

func (*CreateSitemapRequest) ProtoMessage added in v1.17.0 

func (*CreateSitemapRequest) ProtoMessage()

func (*CreateSitemapRequest) ProtoReflect added in v1.17.0 

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

func (*CreateSitemapRequest) Reset added in v1.17.0 

func (x *CreateSitemapRequest) Reset()

func (*CreateSitemapRequest) String added in v1.17.0 

func (x *CreateSitemapRequest) String() string

type CreateTargetSiteMetadata added in v1.5.0 

type CreateTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*CreateTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*CreateTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*CreateTargetSiteMetadata) ProtoMessage()

func (*CreateTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*CreateTargetSiteMetadata) Reset added in v1.5.0 

func (x *CreateTargetSiteMetadata) Reset()

func (*CreateTargetSiteMetadata) String added in v1.5.0 

func (x *CreateTargetSiteMetadata) String() string

type CreateTargetSiteRequest added in v1.5.0 

type CreateTargetSiteRequest struct {

	// Required. Parent resource name of
	// [TargetSite][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteRequest) GetParent added in v1.5.0 

func (x *CreateTargetSiteRequest) GetParent() string

func (*CreateTargetSiteRequest) GetTargetSite added in v1.5.0 

func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSite

func (*CreateTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*CreateTargetSiteRequest) ProtoMessage()

func (*CreateTargetSiteRequest) ProtoReflect added in v1.5.0 

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

func (*CreateTargetSiteRequest) Reset added in v1.5.0 

func (x *CreateTargetSiteRequest) Reset()

func (*CreateTargetSiteRequest) String added in v1.5.0 

func (x *CreateTargetSiteRequest) String() string

type CustomAttribute 

type CustomAttribute struct {

	// The textual values of this custom attribute. For example, `["yellow",
	// "green"]` when the key is "color".
	//
	// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
	// returned.
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetNumbers 

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

func (*CustomAttribute) GetText 

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

func (*CustomAttribute) ProtoMessage 

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect 

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

func (*CustomAttribute) Reset 

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String 

func (x *CustomAttribute) String() string

type CustomTuningModel added in v1.14.0 

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 `` /* 158-byte string literal not displayed */
	// 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 `` /* 157-byte string literal not displayed */
	// 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 deprecated added in v1.14.0 

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

Deprecated: Use CustomTuningModel.ProtoReflect.Descriptor instead.

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

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

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

func (*CustomTuningModel) GetDisplayName added in v1.14.0 

func (x *CustomTuningModel) GetDisplayName() string

func (*CustomTuningModel) GetErrorMessage added in v1.15.0 

func (x *CustomTuningModel) GetErrorMessage() string

func (*CustomTuningModel) GetMetrics added in v1.14.0 

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

func (*CustomTuningModel) GetModelState added in v1.14.0 

func (x *CustomTuningModel) GetModelState() CustomTuningModel_ModelState

func (*CustomTuningModel) GetModelVersion added in v1.14.0 

func (x *CustomTuningModel) GetModelVersion() int64

func (*CustomTuningModel) GetName added in v1.14.0 

func (x *CustomTuningModel) GetName() string

func (*CustomTuningModel) GetTrainingStartTime added in v1.14.0 

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

func (*CustomTuningModel) ProtoMessage added in v1.14.0 

func (*CustomTuningModel) ProtoMessage()

func (*CustomTuningModel) ProtoReflect added in v1.14.0 

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

func (*CustomTuningModel) Reset added in v1.14.0 

func (x *CustomTuningModel) Reset()

func (*CustomTuningModel) String added in v1.14.0 

func (x *CustomTuningModel) String() string

type CustomTuningModel_ModelState added in v1.14.0 

type CustomTuningModel_ModelState int32

The state of the model. 

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

func (CustomTuningModel_ModelState) Descriptor added in v1.14.0 

func (CustomTuningModel_ModelState) Descriptor() protoreflect.EnumDescriptor

func (CustomTuningModel_ModelState) Enum added in v1.14.0 

func (x CustomTuningModel_ModelState) Enum() *CustomTuningModel_ModelState

func (CustomTuningModel_ModelState) EnumDescriptor deprecated added in v1.14.0 

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

Deprecated: Use CustomTuningModel_ModelState.Descriptor instead.

func (CustomTuningModel_ModelState) Number added in v1.14.0 

func (x CustomTuningModel_ModelState) Number() protoreflect.EnumNumber

func (CustomTuningModel_ModelState) String added in v1.14.0 

func (x CustomTuningModel_ModelState) String() string

func (CustomTuningModel_ModelState) Type added in v1.14.0 

func (CustomTuningModel_ModelState) Type() protoreflect.EnumType

type DataStore added in v1.5.0 

type DataStore struct {

	// Immutable. Identifier. 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 `` /* 164-byte string literal not displayed */
	// 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 `` /* 158-byte string literal not displayed */
	// 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 `` /* 162-byte string literal not displayed */
	// 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 `` /* 138-byte string literal not displayed */
	// Input only. The KMS key to be used to protect this DataStore at creation
	// time.
	//
	// Must be set for requests that need to comply with CMEK Org Policy
	// protections.
	//
	// If this field is set and processed successfully, the DataStore will be
	// protected by the KMS key, as indicated in the cmek_config field.
	KmsKeyName string `protobuf:"bytes,32,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// Output only. CMEK-related information for the DataStore.
	CmekConfig *CmekConfig `protobuf:"bytes,18,opt,name=cmek_config,json=cmekConfig,proto3" json:"cmek_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"`
	// Immutable. Whether data in the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] has ACL information.
	// If set to `true`, the source data must have ACL. ACL will be ingested when
	// data is ingested by
	// [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1.DocumentService.ImportDocuments]
	// methods.
	//
	// When ACL is enabled for the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore],
	// [Document][google.cloud.discoveryengine.v1.Document] can't be accessed by
	// calling
	// [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument]
	// or
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].
	//
	// Currently ACL is only supported in `GENERIC` industry vertical with
	// non-`PUBLIC_WEBSITE` content config.
	AclEnabled bool `protobuf:"varint,24,opt,name=acl_enabled,json=aclEnabled,proto3" json:"acl_enabled,omitempty"`
	// 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 `` /* 136-byte string literal not displayed */
	// 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"`
	// Optional. Configuration for `HEALTHCARE_FHIR` vertical.
	HealthcareFhirConfig *HealthcareFhirConfig `protobuf:"bytes,29,opt,name=healthcare_fhir_config,json=healthcareFhirConfig,proto3" json:"healthcare_fhir_config,omitempty"`
	// Immutable. The fully qualified resource name of the associated
	// [IdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStore].
	// This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
	// `GSUITE` IdP. Format:
	// `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
	IdentityMappingStore string `protobuf:"bytes,31,opt,name=identity_mapping_store,json=identityMappingStore,proto3" json:"identity_mapping_store,omitempty"`
	// contains filtered or unexported fields
}

DataStore captures global settings and configs at the DataStore level.

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

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

Deprecated: Use DataStore.ProtoReflect.Descriptor instead.

func (*DataStore) GetAclEnabled added in v1.18.0 

func (x *DataStore) GetAclEnabled() bool

func (*DataStore) GetAdvancedSiteSearchConfig added in v1.17.0 

func (x *DataStore) GetAdvancedSiteSearchConfig() *AdvancedSiteSearchConfig

func (*DataStore) GetBillingEstimation added in v1.15.0 

func (x *DataStore) GetBillingEstimation() *DataStore_BillingEstimation

func (*DataStore) GetCmekConfig added in v1.18.0 

func (x *DataStore) GetCmekConfig() *CmekConfig

func (*DataStore) GetContentConfig added in v1.5.0 

func (x *DataStore) GetContentConfig() DataStore_ContentConfig

func (*DataStore) GetCreateTime added in v1.5.0 

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

func (*DataStore) GetDefaultSchemaId added in v1.5.0 

func (x *DataStore) GetDefaultSchemaId() string

func (*DataStore) GetDisplayName added in v1.5.0 

func (x *DataStore) GetDisplayName() string

func (*DataStore) GetDocumentProcessingConfig added in v1.8.0 

func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*DataStore) GetHealthcareFhirConfig added in v1.18.0 

func (x *DataStore) GetHealthcareFhirConfig() *HealthcareFhirConfig

func (*DataStore) GetIdentityMappingStore added in v1.18.0 

func (x *DataStore) GetIdentityMappingStore() string

func (*DataStore) GetIndustryVertical added in v1.5.0 

func (x *DataStore) GetIndustryVertical() IndustryVertical

func (*DataStore) GetKmsKeyName added in v1.18.0 

func (x *DataStore) GetKmsKeyName() string

func (*DataStore) GetName added in v1.5.0 

func (x *DataStore) GetName() string

func (*DataStore) GetSolutionTypes added in v1.5.0 

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

func (*DataStore) GetStartingSchema added in v1.7.0 

func (x *DataStore) GetStartingSchema() *Schema

func (*DataStore) GetWorkspaceConfig added in v1.15.0 

func (x *DataStore) GetWorkspaceConfig() *WorkspaceConfig

func (*DataStore) ProtoMessage added in v1.5.0 

func (*DataStore) ProtoMessage()

func (*DataStore) ProtoReflect added in v1.5.0 

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

func (*DataStore) Reset added in v1.5.0 

func (x *DataStore) Reset()

func (*DataStore) String added in v1.5.0 

func (x *DataStore) String() string

type DataStoreServiceClient added in v1.5.0 

type DataStoreServiceClient interface {
	// Creates a [DataStore][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDataStoreServiceClient added in v1.5.0 

func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClient

type DataStoreServiceServer added in v1.5.0 

type DataStoreServiceServer interface {
	// Creates a [DataStore][google.cloud.discoveryengine.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. All implementations should embed UnimplementedDataStoreServiceServer for forward compatibility

type DataStore_BillingEstimation added in v1.15.0 

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 `` /* 137-byte string literal not displayed */
	// Last updated timestamp for unstructured data.
	UnstructuredDataUpdateTime *timestamppb.Timestamp `` /* 143-byte string literal not displayed */
	// Last updated timestamp for websites.
	WebsiteDataUpdateTime *timestamppb.Timestamp `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Estimation of data size per data store.

func (*DataStore_BillingEstimation) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use DataStore_BillingEstimation.ProtoReflect.Descriptor instead.

func (*DataStore_BillingEstimation) GetStructuredDataSize added in v1.15.0 

func (x *DataStore_BillingEstimation) GetStructuredDataSize() int64

func (*DataStore_BillingEstimation) GetStructuredDataUpdateTime added in v1.15.0 

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

func (*DataStore_BillingEstimation) GetUnstructuredDataSize added in v1.15.0 

func (x *DataStore_BillingEstimation) GetUnstructuredDataSize() int64

func (*DataStore_BillingEstimation) GetUnstructuredDataUpdateTime added in v1.15.0 

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

func (*DataStore_BillingEstimation) GetWebsiteDataSize added in v1.15.0 

func (x *DataStore_BillingEstimation) GetWebsiteDataSize() int64

func (*DataStore_BillingEstimation) GetWebsiteDataUpdateTime added in v1.15.0 

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

func (*DataStore_BillingEstimation) ProtoMessage added in v1.15.0 

func (*DataStore_BillingEstimation) ProtoMessage()

func (*DataStore_BillingEstimation) ProtoReflect added in v1.15.0 

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

func (*DataStore_BillingEstimation) Reset added in v1.15.0 

func (x *DataStore_BillingEstimation) Reset()

func (*DataStore_BillingEstimation) String added in v1.15.0 

func (x *DataStore_BillingEstimation) String() string

type DataStore_ContentConfig added in v1.5.0 

type DataStore_ContentConfig int32

Content config of the data store. 

const (
	// Default value.
	DataStore_CONTENT_CONFIG_UNSPECIFIED DataStore_ContentConfig = 0
	// Only contains documents without any
	// [Document.content][google.cloud.discoveryengine.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 added in v1.5.0 

func (DataStore_ContentConfig) Descriptor() protoreflect.EnumDescriptor

func (DataStore_ContentConfig) Enum added in v1.5.0 

func (x DataStore_ContentConfig) Enum() *DataStore_ContentConfig

func (DataStore_ContentConfig) EnumDescriptor deprecated added in v1.5.0 

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

Deprecated: Use DataStore_ContentConfig.Descriptor instead.

func (DataStore_ContentConfig) Number added in v1.5.0 

func (x DataStore_ContentConfig) Number() protoreflect.EnumNumber

func (DataStore_ContentConfig) String added in v1.5.0 

func (x DataStore_ContentConfig) String() string

func (DataStore_ContentConfig) Type added in v1.5.0 

func (DataStore_ContentConfig) Type() protoreflect.EnumType

type DeleteCmekConfigMetadata added in v1.18.0 

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

func (*DeleteCmekConfigMetadata) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use DeleteCmekConfigMetadata.ProtoReflect.Descriptor instead.

func (*DeleteCmekConfigMetadata) GetCreateTime added in v1.18.0 

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

func (*DeleteCmekConfigMetadata) GetUpdateTime added in v1.18.0 

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

func (*DeleteCmekConfigMetadata) ProtoMessage added in v1.18.0 

func (*DeleteCmekConfigMetadata) ProtoMessage()

func (*DeleteCmekConfigMetadata) ProtoReflect added in v1.18.0 

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

func (*DeleteCmekConfigMetadata) Reset added in v1.18.0 

func (x *DeleteCmekConfigMetadata) Reset()

func (*DeleteCmekConfigMetadata) String added in v1.18.0 

func (x *DeleteCmekConfigMetadata) String() string

type DeleteCmekConfigRequest added in v1.18.0 

type DeleteCmekConfigRequest struct {

	// Required. The resource name of the
	// [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] to delete, such as
	// `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] method.

func (*DeleteCmekConfigRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use DeleteCmekConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteCmekConfigRequest) GetName added in v1.18.0 

func (x *DeleteCmekConfigRequest) GetName() string

func (*DeleteCmekConfigRequest) ProtoMessage added in v1.18.0 

func (*DeleteCmekConfigRequest) ProtoMessage()

func (*DeleteCmekConfigRequest) ProtoReflect added in v1.18.0 

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

func (*DeleteCmekConfigRequest) Reset added in v1.18.0 

func (x *DeleteCmekConfigRequest) Reset()

func (*DeleteCmekConfigRequest) String added in v1.18.0 

func (x *DeleteCmekConfigRequest) String() string

type DeleteControlRequest added in v1.8.0 

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

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

Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.

func (*DeleteControlRequest) GetName added in v1.8.0 

func (x *DeleteControlRequest) GetName() string

func (*DeleteControlRequest) ProtoMessage added in v1.8.0 

func (*DeleteControlRequest) ProtoMessage()

func (*DeleteControlRequest) ProtoReflect added in v1.8.0 

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

func (*DeleteControlRequest) Reset added in v1.8.0 

func (x *DeleteControlRequest) Reset()

func (*DeleteControlRequest) String added in v1.8.0 

func (x *DeleteControlRequest) String() string

type DeleteConversationRequest added in v1.2.0 

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

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

Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.

func (*DeleteConversationRequest) GetName added in v1.2.0 

func (x *DeleteConversationRequest) GetName() string

func (*DeleteConversationRequest) ProtoMessage added in v1.2.0 

func (*DeleteConversationRequest) ProtoMessage()

func (*DeleteConversationRequest) ProtoReflect added in v1.2.0 

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

func (*DeleteConversationRequest) Reset added in v1.2.0 

func (x *DeleteConversationRequest) Reset()

func (*DeleteConversationRequest) String added in v1.2.0 

func (x *DeleteConversationRequest) String() string

type DeleteDataStoreMetadata added in v1.5.0 

type DeleteDataStoreMetadata struct {

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

Metadata related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteDataStoreMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteDataStoreMetadata) ProtoMessage added in v1.5.0 

func (*DeleteDataStoreMetadata) ProtoMessage()

func (*DeleteDataStoreMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteDataStoreMetadata) Reset added in v1.5.0 

func (x *DeleteDataStoreMetadata) Reset()

func (*DeleteDataStoreMetadata) String added in v1.5.0 

func (x *DeleteDataStoreMetadata) String() string

type DeleteDataStoreRequest added in v1.5.0 

type DeleteDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreRequest) GetName added in v1.5.0 

func (x *DeleteDataStoreRequest) GetName() string

func (*DeleteDataStoreRequest) ProtoMessage added in v1.5.0 

func (*DeleteDataStoreRequest) ProtoMessage()

func (*DeleteDataStoreRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteDataStoreRequest) Reset added in v1.5.0 

func (x *DeleteDataStoreRequest) Reset()

func (*DeleteDataStoreRequest) String added in v1.5.0 

func (x *DeleteDataStoreRequest) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetName 

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

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

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteEngineMetadata added in v1.5.0 

type DeleteEngineMetadata struct {

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

Metadata related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.

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

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

Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.

func (*DeleteEngineMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteEngineMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteEngineMetadata) ProtoMessage added in v1.5.0 

func (*DeleteEngineMetadata) ProtoMessage()

func (*DeleteEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteEngineMetadata) Reset added in v1.5.0 

func (x *DeleteEngineMetadata) Reset()

func (*DeleteEngineMetadata) String added in v1.5.0 

func (x *DeleteEngineMetadata) String() string

type DeleteEngineRequest added in v1.5.0 

type DeleteEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.

func (*DeleteEngineRequest) GetName added in v1.5.0 

func (x *DeleteEngineRequest) GetName() string

func (*DeleteEngineRequest) ProtoMessage added in v1.5.0 

func (*DeleteEngineRequest) ProtoMessage()

func (*DeleteEngineRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteEngineRequest) Reset added in v1.5.0 

func (x *DeleteEngineRequest) Reset()

func (*DeleteEngineRequest) String added in v1.5.0 

func (x *DeleteEngineRequest) String() string

type DeleteIdentityMappingStoreMetadata added in v1.18.0 

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

func (*DeleteIdentityMappingStoreMetadata) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use DeleteIdentityMappingStoreMetadata.ProtoReflect.Descriptor instead.

func (*DeleteIdentityMappingStoreMetadata) GetCreateTime added in v1.18.0 

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

func (*DeleteIdentityMappingStoreMetadata) GetUpdateTime added in v1.18.0 

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

func (*DeleteIdentityMappingStoreMetadata) ProtoMessage added in v1.18.0 

func (*DeleteIdentityMappingStoreMetadata) ProtoMessage()

func (*DeleteIdentityMappingStoreMetadata) ProtoReflect added in v1.18.0 

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

func (*DeleteIdentityMappingStoreMetadata) Reset added in v1.18.0 

func (x *DeleteIdentityMappingStoreMetadata) Reset()

func (*DeleteIdentityMappingStoreMetadata) String added in v1.18.0 

func (x *DeleteIdentityMappingStoreMetadata) String() string

type DeleteIdentityMappingStoreRequest added in v1.18.0 

type DeleteIdentityMappingStoreRequest struct {

	// Required. The name of the Identity Mapping Store to delete.
	// Format:
	// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore]

func (*DeleteIdentityMappingStoreRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use DeleteIdentityMappingStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteIdentityMappingStoreRequest) GetName added in v1.18.0 

func (x *DeleteIdentityMappingStoreRequest) GetName() string

func (*DeleteIdentityMappingStoreRequest) ProtoMessage added in v1.18.0 

func (*DeleteIdentityMappingStoreRequest) ProtoMessage()

func (*DeleteIdentityMappingStoreRequest) ProtoReflect added in v1.18.0 

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

func (*DeleteIdentityMappingStoreRequest) Reset added in v1.18.0 

func (x *DeleteIdentityMappingStoreRequest) Reset()

func (*DeleteIdentityMappingStoreRequest) String added in v1.18.0 

func (x *DeleteIdentityMappingStoreRequest) String() string

type DeleteSchemaMetadata 

type DeleteSchemaMetadata struct {

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

Metadata for DeleteSchema LRO.

func (*DeleteSchemaMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSchemaMetadata) GetCreateTime 

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

func (*DeleteSchemaMetadata) GetUpdateTime 

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

func (*DeleteSchemaMetadata) ProtoMessage 

func (*DeleteSchemaMetadata) ProtoMessage()

func (*DeleteSchemaMetadata) ProtoReflect 

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

func (*DeleteSchemaMetadata) Reset 

func (x *DeleteSchemaMetadata) Reset()

func (*DeleteSchemaMetadata) String 

func (x *DeleteSchemaMetadata) String() string

type DeleteSchemaRequest 

type DeleteSchemaRequest struct {

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

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

func (*DeleteSchemaRequest) Descriptor deprecated 

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

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName 

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage 

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect 

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

func (*DeleteSchemaRequest) Reset 

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String 

func (x *DeleteSchemaRequest) String() string

type DeleteSessionRequest added in v1.8.0 

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

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

Deprecated: Use DeleteSessionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSessionRequest) GetName added in v1.8.0 

func (x *DeleteSessionRequest) GetName() string

func (*DeleteSessionRequest) ProtoMessage added in v1.8.0 

func (*DeleteSessionRequest) ProtoMessage()

func (*DeleteSessionRequest) ProtoReflect added in v1.8.0 

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

func (*DeleteSessionRequest) Reset added in v1.8.0 

func (x *DeleteSessionRequest) Reset()

func (*DeleteSessionRequest) String added in v1.8.0 

func (x *DeleteSessionRequest) String() string

type DeleteSitemapMetadata added in v1.17.0 

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

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

Deprecated: Use DeleteSitemapMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSitemapMetadata) GetCreateTime added in v1.17.0 

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

func (*DeleteSitemapMetadata) GetUpdateTime added in v1.17.0 

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

func (*DeleteSitemapMetadata) ProtoMessage added in v1.17.0 

func (*DeleteSitemapMetadata) ProtoMessage()

func (*DeleteSitemapMetadata) ProtoReflect added in v1.17.0 

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

func (*DeleteSitemapMetadata) Reset added in v1.17.0 

func (x *DeleteSitemapMetadata) Reset()

func (*DeleteSitemapMetadata) String added in v1.17.0 

func (x *DeleteSitemapMetadata) String() string

type DeleteSitemapRequest added in v1.17.0 

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

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

Deprecated: Use DeleteSitemapRequest.ProtoReflect.Descriptor instead.

func (*DeleteSitemapRequest) GetName added in v1.17.0 

func (x *DeleteSitemapRequest) GetName() string

func (*DeleteSitemapRequest) ProtoMessage added in v1.17.0 

func (*DeleteSitemapRequest) ProtoMessage()

func (*DeleteSitemapRequest) ProtoReflect added in v1.17.0 

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

func (*DeleteSitemapRequest) Reset added in v1.17.0 

func (x *DeleteSitemapRequest) Reset()

func (*DeleteSitemapRequest) String added in v1.17.0 

func (x *DeleteSitemapRequest) String() string

type DeleteTargetSiteMetadata added in v1.5.0 

type DeleteTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteMetadata) GetCreateTime added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) GetUpdateTime added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) ProtoMessage added in v1.5.0 

func (*DeleteTargetSiteMetadata) ProtoMessage()

func (*DeleteTargetSiteMetadata) ProtoReflect added in v1.5.0 

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

func (*DeleteTargetSiteMetadata) Reset added in v1.5.0 

func (x *DeleteTargetSiteMetadata) Reset()

func (*DeleteTargetSiteMetadata) String added in v1.5.0 

func (x *DeleteTargetSiteMetadata) String() string

type DeleteTargetSiteRequest added in v1.5.0 

type DeleteTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteRequest) GetName added in v1.5.0 

func (x *DeleteTargetSiteRequest) GetName() string

func (*DeleteTargetSiteRequest) ProtoMessage added in v1.5.0 

func (*DeleteTargetSiteRequest) ProtoMessage()

func (*DeleteTargetSiteRequest) ProtoReflect added in v1.5.0 

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

func (*DeleteTargetSiteRequest) Reset added in v1.5.0 

func (x *DeleteTargetSiteRequest) Reset()

func (*DeleteTargetSiteRequest) String added in v1.5.0 

func (x *DeleteTargetSiteRequest) String() string

type DisableAdvancedSiteSearchMetadata added in v1.5.0 

type DisableAdvancedSiteSearchMetadata struct {

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchMetadata) GetCreateTime added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()

func (*DisableAdvancedSiteSearchMetadata) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchMetadata) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchMetadata) Reset()

func (*DisableAdvancedSiteSearchMetadata) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchMetadata) String() string

type DisableAdvancedSiteSearchRequest added in v1.5.0 

type DisableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*DisableAdvancedSiteSearchRequest) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchRequest) ProtoMessage()

func (*DisableAdvancedSiteSearchRequest) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchRequest) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) Reset()

func (*DisableAdvancedSiteSearchRequest) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchRequest) String() string

type DisableAdvancedSiteSearchResponse added in v1.5.0 

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchResponse) ProtoMessage added in v1.5.0 

func (*DisableAdvancedSiteSearchResponse) ProtoMessage()

func (*DisableAdvancedSiteSearchResponse) ProtoReflect added in v1.5.0 

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

func (*DisableAdvancedSiteSearchResponse) Reset added in v1.5.0 

func (x *DisableAdvancedSiteSearchResponse) Reset()

func (*DisableAdvancedSiteSearchResponse) String added in v1.5.0 

func (x *DisableAdvancedSiteSearchResponse) String() string

type Document 

type Document struct {

	// Data representation. One of
	// [struct_data][google.cloud.discoveryengine.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 can only be set
	// and must be set if this document is under a `CONTENT_REQUIRED` data store.
	Content *Document_Content `protobuf:"bytes,10,opt,name=content,proto3" json:"content,omitempty"`
	// The identifier of the parent document. Currently supports at most two level
	// document hierarchy.
	//
	// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters.
	ParentDocumentId string `protobuf:"bytes,7,opt,name=parent_document_id,json=parentDocumentId,proto3" json:"parent_document_id,omitempty"`
	// Output only. This field is OUTPUT_ONLY.
	// It contains derived data that are not in the original input document.
	DerivedStructData *structpb.Struct `protobuf:"bytes,6,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
	// Access control information for the document.
	AclInfo *Document_AclInfo `protobuf:"bytes,11,opt,name=acl_info,json=aclInfo,proto3" json:"acl_info,omitempty"`
	// Output only. The last time the document was indexed. If this field is set,
	// the document could be returned in search results.
	//
	// This field is OUTPUT_ONLY. If this field is not populated, it means the
	// document has never been indexed.
	IndexTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
	// 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 deprecated 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetAclInfo added in v1.18.0 

func (x *Document) GetAclInfo() *Document_AclInfo

func (*Document) GetContent 

func (x *Document) GetContent() *Document_Content

func (*Document) GetData 

func (m *Document) GetData() isDocument_Data

func (*Document) GetDerivedStructData 

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

func (*Document) GetId 

func (x *Document) GetId() string

func (*Document) GetIndexStatus added in v1.14.0 

func (x *Document) GetIndexStatus() *Document_IndexStatus

func (*Document) GetIndexTime added in v1.7.0 

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

func (*Document) GetJsonData 

func (x *Document) GetJsonData() string

func (*Document) GetName 

func (x *Document) GetName() string

func (*Document) GetParentDocumentId 

func (x *Document) GetParentDocumentId() string

func (*Document) GetSchemaId 

func (x *Document) GetSchemaId() string

func (*Document) GetStructData 

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

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

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

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type DocumentInfo 

type DocumentInfo struct {

	// A required descriptor of the associated
	// [Document][google.cloud.discoveryengine.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 deprecated 

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

Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.

func (*DocumentInfo) GetConversionValue added in v1.17.0 

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

func (x *DocumentInfo) GetJoined() bool

func (*DocumentInfo) GetName 

func (x *DocumentInfo) GetName() string

func (*DocumentInfo) GetPromotionIds 

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

func (*DocumentInfo) GetQuantity 

func (x *DocumentInfo) GetQuantity() int32

func (*DocumentInfo) GetUri added in v1.2.0 

func (x *DocumentInfo) GetUri() string

func (*DocumentInfo) ProtoMessage 

func (*DocumentInfo) ProtoMessage()

func (*DocumentInfo) ProtoReflect 

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

func (*DocumentInfo) Reset 

func (x *DocumentInfo) Reset()

func (*DocumentInfo) String 

func (x *DocumentInfo) String() string

type DocumentInfo_Id 

type DocumentInfo_Id struct {
	// The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type DocumentInfo_Name 

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

type DocumentInfo_Uri added in v1.2.0 

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

type DocumentProcessingConfig added in v1.8.0 

type DocumentProcessingConfig struct {

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

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

Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig) GetChunkingConfig added in v1.9.0 

func (x *DocumentProcessingConfig) GetChunkingConfig() *DocumentProcessingConfig_ChunkingConfig

func (*DocumentProcessingConfig) GetDefaultParsingConfig added in v1.8.0 

func (x *DocumentProcessingConfig) GetDefaultParsingConfig() *DocumentProcessingConfig_ParsingConfig

func (*DocumentProcessingConfig) GetName added in v1.8.0 

func (x *DocumentProcessingConfig) GetName() string

func (*DocumentProcessingConfig) GetParsingConfigOverrides added in v1.8.0 

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

func (*DocumentProcessingConfig) ProtoMessage added in v1.8.0 

func (*DocumentProcessingConfig) ProtoMessage()

func (*DocumentProcessingConfig) ProtoReflect added in v1.8.0 

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

func (*DocumentProcessingConfig) Reset added in v1.8.0 

func (x *DocumentProcessingConfig) Reset()

func (*DocumentProcessingConfig) String added in v1.8.0 

func (x *DocumentProcessingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig added in v1.9.0 

type DocumentProcessingConfig_ChunkingConfig struct {

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

Configuration for chunking config.

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

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode added in v1.9.0 

func (m *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkMode

func (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig() *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage added in v1.9.0 

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect added in v1.9.0 

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

func (*DocumentProcessingConfig_ChunkingConfig) Reset added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig) String added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig added in v1.9.0 

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {

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

Configuration for the layout based chunking.

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

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize() int32

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings() bool

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage added in v1.9.0 

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect added in v1.9.0 

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String added in v1.9.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ added in v1.9.0 

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

type DocumentProcessingConfig_ParsingConfig added in v1.8.0 

type DocumentProcessingConfig_ParsingConfig struct {

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

Related configurations applied to a specific type of document parser.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig added in v1.9.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig() *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig added in v1.8.0 

func (m *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage added in v1.8.0 

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect added in v1.8.0 

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

func (*DocumentProcessingConfig_ParsingConfig) Reset added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig) String added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig added in v1.8.0 

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

The digital parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage added in v1.8.0 

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect added in v1.8.0 

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

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_ added in v1.8.0 

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

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig added in v1.9.0 

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig struct {

	// Optional. If true, the LLM based annotation is added to the table
	// during parsing.
	EnableTableAnnotation bool `` /* 127-byte string literal not displayed */
	// Optional. If true, the LLM based annotation is added to the image
	// during parsing.
	EnableImageAnnotation bool `` /* 127-byte string literal not displayed */
	// Optional. Contains the required structure types to extract from the
	// document. Supported values:
	//
	// * `shareholder-structure`
	StructuredContentTypes []string `` /* 129-byte string literal not displayed */
	// Optional. List of HTML elements to exclude from the parsed content.
	ExcludeHtmlElements []string `protobuf:"bytes,10,rep,name=exclude_html_elements,json=excludeHtmlElements,proto3" json:"exclude_html_elements,omitempty"`
	// Optional. List of HTML classes to exclude from the parsed content.
	ExcludeHtmlClasses []string `protobuf:"bytes,11,rep,name=exclude_html_classes,json=excludeHtmlClasses,proto3" json:"exclude_html_classes,omitempty"`
	// Optional. List of HTML ids to exclude from the parsed content.
	ExcludeHtmlIds []string `protobuf:"bytes,12,rep,name=exclude_html_ids,json=excludeHtmlIds,proto3" json:"exclude_html_ids,omitempty"`
	// contains filtered or unexported fields
}

The layout parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableImageAnnotation added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableImageAnnotation() bool

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableTableAnnotation added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableTableAnnotation() bool

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlClasses added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlClasses() []string

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlElements added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlElements() []string

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlIds added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlIds() []string

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetStructuredContentTypes added in v1.18.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetStructuredContentTypes() []string

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage added in v1.9.0 

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect added in v1.9.0 

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

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset added in v1.9.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String added in v1.9.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ added in v1.9.0 

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

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig added in v1.8.0 

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {

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

The OCR parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.

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

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

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText() bool

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage added in v1.8.0 

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect added in v1.8.0 

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String added in v1.8.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_ added in v1.8.0 

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

type DocumentServiceClient 

type DocumentServiceClient interface {
	// Gets a [Document][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDocumentServiceClient 

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

type 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. All implementations should embed UnimplementedDocumentServiceServer for forward compatibility

type Document_AclInfo added in v1.18.0 

type Document_AclInfo struct {

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

ACL Information of the Document.

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

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

Deprecated: Use Document_AclInfo.ProtoReflect.Descriptor instead.

func (*Document_AclInfo) GetReaders added in v1.18.0 

func (x *Document_AclInfo) GetReaders() []*Document_AclInfo_AccessRestriction

func (*Document_AclInfo) ProtoMessage added in v1.18.0 

func (*Document_AclInfo) ProtoMessage()

func (*Document_AclInfo) ProtoReflect added in v1.18.0 

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

func (*Document_AclInfo) Reset added in v1.18.0 

func (x *Document_AclInfo) Reset()

func (*Document_AclInfo) String added in v1.18.0 

func (x *Document_AclInfo) String() string

type Document_AclInfo_AccessRestriction added in v1.18.0 

type Document_AclInfo_AccessRestriction struct {

	// List of principals.
	Principals []*Principal `protobuf:"bytes,1,rep,name=principals,proto3" json:"principals,omitempty"`
	// All users within the Identity Provider.
	IdpWide bool `protobuf:"varint,2,opt,name=idp_wide,json=idpWide,proto3" json:"idp_wide,omitempty"`
	// contains filtered or unexported fields
}

AclRestriction to model complex inheritance restrictions.

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

Document Hierarchy - Space_S --> Page_P.

Readers: 

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

Space_S ACL Restriction - 

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

Page_P ACL Restriction. 

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

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

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

Deprecated: Use Document_AclInfo_AccessRestriction.ProtoReflect.Descriptor instead.

func (*Document_AclInfo_AccessRestriction) GetIdpWide added in v1.18.0 

func (x *Document_AclInfo_AccessRestriction) GetIdpWide() bool

func (*Document_AclInfo_AccessRestriction) GetPrincipals added in v1.18.0 

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

func (*Document_AclInfo_AccessRestriction) ProtoMessage added in v1.18.0 

func (*Document_AclInfo_AccessRestriction) ProtoMessage()

func (*Document_AclInfo_AccessRestriction) ProtoReflect added in v1.18.0 

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

func (*Document_AclInfo_AccessRestriction) Reset added in v1.18.0 

func (x *Document_AclInfo_AccessRestriction) Reset()

func (*Document_AclInfo_AccessRestriction) String added in v1.18.0 

func (x *Document_AclInfo_AccessRestriction) String() string

type Document_Content 

type Document_Content struct {

	// The content of the unstructured document.
	//
	// 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)
	// * `text/plain` (TXT)
	// * `application/xml` or `text/xml` (XML)
	// * `application/json` (JSON)
	// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
	// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
	// * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
	// (XLSX)
	// * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM)
	//
	// The following types are supported only if layout parser is enabled in the
	// data store:
	//
	// * `image/bmp` (BMP)
	// * `image/gif` (GIF)
	// * `image/jpeg` (JPEG)
	// * `image/png` (PNG)
	// * `image/tiff` (TIFF)
	//
	// See https://www.iana.org/assignments/media-types/media-types.xhtml.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

Unstructured data linked to this document.

func (*Document_Content) Descriptor deprecated 

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

Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.

func (*Document_Content) GetContent 

func (m *Document_Content) GetContent() isDocument_Content_Content

func (*Document_Content) GetMimeType 

func (x *Document_Content) GetMimeType() string

func (*Document_Content) GetRawBytes 

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

func (*Document_Content) GetUri 

func (x *Document_Content) GetUri() string

func (*Document_Content) ProtoMessage 

func (*Document_Content) ProtoMessage()

func (*Document_Content) ProtoReflect 

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

func (*Document_Content) Reset 

func (x *Document_Content) Reset()

func (*Document_Content) String 

func (x *Document_Content) String() string

type Document_Content_RawBytes 

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

type Document_Content_Uri 

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

type Document_IndexStatus added in v1.14.0 

type Document_IndexStatus struct {

	// The time when the document was indexed.
	// If this field is populated, it means the document has been indexed.
	IndexTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
	// A sample of errors encountered while indexing the document.
	// If this field is populated, the document is not indexed due to errors.
	ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// 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 deprecated added in v1.14.0 

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

Deprecated: Use Document_IndexStatus.ProtoReflect.Descriptor instead.

func (*Document_IndexStatus) GetErrorSamples added in v1.14.0 

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

func (*Document_IndexStatus) GetIndexTime added in v1.14.0 

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

func (*Document_IndexStatus) GetPendingMessage added in v1.17.0 

func (x *Document_IndexStatus) GetPendingMessage() string

func (*Document_IndexStatus) ProtoMessage added in v1.14.0 

func (*Document_IndexStatus) ProtoMessage()

func (*Document_IndexStatus) ProtoReflect added in v1.14.0 

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

func (*Document_IndexStatus) Reset added in v1.14.0 

func (x *Document_IndexStatus) Reset()

func (*Document_IndexStatus) String added in v1.14.0 

func (x *Document_IndexStatus) String() string

type Document_JsonData 

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

type Document_StructData 

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

type DoubleList added in v1.17.0 

type DoubleList struct {

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

Double list.

func (*DoubleList) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.

func (*DoubleList) GetValues added in v1.17.0 

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

func (*DoubleList) ProtoMessage added in v1.17.0 

func (*DoubleList) ProtoMessage()

func (*DoubleList) ProtoReflect added in v1.17.0 

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

func (*DoubleList) Reset added in v1.17.0 

func (x *DoubleList) Reset()

func (*DoubleList) String added in v1.17.0 

func (x *DoubleList) String() string

type EnableAdvancedSiteSearchMetadata added in v1.5.0 

type EnableAdvancedSiteSearchMetadata struct {

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchMetadata) GetCreateTime added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()

func (*EnableAdvancedSiteSearchMetadata) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchMetadata) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchMetadata) Reset()

func (*EnableAdvancedSiteSearchMetadata) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchMetadata) String() string

type EnableAdvancedSiteSearchRequest added in v1.5.0 

type EnableAdvancedSiteSearchRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.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 deprecated added in v1.5.0 

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

Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*EnableAdvancedSiteSearchRequest) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchRequest) ProtoMessage()

func (*EnableAdvancedSiteSearchRequest) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchRequest) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) Reset()

func (*EnableAdvancedSiteSearchRequest) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchRequest) String() string

type EnableAdvancedSiteSearchResponse added in v1.5.0 

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchResponse) ProtoMessage added in v1.5.0 

func (*EnableAdvancedSiteSearchResponse) ProtoMessage()

func (*EnableAdvancedSiteSearchResponse) ProtoReflect added in v1.5.0 

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

func (*EnableAdvancedSiteSearchResponse) Reset added in v1.5.0 

func (x *EnableAdvancedSiteSearchResponse) Reset()

func (*EnableAdvancedSiteSearchResponse) String added in v1.5.0 

func (x *EnableAdvancedSiteSearchResponse) String() string

type Engine added in v1.5.0 

type Engine struct {

	// Additional config specs that defines the behavior of the engine.
	//
	// Types that are assignable to EngineConfig:
	//
	//	*Engine_ChatEngineConfig_
	//	*Engine_SearchEngineConfig_
	//	*Engine_MediaRecommendationEngineConfig_
	EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
	// Engine metadata to monitor the status of the engine.
	//
	// Types that are assignable to EngineMetadata:
	//
	//	*Engine_ChatEngineMetadata_
	EngineMetadata isEngine_EngineMetadata `protobuf_oneof:"engine_metadata"`
	// Immutable. Identifier. 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"`
	// Optional. 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 `` /* 148-byte string literal not displayed */
	// Optional. 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 `` /* 165-byte string literal not displayed */
	// Common config spec that specifies the metadata of the engine.
	CommonConfig *Engine_CommonConfig `protobuf:"bytes,15,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// 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 deprecated added in v1.5.0 

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

Deprecated: Use Engine.ProtoReflect.Descriptor instead.

func (*Engine) GetChatEngineConfig added in v1.5.0 

func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig

func (*Engine) GetChatEngineMetadata added in v1.5.0 

func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata

func (*Engine) GetCommonConfig added in v1.5.0 

func (x *Engine) GetCommonConfig() *Engine_CommonConfig

func (*Engine) GetCreateTime added in v1.5.0 

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

func (*Engine) GetDataStoreIds added in v1.5.0 

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

func (*Engine) GetDisableAnalytics added in v1.15.0 

func (x *Engine) GetDisableAnalytics() bool

func (*Engine) GetDisplayName added in v1.5.0 

func (x *Engine) GetDisplayName() string

func (*Engine) GetEngineConfig added in v1.5.0 

func (m *Engine) GetEngineConfig() isEngine_EngineConfig

func (*Engine) GetEngineMetadata added in v1.5.0 

func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata

func (*Engine) GetIndustryVertical added in v1.5.0 

func (x *Engine) GetIndustryVertical() IndustryVertical

func (*Engine) GetMediaRecommendationEngineConfig added in v1.18.0 

func (x *Engine) GetMediaRecommendationEngineConfig() *Engine_MediaRecommendationEngineConfig

func (*Engine) GetName added in v1.5.0 

func (x *Engine) GetName() string

func (*Engine) GetSearchEngineConfig added in v1.5.0 

func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfig

func (*Engine) GetSolutionType added in v1.5.0 

func (x *Engine) GetSolutionType() SolutionType

func (*Engine) GetUpdateTime added in v1.5.0 

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

func (*Engine) ProtoMessage added in v1.5.0 

func (*Engine) ProtoMessage()

func (*Engine) ProtoReflect added in v1.5.0 

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

func (*Engine) Reset added in v1.5.0 

func (x *Engine) Reset()

func (*Engine) String added in v1.5.0 

func (x *Engine) String() string

type EngineServiceClient added in v1.5.0 

type EngineServiceClient interface {
	// Creates a [Engine][google.cloud.discoveryengine.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEngineServiceClient added in v1.5.0 

func NewEngineServiceClient(cc grpc.ClientConnInterface) EngineServiceClient

type EngineServiceServer added in v1.5.0 

type EngineServiceServer interface {
	// Creates a [Engine][google.cloud.discoveryengine.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. All implementations should embed UnimplementedEngineServiceServer for forward compatibility

type Engine_ChatEngineConfig added in v1.5.0 

type Engine_ChatEngineConfig struct {

	// The configurationt generate the Dialogflow agent that is associated to
	// this Engine.
	//
	// Note that these configurations are one-time consumed by
	// and passed to Dialogflow service. It means they cannot be retrieved using
	// [EngineService.GetEngine][google.cloud.discoveryengine.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/<Project ID>/locations/<Location ID>/agents/<Agent
	// ID>`.
	//
	// Note that the `dialogflow_agent_to_link` are one-time consumed by and
	// passed to Dialogflow service. It means they cannot be retrieved using
	// [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
	// or
	// [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
	// API after engine creation. Use
	// [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent]
	// for actual agent association after Engine is created.
	DialogflowAgentToLink string `` /* 128-byte string literal not displayed */
	// Optional. If the flag set to true, we allow the agent and engine are in
	// different locations, otherwise the agent and engine are required to be in
	// the same location. The flag is set to false by default.
	//
	// Note that the `allow_cross_region` are one-time consumed by and
	// passed to
	// [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine].
	// 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.
	AllowCrossRegion bool `protobuf:"varint,3,opt,name=allow_cross_region,json=allowCrossRegion,proto3" json:"allow_cross_region,omitempty"`
	// contains filtered or unexported fields
}

Configurations for a Chat Engine.

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

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

Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig) GetAgentCreationConfig added in v1.5.0 

func (x *Engine_ChatEngineConfig) GetAgentCreationConfig() *Engine_ChatEngineConfig_AgentCreationConfig

func (*Engine_ChatEngineConfig) GetAllowCrossRegion added in v1.17.0 

func (x *Engine_ChatEngineConfig) GetAllowCrossRegion() bool
func (x *Engine_ChatEngineConfig) GetDialogflowAgentToLink() string

func (*Engine_ChatEngineConfig) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineConfig) ProtoMessage()

func (*Engine_ChatEngineConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineConfig) Reset added in v1.5.0 

func (x *Engine_ChatEngineConfig) Reset()

func (*Engine_ChatEngineConfig) String added in v1.5.0 

func (x *Engine_ChatEngineConfig) String() string

type Engine_ChatEngineConfig_ added in v1.5.0 

type Engine_ChatEngineConfig_ struct {
	// Configurations for the Chat Engine. Only applicable if
	// [solution_type][google.cloud.discoveryengine.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"`
}

type Engine_ChatEngineConfig_AgentCreationConfig added in v1.5.0 

type Engine_ChatEngineConfig_AgentCreationConfig struct {

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

Configurations for generating a Dialogflow agent.

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

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

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

Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetLocation() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage()

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) Reset()

func (*Engine_ChatEngineConfig_AgentCreationConfig) String added in v1.5.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) String() string

type Engine_ChatEngineMetadata added in v1.5.0 

type Engine_ChatEngineMetadata struct {

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

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

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

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

Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineMetadata) GetDialogflowAgent added in v1.5.0 

func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() string

func (*Engine_ChatEngineMetadata) ProtoMessage added in v1.5.0 

func (*Engine_ChatEngineMetadata) ProtoMessage()

func (*Engine_ChatEngineMetadata) ProtoReflect added in v1.5.0 

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

func (*Engine_ChatEngineMetadata) Reset added in v1.5.0 

func (x *Engine_ChatEngineMetadata) Reset()

func (*Engine_ChatEngineMetadata) String added in v1.5.0 

func (x *Engine_ChatEngineMetadata) String() string

type Engine_ChatEngineMetadata_ added in v1.5.0 

type Engine_ChatEngineMetadata_ struct {
	// Output only. Additional information of the Chat Engine. Only applicable
	// if [solution_type][google.cloud.discoveryengine.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"`
}

type Engine_CommonConfig added in v1.5.0 

type Engine_CommonConfig struct {

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

Common configurations for an Engine.

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

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

Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.

func (*Engine_CommonConfig) GetCompanyName added in v1.5.0 

func (x *Engine_CommonConfig) GetCompanyName() string

func (*Engine_CommonConfig) ProtoMessage added in v1.5.0 

func (*Engine_CommonConfig) ProtoMessage()

func (*Engine_CommonConfig) ProtoReflect added in v1.5.0 

func (x *Engine_CommonConfig) ProtoReflect() protoreflect.Message

func (*Engine_CommonConfig) Reset added in v1.5.0 

func (x *Engine_CommonConfig) Reset()

func (*Engine_CommonConfig) String added in v1.5.0 

func (x *Engine_CommonConfig) String() string

type Engine_MediaRecommendationEngineConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig struct {

	// Required. The type of engine. e.g., `recommended-for-you`.
	//
	// This field together with
	// [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.optimization_objective]
	// describe engine metadata to use to control engine training and serving.
	//
	// Currently supported values: `recommended-for-you`, `others-you-may-like`,
	// `more-like-this`, `most-popular-items`.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// The optimization objective. e.g., `cvr`.
	//
	// This field together with
	// [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.type]
	// describe engine metadata to use to control engine training and serving.
	//
	// Currently supported
	// values: `ctr`, `cvr`.
	//
	//	If not specified, we choose default based on engine type.
	//
	// Default depends on type of recommendation:
	//
	// `recommended-for-you` => `ctr`
	//
	// `others-you-may-like` => `ctr`
	OptimizationObjective string `protobuf:"bytes,2,opt,name=optimization_objective,json=optimizationObjective,proto3" json:"optimization_objective,omitempty"`
	// Name and value of the custom threshold for cvr optimization_objective.
	// For target_field `watch-time`, target_field_value must be an integer
	// value indicating the media progress time in seconds between (0, 86400]
	// (excludes 0, includes 86400) (e.g., 90).
	// For target_field `watch-percentage`, the target_field_value must be a
	// valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
	// 0.5).
	OptimizationObjectiveConfig *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig `` /* 144-byte string literal not displayed */
	// The training state that the engine is in (e.g.
	// `TRAINING` or `PAUSED`).
	//
	// Since part of the cost of running the service
	// is frequency of training - this can be used to determine when to train
	// engine in order to control cost. If not specified: the default value for
	// `CreateEngine` method is `TRAINING`. The default value for
	// `UpdateEngine` method is to keep the state the same as before.
	TrainingState Engine_MediaRecommendationEngineConfig_TrainingState `` /* 191-byte string literal not displayed */
	// Optional. Additional engine features config.
	EngineFeaturesConfig *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig `protobuf:"bytes,5,opt,name=engine_features_config,json=engineFeaturesConfig,proto3" json:"engine_features_config,omitempty"`
	// contains filtered or unexported fields
}

Additional config specs for a Media Recommendation engine.

func (*Engine_MediaRecommendationEngineConfig) Descriptor deprecated added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig) GetEngineFeaturesConfig added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) GetEngineFeaturesConfig() *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjective added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjective() string

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig() *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig

func (*Engine_MediaRecommendationEngineConfig) GetTrainingState added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) GetTrainingState() Engine_MediaRecommendationEngineConfig_TrainingState

func (*Engine_MediaRecommendationEngineConfig) GetType added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) GetType() string

func (*Engine_MediaRecommendationEngineConfig) ProtoMessage added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig) ProtoReflect added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) ProtoReflect() protoreflect.Message

func (*Engine_MediaRecommendationEngineConfig) Reset added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig) String added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig) String() string

type Engine_MediaRecommendationEngineConfig_ added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_ struct {
	// Configurations for the Media Engine. Only applicable on the data
	// stores with
	// [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type]
	// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
	// and
	// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
	// vertical.
	MediaRecommendationEngineConfig *Engine_MediaRecommendationEngineConfig `protobuf:"bytes,14,opt,name=media_recommendation_engine_config,json=mediaRecommendationEngineConfig,proto3,oneof"`
}

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig struct {

	// Feature related configurations applied to a specific type of meida
	// recommendation engines.
	//
	// Types that are assignable to TypeDedicatedConfig:
	//
	//	*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_RecommendedForYouConfig
	//	*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_MostPopularConfig
	TypeDedicatedConfig isEngine_MediaRecommendationEngineConfig_EngineFeaturesConfig_TypeDedicatedConfig `protobuf_oneof:"type_dedicated_config"`
	// contains filtered or unexported fields
}

More feature configs of the selected engine type.

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) Descriptor deprecated added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetMostPopularConfig added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetMostPopularConfig() *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetRecommendedForYouConfig added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetRecommendedForYouConfig() *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetTypeDedicatedConfig added in v1.18.0 

func (m *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) GetTypeDedicatedConfig() isEngine_MediaRecommendationEngineConfig_EngineFeaturesConfig_TypeDedicatedConfig

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) ProtoMessage added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) ProtoReflect added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) ProtoReflect() protoreflect.Message

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) Reset added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) String added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig) String() string

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_MostPopularConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_MostPopularConfig struct {
	// Most popular engine feature config.
	MostPopularConfig *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig `protobuf:"bytes,2,opt,name=most_popular_config,json=mostPopularConfig,proto3,oneof"`
}

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_RecommendedForYouConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_EngineFeaturesConfig_RecommendedForYouConfig struct {
	// Recommended for you engine feature config.
	RecommendedForYouConfig *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig `protobuf:"bytes,1,opt,name=recommended_for_you_config,json=recommendedForYouConfig,proto3,oneof"`
}

type Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig struct {

	// The time window of which the engine is queried at training and
	// prediction time. Positive integers only. The value translates to the
	// last X days of events. Currently required for the `most-popular-items`
	// engine.
	TimeWindowDays int64 `protobuf:"varint,1,opt,name=time_window_days,json=timeWindowDays,proto3" json:"time_window_days,omitempty"`
	// contains filtered or unexported fields
}

Feature configurations that are required for creating a Most Popular engine.

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) Descriptor deprecated added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) GetTimeWindowDays added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) GetTimeWindowDays() int64

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) ProtoMessage added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) ProtoReflect added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) ProtoReflect() protoreflect.Message

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) Reset added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) String added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_MostPopularFeatureConfig) String() string

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig struct {

	// Required. The name of the field to target. Currently supported
	// values: `watch-percentage`, `watch-time`.
	TargetField string `protobuf:"bytes,1,opt,name=target_field,json=targetField,proto3" json:"target_field,omitempty"`
	// Required. The threshold to be applied to the target (e.g., 0.5).
	TargetFieldValueFloat float32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Custom threshold for `cvr` optimization_objective.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor deprecated added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField() string

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat() float32

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect() protoreflect.Message

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String() string

type Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig struct {

	// The type of event with which the engine is queried at prediction time.
	// If set to `generic`, only `view-item`, `media-play`,and
	// `media-complete` will be used as `context-event` in engine training. If
	// set to `view-home-page`, `view-home-page` will also be used as
	// `context-events` in addition to `view-item`, `media-play`, and
	// `media-complete`. Currently supported for the `recommended-for-you`
	// engine. Currently supported values: `view-home-page`, `generic`.
	ContextEventType string `protobuf:"bytes,1,opt,name=context_event_type,json=contextEventType,proto3" json:"context_event_type,omitempty"`
	// contains filtered or unexported fields
}

Additional feature configurations for creating a `recommended-for-you` engine.

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) Descriptor deprecated added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) GetContextEventType added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) GetContextEventType() string

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) ProtoMessage added in v1.18.0 

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) ProtoReflect added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) ProtoReflect() protoreflect.Message

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) Reset added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) String added in v1.18.0 

func (x *Engine_MediaRecommendationEngineConfig_RecommendedForYouFeatureConfig) String() string

type Engine_MediaRecommendationEngineConfig_TrainingState added in v1.18.0 

type Engine_MediaRecommendationEngineConfig_TrainingState int32

The training state of the engine. 

const (
	// Unspecified training state.
	Engine_MediaRecommendationEngineConfig_TRAINING_STATE_UNSPECIFIED Engine_MediaRecommendationEngineConfig_TrainingState = 0
	// The engine training is paused.
	Engine_MediaRecommendationEngineConfig_PAUSED Engine_MediaRecommendationEngineConfig_TrainingState = 1
	// The engine is training.
	Engine_MediaRecommendationEngineConfig_TRAINING Engine_MediaRecommendationEngineConfig_TrainingState = 2
)

func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor added in v1.18.0 

func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor() protoreflect.EnumDescriptor

func (Engine_MediaRecommendationEngineConfig_TrainingState) Enum added in v1.18.0 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) Enum() *Engine_MediaRecommendationEngineConfig_TrainingState

func (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor deprecated added in v1.18.0 

func (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Engine_MediaRecommendationEngineConfig_TrainingState.Descriptor instead.

func (Engine_MediaRecommendationEngineConfig_TrainingState) Number added in v1.18.0 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) Number() protoreflect.EnumNumber

func (Engine_MediaRecommendationEngineConfig_TrainingState) String added in v1.18.0 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) String() string

func (Engine_MediaRecommendationEngineConfig_TrainingState) Type added in v1.18.0 

func (Engine_MediaRecommendationEngineConfig_TrainingState) Type() protoreflect.EnumType

type Engine_SearchEngineConfig added in v1.5.0 

type Engine_SearchEngineConfig struct {

	// The search feature tier of this engine.
	//
	// Different tiers might have different
	// pricing. To learn more, check the pricing documentation.
	//
	// Defaults to
	// [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1.SearchTier.SEARCH_TIER_STANDARD]
	// if not specified.
	SearchTier SearchTier `` /* 140-byte string literal not displayed */
	// The add-on that this search engine enables.
	SearchAddOns []SearchAddOn `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configurations for a Search Engine.

func (*Engine_SearchEngineConfig) Descriptor deprecated added in v1.5.0 

func (*Engine_SearchEngineConfig) Descriptor() ([]byte, []int)

Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SearchEngineConfig) GetSearchAddOns added in v1.5.0 

func (x *Engine_SearchEngineConfig) GetSearchAddOns() []SearchAddOn

func (*Engine_SearchEngineConfig) GetSearchTier added in v1.5.0 

func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTier

func (*Engine_SearchEngineConfig) ProtoMessage added in v1.5.0 

func (*Engine_SearchEngineConfig) ProtoMessage()

func (*Engine_SearchEngineConfig) ProtoReflect added in v1.5.0 

func (x *Engine_SearchEngineConfig) ProtoReflect() protoreflect.Message

func (*Engine_SearchEngineConfig) Reset added in v1.5.0 

func (x *Engine_SearchEngineConfig) Reset()

func (*Engine_SearchEngineConfig) String added in v1.5.0 

func (x *Engine_SearchEngineConfig) String() string

type Engine_SearchEngineConfig_ added in v1.5.0 

type Engine_SearchEngineConfig_ struct {
	// Configurations for the Search Engine. Only applicable if
	// [solution_type][google.cloud.discoveryengine.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"`
}

type FactChunk added in v1.8.0 

type FactChunk struct {

	// Text content of the fact chunk. Can be at most 10K characters long.
	ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
	// Source from which this fact chunk was retrieved. If it was retrieved
	// from the GroundingFacts provided in the request then this field will
	// contain the index of the specific fact from which this chunk was
	// retrieved.
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The index of this chunk. Currently, only used for the streaming mode.
	Index int32 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
	// More fine-grained information for the source reference.
	SourceMetadata map[string]string `` /* 191-byte string literal not displayed */
	// The URI of the source.
	Uri string `protobuf:"bytes,5,opt,name=uri,proto3" json:"uri,omitempty"`
	// The title of the source.
	Title string `protobuf:"bytes,6,opt,name=title,proto3" json:"title,omitempty"`
	// The domain of the source.
	Domain string `protobuf:"bytes,7,opt,name=domain,proto3" json:"domain,omitempty"`
	// contains filtered or unexported fields
}

Fact Chunk.

func (*FactChunk) Descriptor deprecated added in v1.8.0 

func (*FactChunk) Descriptor() ([]byte, []int)

Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.

func (*FactChunk) GetChunkText added in v1.8.0 

func (x *FactChunk) GetChunkText() string

func (*FactChunk) GetDomain added in v1.18.0 

func (x *FactChunk) GetDomain() string

func (*FactChunk) GetIndex added in v1.8.0 

func (x *FactChunk) GetIndex() int32

func (*FactChunk) GetSource added in v1.8.0 

func (x *FactChunk) GetSource() string

func (*FactChunk) GetSourceMetadata added in v1.8.0 

func (x *FactChunk) GetSourceMetadata() map[string]string

func (*FactChunk) GetTitle added in v1.18.0 

func (x *FactChunk) GetTitle() string

func (*FactChunk) GetUri added in v1.18.0 

func (x *FactChunk) GetUri() string

func (*FactChunk) ProtoMessage added in v1.8.0 

func (*FactChunk) ProtoMessage()

func (*FactChunk) ProtoReflect added in v1.8.0 

func (x *FactChunk) ProtoReflect() protoreflect.Message

func (*FactChunk) Reset added in v1.8.0 

func (x *FactChunk) Reset()

func (*FactChunk) String added in v1.8.0 

func (x *FactChunk) String() string

type FetchDomainVerificationStatusRequest added in v1.5.0 

type FetchDomainVerificationStatusRequest struct {

	// Required. The site search engine resource under which we fetch all the
	// domain verification status.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// Requested page size. Server may return fewer items than requested. If
	// unspecified, server will pick an appropriate default. The maximum value is
	// 1000; values above 1000 will be coerced to 1000.
	//
	// If this field is negative, an INVALID_ARGUMENT error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `FetchDomainVerificationStatus`
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `FetchDomainVerificationStatus` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusRequest) Descriptor deprecated added in v1.5.0 

func (*FetchDomainVerificationStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusRequest) GetPageSize added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetPageSize() int32

func (*FetchDomainVerificationStatusRequest) GetPageToken added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetPageToken() string

func (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() string

func (*FetchDomainVerificationStatusRequest) ProtoMessage added in v1.5.0 

func (*FetchDomainVerificationStatusRequest) ProtoMessage()

func (*FetchDomainVerificationStatusRequest) ProtoReflect added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) ProtoReflect() protoreflect.Message

func (*FetchDomainVerificationStatusRequest) Reset added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) Reset()

func (*FetchDomainVerificationStatusRequest) String added in v1.5.0 

func (x *FetchDomainVerificationStatusRequest) String() string

type FetchDomainVerificationStatusResponse added in v1.5.0 

type FetchDomainVerificationStatusResponse struct {

	// List of TargetSites containing the site verification status.
	TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
	// A token that can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The total number of items matching the request.
	// This will always be populated in the response.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusResponse) Descriptor deprecated added in v1.5.0 

func (*FetchDomainVerificationStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusResponse) GetNextPageToken added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() string

func (*FetchDomainVerificationStatusResponse) GetTargetSites added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) GetTargetSites() []*TargetSite

func (*FetchDomainVerificationStatusResponse) GetTotalSize added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32

func (*FetchDomainVerificationStatusResponse) ProtoMessage added in v1.5.0 

func (*FetchDomainVerificationStatusResponse) ProtoMessage()

func (*FetchDomainVerificationStatusResponse) ProtoReflect added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) ProtoReflect() protoreflect.Message

func (*FetchDomainVerificationStatusResponse) Reset added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) Reset()

func (*FetchDomainVerificationStatusResponse) String added in v1.5.0 

func (x *FetchDomainVerificationStatusResponse) String() string

type FetchSitemapsRequest added in v1.17.0 

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 deprecated added in v1.17.0 

func (*FetchSitemapsRequest) Descriptor() ([]byte, []int)

Deprecated: Use FetchSitemapsRequest.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest) GetMatcher added in v1.17.0 

func (x *FetchSitemapsRequest) GetMatcher() *FetchSitemapsRequest_Matcher

func (*FetchSitemapsRequest) GetParent added in v1.17.0 

func (x *FetchSitemapsRequest) GetParent() string

func (*FetchSitemapsRequest) ProtoMessage added in v1.17.0 

func (*FetchSitemapsRequest) ProtoMessage()

func (*FetchSitemapsRequest) ProtoReflect added in v1.17.0 

func (x *FetchSitemapsRequest) ProtoReflect() protoreflect.Message

func (*FetchSitemapsRequest) Reset added in v1.17.0 

func (x *FetchSitemapsRequest) Reset()

func (*FetchSitemapsRequest) String added in v1.17.0 

func (x *FetchSitemapsRequest) String() string

type FetchSitemapsRequest_Matcher added in v1.17.0 

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 deprecated added in v1.17.0 

func (*FetchSitemapsRequest_Matcher) Descriptor() ([]byte, []int)

Deprecated: Use FetchSitemapsRequest_Matcher.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest_Matcher) GetMatcher added in v1.17.0 

func (m *FetchSitemapsRequest_Matcher) GetMatcher() isFetchSitemapsRequest_Matcher_Matcher

func (*FetchSitemapsRequest_Matcher) GetUrisMatcher added in v1.17.0 

func (x *FetchSitemapsRequest_Matcher) GetUrisMatcher() *FetchSitemapsRequest_UrisMatcher

func (*FetchSitemapsRequest_Matcher) ProtoMessage added in v1.17.0 

func (*FetchSitemapsRequest_Matcher) ProtoMessage()

func (*FetchSitemapsRequest_Matcher) ProtoReflect added in v1.17.0 

func (x *FetchSitemapsRequest_Matcher) ProtoReflect() protoreflect.Message

func (*FetchSitemapsRequest_Matcher) Reset added in v1.17.0 

func (x *FetchSitemapsRequest_Matcher) Reset()

func (*FetchSitemapsRequest_Matcher) String added in v1.17.0 

func (x *FetchSitemapsRequest_Matcher) String() string

type FetchSitemapsRequest_Matcher_UrisMatcher added in v1.17.0 

type FetchSitemapsRequest_Matcher_UrisMatcher struct {
	// Matcher by sitemap URIs.
	UrisMatcher *FetchSitemapsRequest_UrisMatcher `protobuf:"bytes,1,opt,name=uris_matcher,json=urisMatcher,proto3,oneof"`
}

type FetchSitemapsRequest_UrisMatcher added in v1.17.0 

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 deprecated added in v1.17.0 

func (*FetchSitemapsRequest_UrisMatcher) Descriptor() ([]byte, []int)

Deprecated: Use FetchSitemapsRequest_UrisMatcher.ProtoReflect.Descriptor instead.

func (*FetchSitemapsRequest_UrisMatcher) GetUris added in v1.17.0 

func (x *FetchSitemapsRequest_UrisMatcher) GetUris() []string

func (*FetchSitemapsRequest_UrisMatcher) ProtoMessage added in v1.17.0 

func (*FetchSitemapsRequest_UrisMatcher) ProtoMessage()

func (*FetchSitemapsRequest_UrisMatcher) ProtoReflect added in v1.17.0 

func (x *FetchSitemapsRequest_UrisMatcher) ProtoReflect() protoreflect.Message

func (*FetchSitemapsRequest_UrisMatcher) Reset added in v1.17.0 

func (x *FetchSitemapsRequest_UrisMatcher) Reset()

func (*FetchSitemapsRequest_UrisMatcher) String added in v1.17.0 

func (x *FetchSitemapsRequest_UrisMatcher) String() string

type FetchSitemapsResponse added in v1.17.0 

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 deprecated added in v1.17.0 

func (*FetchSitemapsResponse) Descriptor() ([]byte, []int)

Deprecated: Use FetchSitemapsResponse.ProtoReflect.Descriptor instead.

func (*FetchSitemapsResponse) GetSitemapsMetadata added in v1.17.0 

func (x *FetchSitemapsResponse) GetSitemapsMetadata() []*FetchSitemapsResponse_SitemapMetadata

func (*FetchSitemapsResponse) ProtoMessage added in v1.17.0 

func (*FetchSitemapsResponse) ProtoMessage()

func (*FetchSitemapsResponse) ProtoReflect added in v1.17.0 

func (x *FetchSitemapsResponse) ProtoReflect() protoreflect.Message

func (*FetchSitemapsResponse) Reset added in v1.17.0 

func (x *FetchSitemapsResponse) Reset()

func (*FetchSitemapsResponse) String added in v1.17.0 

func (x *FetchSitemapsResponse) String() string

type FetchSitemapsResponse_SitemapMetadata added in v1.17.0 

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 deprecated added in v1.17.0 

func (*FetchSitemapsResponse_SitemapMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FetchSitemapsResponse_SitemapMetadata.ProtoReflect.Descriptor instead.

func (*FetchSitemapsResponse_SitemapMetadata) GetSitemap added in v1.17.0 

func (x *FetchSitemapsResponse_SitemapMetadata) GetSitemap() *Sitemap

func (*FetchSitemapsResponse_SitemapMetadata) ProtoMessage added in v1.17.0 

func (*FetchSitemapsResponse_SitemapMetadata) ProtoMessage()

func (*FetchSitemapsResponse_SitemapMetadata) ProtoReflect added in v1.17.0 

func (x *FetchSitemapsResponse_SitemapMetadata) ProtoReflect() protoreflect.Message

func (*FetchSitemapsResponse_SitemapMetadata) Reset added in v1.17.0 

func (x *FetchSitemapsResponse_SitemapMetadata) Reset()

func (*FetchSitemapsResponse_SitemapMetadata) String added in v1.17.0 

func (x *FetchSitemapsResponse_SitemapMetadata) String() string

type FhirStoreSource added in v1.7.0 

type FhirStoreSource struct {

	// Required. The full resource name of the FHIR store to import data from, in
	// the format of
	// `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
	FhirStore string `protobuf:"bytes,1,opt,name=fhir_store,json=fhirStore,proto3" json:"fhir_store,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// FhirStore export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,2,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The FHIR resource types to import. The resource types should be a subset of
	// all [supported FHIR resource
	// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
	// Default to all supported FHIR resource types if empty.
	ResourceTypes []string `protobuf:"bytes,3,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
	// 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 `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Cloud FhirStore source import data from.

func (*FhirStoreSource) Descriptor deprecated added in v1.7.0 

func (*FhirStoreSource) Descriptor() ([]byte, []int)

Deprecated: Use FhirStoreSource.ProtoReflect.Descriptor instead.

func (*FhirStoreSource) GetFhirStore added in v1.7.0 

func (x *FhirStoreSource) GetFhirStore() string

func (*FhirStoreSource) GetGcsStagingDir added in v1.7.0 

func (x *FhirStoreSource) GetGcsStagingDir() string

func (*FhirStoreSource) GetResourceTypes added in v1.14.0 

func (x *FhirStoreSource) GetResourceTypes() []string

func (*FhirStoreSource) GetUpdateFromLatestPredefinedSchema added in v1.17.0 

func (x *FhirStoreSource) GetUpdateFromLatestPredefinedSchema() bool

func (*FhirStoreSource) ProtoMessage added in v1.7.0 

func (*FhirStoreSource) ProtoMessage()

func (*FhirStoreSource) ProtoReflect added in v1.7.0 

func (x *FhirStoreSource) ProtoReflect() protoreflect.Message

func (*FhirStoreSource) Reset added in v1.7.0 

func (x *FhirStoreSource) Reset()

func (*FhirStoreSource) String added in v1.7.0 

func (x *FhirStoreSource) String() string

type FirestoreSource added in v1.7.0 

type FirestoreSource struct {

	// The project ID that the Cloud SQL source is in with a length limit of 128
	// characters. If not specified, inherits the project ID from the parent
	// request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The Firestore database to copy the data from with a length limit
	// of 256 characters.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The Firestore collection (or entity) to copy the data from with a
	// length limit of 1,500 characters.
	CollectionId string `protobuf:"bytes,3,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// Firestore export to a specific Cloud Storage directory.
	//
	// Ensure that the Firestore service account has the necessary Cloud
	// Storage Admin permissions to access the specified Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// contains filtered or unexported fields
}

Firestore source import data from.

func (*FirestoreSource) Descriptor deprecated added in v1.7.0 

func (*FirestoreSource) Descriptor() ([]byte, []int)

Deprecated: Use FirestoreSource.ProtoReflect.Descriptor instead.

func (*FirestoreSource) GetCollectionId added in v1.7.0 

func (x *FirestoreSource) GetCollectionId() string

func (*FirestoreSource) GetDatabaseId added in v1.7.0 

func (x *FirestoreSource) GetDatabaseId() string

func (*FirestoreSource) GetGcsStagingDir added in v1.7.0 

func (x *FirestoreSource) GetGcsStagingDir() string

func (*FirestoreSource) GetProjectId added in v1.7.0 

func (x *FirestoreSource) GetProjectId() string

func (*FirestoreSource) ProtoMessage added in v1.7.0 

func (*FirestoreSource) ProtoMessage()

func (*FirestoreSource) ProtoReflect added in v1.7.0 

func (x *FirestoreSource) ProtoReflect() protoreflect.Message

func (*FirestoreSource) Reset added in v1.7.0 

func (x *FirestoreSource) Reset()

func (*FirestoreSource) String added in v1.7.0 

func (x *FirestoreSource) String() string

type GcsSource 

type GcsSource struct {

	// Required. Cloud Storage URIs to input files. Each URI can be up to
	// 2000 characters long. URIs can match the full object path (for example,
	// `gs://bucket/directory/object.json`) or a pattern matching one or more
	// files, such as `gs://bucket/directory/*.json`.
	//
	// A request can contain at most 100 files (or 100,000 files if `data_schema`
	// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
	// `content`).
	InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One JSON
	// [Document][google.cloud.discoveryengine.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 deprecated 

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema 

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris 

func (x *GcsSource) GetInputUris() []string

func (*GcsSource) ProtoMessage 

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect 

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset 

func (x *GcsSource) Reset()

func (*GcsSource) String 

func (x *GcsSource) String() string

type GenerateGroundedContentRequest added in v1.15.0 

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 `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

Top-level message sent by the client for the `GenerateGroundedContent` method.

func (*GenerateGroundedContentRequest) Descriptor deprecated added in v1.15.0 

func (*GenerateGroundedContentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest) GetContents added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetContents() []*GroundedGenerationContent

func (*GenerateGroundedContentRequest) GetGenerationSpec added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetGenerationSpec() *GenerateGroundedContentRequest_GenerationSpec

func (*GenerateGroundedContentRequest) GetGroundingSpec added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetGroundingSpec() *GenerateGroundedContentRequest_GroundingSpec

func (*GenerateGroundedContentRequest) GetLocation added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetLocation() string

func (*GenerateGroundedContentRequest) GetSystemInstruction added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetSystemInstruction() *GroundedGenerationContent

func (*GenerateGroundedContentRequest) GetUserLabels added in v1.15.0 

func (x *GenerateGroundedContentRequest) GetUserLabels() map[string]string

func (*GenerateGroundedContentRequest) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest) ProtoMessage()

func (*GenerateGroundedContentRequest) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest) Reset()

func (*GenerateGroundedContentRequest) String added in v1.15.0 

func (x *GenerateGroundedContentRequest) String() string

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) GetPredictor added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration) GetPredictor() *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoMessage()

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration) Reset()

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration) String() string

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor added in v1.15.0 

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor struct {

	// The version of the predictor to be used in dynamic retrieval.
	Version GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version `` /* 200-byte string literal not displayed */
	// 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 added in v1.15.0 

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetThreshold added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetThreshold() float32

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetVersion added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) GetVersion() GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoMessage()

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) Reset()

func (*GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor) String() string

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version added in v1.15.0 

type GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version int32

The version of the predictor to be used in dynamic retrieval. 

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 added in v1.15.0 

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Descriptor() protoreflect.EnumDescriptor

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Enum added in v1.15.0 

func (x GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Enum() *GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) EnumDescriptor deprecated added in v1.15.0 

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version.Descriptor instead.

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Number added in v1.15.0 

func (x GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Number() protoreflect.EnumNumber

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) String added in v1.15.0 

func (x GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) String() string

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Type added in v1.15.0 

func (GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version) Type() protoreflect.EnumType

type GenerateGroundedContentRequest_GenerationSpec added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentRequest_GenerationSpec) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GenerationSpec.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GenerationSpec) GetFrequencyPenalty added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetFrequencyPenalty() float32

func (*GenerateGroundedContentRequest_GenerationSpec) GetLanguageCode added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetLanguageCode() string

func (*GenerateGroundedContentRequest_GenerationSpec) GetMaxOutputTokens added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetMaxOutputTokens() int32

func (*GenerateGroundedContentRequest_GenerationSpec) GetModelId added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetModelId() string

func (*GenerateGroundedContentRequest_GenerationSpec) GetPresencePenalty added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetPresencePenalty() float32

func (*GenerateGroundedContentRequest_GenerationSpec) GetSeed added in v1.17.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetSeed() int32

func (*GenerateGroundedContentRequest_GenerationSpec) GetTemperature added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetTemperature() float32

func (*GenerateGroundedContentRequest_GenerationSpec) GetTopK added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetTopK() int32

func (*GenerateGroundedContentRequest_GenerationSpec) GetTopP added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) GetTopP() float32

func (*GenerateGroundedContentRequest_GenerationSpec) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GenerationSpec) ProtoMessage()

func (*GenerateGroundedContentRequest_GenerationSpec) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GenerationSpec) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) Reset()

func (*GenerateGroundedContentRequest_GenerationSpec) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GenerationSpec) String() string

type GenerateGroundedContentRequest_GroundingSource added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource) GetEnterpriseWebRetrievalSource added in v1.17.0 

func (x *GenerateGroundedContentRequest_GroundingSource) GetEnterpriseWebRetrievalSource() *GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource

func (*GenerateGroundedContentRequest_GroundingSource) GetGoogleSearchSource added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) GetGoogleSearchSource() *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource

func (*GenerateGroundedContentRequest_GroundingSource) GetInlineSource added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) GetInlineSource() *GenerateGroundedContentRequest_GroundingSource_InlineSource

func (*GenerateGroundedContentRequest_GroundingSource) GetSearchSource added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) GetSearchSource() *GenerateGroundedContentRequest_GroundingSource_SearchSource

func (*GenerateGroundedContentRequest_GroundingSource) GetSource added in v1.15.0 

func (m *GenerateGroundedContentRequest_GroundingSource) GetSource() isGenerateGroundedContentRequest_GroundingSource_Source

func (*GenerateGroundedContentRequest_GroundingSource) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSource) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSource) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) Reset()

func (*GenerateGroundedContentRequest_GroundingSource) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource) String() string

type GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource added in v1.17.0 

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 added in v1.17.0 

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoMessage added in v1.17.0 

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoReflect added in v1.17.0 

func (x *GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) Reset added in v1.17.0 

func (x *GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) Reset()

func (*GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) String added in v1.17.0 

func (x *GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource) String() string

type GenerateGroundedContentRequest_GroundingSource_EnterpriseWebRetrievalSource_ added in v1.17.0 

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"`
}

type GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource added in v1.15.0 

type GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource struct {

	// Optional. Specifies the dynamic retrieval configuration for the given
	// source.
	DynamicRetrievalConfig *GenerateGroundedContentRequest_DynamicRetrievalConfiguration `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Google Search config parameters.

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Descriptor deprecated added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) GetDynamicRetrievalConfig added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) GetDynamicRetrievalConfig() *GenerateGroundedContentRequest_DynamicRetrievalConfiguration

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) Reset()

func (*GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource) String() string

type GenerateGroundedContentRequest_GroundingSource_GoogleSearchSource_ added in v1.15.0 

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"`
}

type GenerateGroundedContentRequest_GroundingSource_InlineSource added in v1.15.0 

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 `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message to be used for grounding based on inline content.

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) Descriptor deprecated added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_InlineSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) GetAttributes added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_InlineSource) GetAttributes() map[string]string

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) GetGroundingFacts added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_InlineSource) GetGroundingFacts() []*GroundingFact

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_InlineSource) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_InlineSource) Reset()

func (*GenerateGroundedContentRequest_GroundingSource_InlineSource) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_InlineSource) String() string

type GenerateGroundedContentRequest_GroundingSource_InlineSource_ added in v1.15.0 

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"`
}

type GenerateGroundedContentRequest_GroundingSource_SearchSource added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSource_SearchSource.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetFilter added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) GetFilter() string

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetMaxResultCount added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) GetMaxResultCount() int32

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetSafeSearch added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) GetSafeSearch() bool

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) GetServingConfig added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) GetServingConfig() string

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) Reset()

func (*GenerateGroundedContentRequest_GroundingSource_SearchSource) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSource_SearchSource) String() string

type GenerateGroundedContentRequest_GroundingSource_SearchSource_ added in v1.15.0 

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"`
}

type GenerateGroundedContentRequest_GroundingSpec added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSpec) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentRequest_GroundingSpec.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentRequest_GroundingSpec) GetGroundingSources added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSpec) GetGroundingSources() []*GenerateGroundedContentRequest_GroundingSource

func (*GenerateGroundedContentRequest_GroundingSpec) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentRequest_GroundingSpec) ProtoMessage()

func (*GenerateGroundedContentRequest_GroundingSpec) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSpec) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentRequest_GroundingSpec) Reset added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSpec) Reset()

func (*GenerateGroundedContentRequest_GroundingSpec) String added in v1.15.0 

func (x *GenerateGroundedContentRequest_GroundingSpec) String() string

type GenerateGroundedContentResponse added in v1.15.0 

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 deprecated added in v1.15.0 

func (*GenerateGroundedContentResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse) GetCandidates added in v1.15.0 

func (x *GenerateGroundedContentResponse) GetCandidates() []*GenerateGroundedContentResponse_Candidate

func (*GenerateGroundedContentResponse) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse) ProtoMessage()

func (*GenerateGroundedContentResponse) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse) Reset()

func (*GenerateGroundedContentResponse) String added in v1.15.0 

func (x *GenerateGroundedContentResponse) String() string

type GenerateGroundedContentResponse_Candidate added in v1.15.0 

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 deprecated added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate) GetContent added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) GetContent() *GroundedGenerationContent

func (*GenerateGroundedContentResponse_Candidate) GetGroundingMetadata added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) GetGroundingMetadata() *GenerateGroundedContentResponse_Candidate_GroundingMetadata

func (*GenerateGroundedContentResponse_Candidate) GetGroundingScore added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) GetGroundingScore() float32

func (*GenerateGroundedContentResponse_Candidate) GetIndex added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) GetIndex() int32

func (*GenerateGroundedContentResponse_Candidate) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) Reset()

func (*GenerateGroundedContentResponse_Candidate) String added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetGroundingSupport added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetGroundingSupport() []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetImages added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetImages() []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetRetrievalMetadata added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetRetrievalMetadata() []*GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSearchEntryPoint added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSearchEntryPoint() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_SearchEntryPoint

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSupportChunks added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetSupportChunks() []*FactChunk

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetWebSearchQueries added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) GetWebSearchQueries() []string

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata) String added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata added in v1.15.0 

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 added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) GetPredictorMetadata added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) GetPredictorMetadata() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) String added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalMetadata) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata added in v1.15.0 

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata struct {

	// The version of the predictor which was used in dynamic retrieval.
	Version GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version `` /* 207-byte string literal not displayed */
	// 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 added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetPrediction added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetPrediction() float32

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetVersion added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) GetVersion() GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) String added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version added in v1.15.0 

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version int32

The version of the predictor which was used in dynamic retrieval. 

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 added in v1.15.0 

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Descriptor() protoreflect.EnumDescriptor

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Enum added in v1.15.0 

func (x GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Enum() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) EnumDescriptor deprecated added in v1.15.0 

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version.Descriptor instead.

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Number added in v1.15.0 

func (x GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Number() protoreflect.EnumNumber

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) String added in v1.15.0 

func (x GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) String() string

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Type added in v1.15.0 

func (GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version) Type() protoreflect.EnumType

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport added in v1.15.0 

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 `` /* 128-byte string literal not displayed */
	// 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 added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetClaimText added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetClaimText() string

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportChunkIndices added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportChunkIndices() []int32

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportScore added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) GetSupportScore() float32

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoMessage added in v1.15.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoReflect added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) Reset added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) String added in v1.15.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_GroundingSupport) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata added in v1.17.0 

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 added in v1.17.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetImage added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetImage() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetSource added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetSource() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetThumbnail added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) GetThumbnail() *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoMessage added in v1.17.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoReflect added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) Reset added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) String added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image added in v1.17.0 

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 added in v1.17.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) Descriptor() ([]byte, []int)

Deprecated: Use GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image.ProtoReflect.Descriptor instead.

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetHeight added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetHeight() int32

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetUri added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetUri() string

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetWidth added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) GetWidth() int32

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoMessage added in v1.17.0 

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoMessage()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoReflect added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) ProtoReflect() protoreflect.Message

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) Reset added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) Reset()

func (*GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) String added in v1.17.0 

func (x *GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_Image) String() string

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo added in v1.17.0 

type GenerateGroundedContentResponse_Candidate_GroundingMetadata_ImageMetadata_WebsiteInfo struct {