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: 0

Documentation

Index

Constants

View Source 
const (
	AclConfigService_UpdateAclConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.AclConfigService/UpdateAclConfig"
	AclConfigService_GetAclConfig_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.AclConfigService/GetAclConfig"
)
View Source 
const (
	ChunkService_GetChunk_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.ChunkService/GetChunk"
	ChunkService_ListChunks_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ChunkService/ListChunks"
)
View Source 
const (
	CompletionService_CompleteQuery_FullMethodName                   = "/google.cloud.discoveryengine.v1alpha.CompletionService/CompleteQuery"
	CompletionService_ImportSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/ImportSuggestionDenyListEntries"
	CompletionService_PurgeSuggestionDenyListEntries_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.CompletionService/PurgeSuggestionDenyListEntries"
	CompletionService_ImportCompletionSuggestions_FullMethodName     = "/google.cloud.discoveryengine.v1alpha.CompletionService/ImportCompletionSuggestions"
	CompletionService_PurgeCompletionSuggestions_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.CompletionService/PurgeCompletionSuggestions"
)
View Source 
const (
	ControlService_CreateControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/CreateControl"
	ControlService_DeleteControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/DeleteControl"
	ControlService_UpdateControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/UpdateControl"
	ControlService_GetControl_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.ControlService/GetControl"
	ControlService_ListControls_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.ControlService/ListControls"
)
View Source 
const (
	ConversationalSearchService_ConverseConversation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/ConverseConversation"
	ConversationalSearchService_CreateConversation_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/CreateConversation"
	ConversationalSearchService_DeleteConversation_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/DeleteConversation"
	ConversationalSearchService_UpdateConversation_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/UpdateConversation"
	ConversationalSearchService_GetConversation_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetConversation"
	ConversationalSearchService_ListConversations_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/ListConversations"
	ConversationalSearchService_AnswerQuery_FullMethodName          = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/AnswerQuery"
	ConversationalSearchService_GetAnswer_FullMethodName            = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetAnswer"
	ConversationalSearchService_CreateSession_FullMethodName        = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/CreateSession"
	ConversationalSearchService_DeleteSession_FullMethodName        = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/DeleteSession"
	ConversationalSearchService_UpdateSession_FullMethodName        = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/UpdateSession"
	ConversationalSearchService_GetSession_FullMethodName           = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetSession"
	ConversationalSearchService_ListSessions_FullMethodName         = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/ListSessions"
)
View Source 
const (
	DataStoreService_CreateDataStore_FullMethodName                = "/google.cloud.discoveryengine.v1alpha.DataStoreService/CreateDataStore"
	DataStoreService_GetDataStore_FullMethodName                   = "/google.cloud.discoveryengine.v1alpha.DataStoreService/GetDataStore"
	DataStoreService_ListDataStores_FullMethodName                 = "/google.cloud.discoveryengine.v1alpha.DataStoreService/ListDataStores"
	DataStoreService_DeleteDataStore_FullMethodName                = "/google.cloud.discoveryengine.v1alpha.DataStoreService/DeleteDataStore"
	DataStoreService_UpdateDataStore_FullMethodName                = "/google.cloud.discoveryengine.v1alpha.DataStoreService/UpdateDataStore"
	DataStoreService_GetDocumentProcessingConfig_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.DataStoreService/GetDocumentProcessingConfig"
	DataStoreService_UpdateDocumentProcessingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/UpdateDocumentProcessingConfig"
)
View Source 
const (
	DocumentService_GetDocument_FullMethodName               = "/google.cloud.discoveryengine.v1alpha.DocumentService/GetDocument"
	DocumentService_ListDocuments_FullMethodName             = "/google.cloud.discoveryengine.v1alpha.DocumentService/ListDocuments"
	DocumentService_CreateDocument_FullMethodName            = "/google.cloud.discoveryengine.v1alpha.DocumentService/CreateDocument"
	DocumentService_UpdateDocument_FullMethodName            = "/google.cloud.discoveryengine.v1alpha.DocumentService/UpdateDocument"
	DocumentService_DeleteDocument_FullMethodName            = "/google.cloud.discoveryengine.v1alpha.DocumentService/DeleteDocument"
	DocumentService_ImportDocuments_FullMethodName           = "/google.cloud.discoveryengine.v1alpha.DocumentService/ImportDocuments"
	DocumentService_PurgeDocuments_FullMethodName            = "/google.cloud.discoveryengine.v1alpha.DocumentService/PurgeDocuments"
	DocumentService_GetProcessedDocument_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.DocumentService/GetProcessedDocument"
	DocumentService_BatchGetDocumentsMetadata_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/BatchGetDocumentsMetadata"
)
View Source 
const (
	EngineService_CreateEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/CreateEngine"
	EngineService_DeleteEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/DeleteEngine"
	EngineService_UpdateEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/UpdateEngine"
	EngineService_GetEngine_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.EngineService/GetEngine"
	EngineService_ListEngines_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.EngineService/ListEngines"
	EngineService_PauseEngine_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.EngineService/PauseEngine"
	EngineService_ResumeEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/ResumeEngine"
	EngineService_TuneEngine_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.EngineService/TuneEngine"
)
View Source 
const (
	EvaluationService_GetEvaluation_FullMethodName         = "/google.cloud.discoveryengine.v1alpha.EvaluationService/GetEvaluation"
	EvaluationService_ListEvaluations_FullMethodName       = "/google.cloud.discoveryengine.v1alpha.EvaluationService/ListEvaluations"
	EvaluationService_CreateEvaluation_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.EvaluationService/CreateEvaluation"
	EvaluationService_ListEvaluationResults_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EvaluationService/ListEvaluationResults"
)
View Source 
const (
	ProjectService_GetProject_FullMethodName          = "/google.cloud.discoveryengine.v1alpha.ProjectService/GetProject"
	ProjectService_ProvisionProject_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.ProjectService/ProvisionProject"
	ProjectService_ReportConsentChange_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ProjectService/ReportConsentChange"
)
View Source 
const (
	SampleQueryService_GetSampleQuery_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/GetSampleQuery"
	SampleQueryService_ListSampleQueries_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/ListSampleQueries"
	SampleQueryService_CreateSampleQuery_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/CreateSampleQuery"
	SampleQueryService_UpdateSampleQuery_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/UpdateSampleQuery"
	SampleQueryService_DeleteSampleQuery_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/DeleteSampleQuery"
	SampleQueryService_ImportSampleQueries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/ImportSampleQueries"
)
View Source 
const (
	SampleQuerySetService_GetSampleQuerySet_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/GetSampleQuerySet"
	SampleQuerySetService_ListSampleQuerySets_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/ListSampleQuerySets"
	SampleQuerySetService_CreateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/CreateSampleQuerySet"
	SampleQuerySetService_UpdateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/UpdateSampleQuerySet"
	SampleQuerySetService_DeleteSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/DeleteSampleQuerySet"
)
View Source 
const (
	SchemaService_GetSchema_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.SchemaService/GetSchema"
	SchemaService_ListSchemas_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.SchemaService/ListSchemas"
	SchemaService_CreateSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/CreateSchema"
	SchemaService_UpdateSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/UpdateSchema"
	SchemaService_DeleteSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/DeleteSchema"
)
View Source 
const (
	SearchTuningService_TrainCustomModel_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchTuningService/TrainCustomModel"
	SearchTuningService_ListCustomModels_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchTuningService/ListCustomModels"
)
View Source 
const (
	ServingConfigService_UpdateServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/UpdateServingConfig"
	ServingConfigService_GetServingConfig_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/GetServingConfig"
	ServingConfigService_ListServingConfigs_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/ListServingConfigs"
)
View Source 
const (
	SessionService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/CreateSession"
	SessionService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/DeleteSession"
	SessionService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/UpdateSession"
	SessionService_GetSession_FullMethodName    = "/google.cloud.discoveryengine.v1alpha.SessionService/GetSession"
	SessionService_ListSessions_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.SessionService/ListSessions"
	SessionService_ListFiles_FullMethodName     = "/google.cloud.discoveryengine.v1alpha.SessionService/ListFiles"
)
View Source 
const (
	SiteSearchEngineService_GetSiteSearchEngine_FullMethodName           = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetSiteSearchEngine"
	SiteSearchEngineService_CreateTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/CreateTargetSite"
	SiteSearchEngineService_BatchCreateTargetSites_FullMethodName        = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/BatchCreateTargetSites"
	SiteSearchEngineService_GetTargetSite_FullMethodName                 = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetTargetSite"
	SiteSearchEngineService_UpdateTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/UpdateTargetSite"
	SiteSearchEngineService_DeleteTargetSite_FullMethodName              = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/DeleteTargetSite"
	SiteSearchEngineService_ListTargetSites_FullMethodName               = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/ListTargetSites"
	SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName      = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/EnableAdvancedSiteSearch"
	SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName     = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/DisableAdvancedSiteSearch"
	SiteSearchEngineService_RecrawlUris_FullMethodName                   = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/RecrawlUris"
	SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName        = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/BatchVerifyTargetSites"
	SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/FetchDomainVerificationStatus"
	SiteSearchEngineService_SetUriPatternDocumentData_FullMethodName     = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/SetUriPatternDocumentData"
	SiteSearchEngineService_GetUriPatternDocumentData_FullMethodName     = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetUriPatternDocumentData"
)
View Source 
const (
	UserEventService_WriteUserEvent_FullMethodName   = "/google.cloud.discoveryengine.v1alpha.UserEventService/WriteUserEvent"
	UserEventService_CollectUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/CollectUserEvent"
	UserEventService_PurgeUserEvents_FullMethodName  = "/google.cloud.discoveryengine.v1alpha.UserEventService/PurgeUserEvents"
	UserEventService_ImportUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/ImportUserEvents"
)
View Source 
const (
	EstimateBillingService_EstimateDataSize_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EstimateBillingService/EstimateDataSize"
)
View Source 
const (
	GroundedGenerationService_CheckGrounding_FullMethodName = "/google.cloud.discoveryengine.v1alpha.GroundedGenerationService/CheckGrounding"
)
View Source 
const (
	RankService_Rank_FullMethodName = "/google.cloud.discoveryengine.v1alpha.RankService/Rank"
)
View Source 
const (
	RecommendationService_Recommend_FullMethodName = "/google.cloud.discoveryengine.v1alpha.RecommendationService/Recommend"
)
View Source 
const (
	SearchService_Search_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchService/Search"
)

Variables

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

Enum value maps for Answer_State.

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

Enum value maps for Answer_AnswerSkippedReason.

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

Enum value maps for Answer_Step_State.

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

Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.

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

Enum value maps for IndustryVertical.

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

Enum value maps for SolutionType.

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

Enum value maps for SearchUseCase.

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

Enum value maps for SearchTier.

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

Enum value maps for SearchAddOn.

View Source 
var (
	FileOriginType_name = map[int32]string{
		0: "FILE_ORIGIN_TYPE_UNSPECIFIED",
		1: "USER_PROVIDED",
		2: "AI_GENERATED",
		3: "INTERNALLY_GENERATED",
	}
	FileOriginType_value = map[string]int32{
		"FILE_ORIGIN_TYPE_UNSPECIFIED": 0,
		"USER_PROVIDED":                1,
		"AI_GENERATED":                 2,
		"INTERNALLY_GENERATED":         3,
	}
)

Enum value maps for FileOriginType.

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

Enum value maps for IdpConfig_IdpType.

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

Enum value maps for SuggestionDenyListEntry_MatchOperator.

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

Enum value maps for Conversation_State.

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

Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.

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

Enum value maps for CustomTuningModel_ModelState.

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

Enum value maps for WorkspaceConfig_Type.

View Source 
var (
	GetProcessedDocumentRequest_ProcessedDocumentType_name = map[int32]string{
		0: "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED",
		1: "PARSED_DOCUMENT",
		2: "CHUNKED_DOCUMENT",
		3: "PNG_CONVERTED_DOCUMENT",
	}
	GetProcessedDocumentRequest_ProcessedDocumentType_value = map[string]int32{
		"PROCESSED_DOCUMENT_TYPE_UNSPECIFIED": 0,
		"PARSED_DOCUMENT":                     1,
		"CHUNKED_DOCUMENT":                    2,
		"PNG_CONVERTED_DOCUMENT":              3,
	}
)

Enum value maps for GetProcessedDocumentRequest_ProcessedDocumentType.

View Source 
var (
	GetProcessedDocumentRequest_ProcessedDocumentFormat_name = map[int32]string{
		0: "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED",
		1: "JSON",
	}
	GetProcessedDocumentRequest_ProcessedDocumentFormat_value = map[string]int32{
		"PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED": 0,
		"JSON":                                  1,
	}
)

Enum value maps for GetProcessedDocumentRequest_ProcessedDocumentFormat.

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 (
	Engine_RecommendationMetadata_ServingState_name = map[int32]string{
		0: "SERVING_STATE_UNSPECIFIED",
		1: "INACTIVE",
		2: "ACTIVE",
		3: "TUNED",
	}
	Engine_RecommendationMetadata_ServingState_value = map[string]int32{
		"SERVING_STATE_UNSPECIFIED": 0,
		"INACTIVE":                  1,
		"ACTIVE":                    2,
		"TUNED":                     3,
	}
)

Enum value maps for Engine_RecommendationMetadata_ServingState.

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

Enum value maps for Engine_RecommendationMetadata_DataState.

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

Enum value maps for Evaluation_State.

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

Enum value maps for BigtableOptions_Type.

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

Enum value maps for BigtableOptions_Encoding.

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

Enum value maps for ImportDocumentsRequest_ReconciliationMode.

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

Enum value maps for Project_ServiceTerms_State.

View Source 
var (
	ReportConsentChangeRequest_ConsentChangeAction_name = map[int32]string{
		0: "CONSENT_CHANGE_ACTION_UNSPECIFIED",
		1: "ACCEPT",
	}
	ReportConsentChangeRequest_ConsentChangeAction_value = map[string]int32{
		"CONSENT_CHANGE_ACTION_UNSPECIFIED": 0,
		"ACCEPT":                            1,
	}
)

Enum value maps for ReportConsentChangeRequest_ConsentChangeAction.

View Source 
var (
	FieldConfig_FieldType_name = map[int32]string{
		0: "FIELD_TYPE_UNSPECIFIED",
		1: "OBJECT",
		2: "STRING",
		3: "NUMBER",
		4: "INTEGER",
		5: "BOOLEAN",
		6: "GEOLOCATION",
		7: "DATETIME",
	}
	FieldConfig_FieldType_value = map[string]int32{
		"FIELD_TYPE_UNSPECIFIED": 0,
		"OBJECT":                 1,
		"STRING":                 2,
		"NUMBER":                 3,
		"INTEGER":                4,
		"BOOLEAN":                5,
		"GEOLOCATION":            6,
		"DATETIME":               7,
	}
)

Enum value maps for FieldConfig_FieldType.

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

Enum value maps for FieldConfig_IndexableOption.

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

Enum value maps for FieldConfig_DynamicFacetableOption.

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

Enum value maps for FieldConfig_SearchableOption.

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

Enum value maps for FieldConfig_RetrievableOption.

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

Enum value maps for FieldConfig_CompletableOption.

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

Enum value maps for FieldConfig_FilterableOption.

View Source 
var (
	FieldConfig_AdvancedSiteSearchDataSource_name = map[int32]string{
		0: "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
		1: "METATAGS",
		2: "PAGEMAP",
		3: "URI_PATTERN_MAPPING",
		4: "SCHEMA_ORG",
	}
	FieldConfig_AdvancedSiteSearchDataSource_value = map[string]int32{
		"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED": 0,
		"METATAGS":            1,
		"PAGEMAP":             2,
		"URI_PATTERN_MAPPING": 3,
		"SCHEMA_ORG":          4,
	}
)

Enum value maps for FieldConfig_AdvancedSiteSearchDataSource.

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

Enum value maps for SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition.

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

Enum value maps for SearchRequest_SearchAsYouTypeSpec_Condition.

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

Enum value maps for SearchResponse_Summary_SummarySkippedReason.

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

Enum value maps for SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison.

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

Enum value maps for SearchResponse_OneBoxResult_OneBoxType.

View Source 
var (
	FileSource_name = map[int32]string{
		0: "FILE_SOURCE_UNSPECIFIED",
		1: "FILE_SOURCE_INLINE",
		2: "FILE_SOURCE_LOCAL",
		3: "FILE_SOURCE_CLOUD_STORAGE",
		4: "FILE_SOURCE_CLOUD_DRIVE",
		5: "FILE_SOURCE_URL",
	}
	FileSource_value = map[string]int32{
		"FILE_SOURCE_UNSPECIFIED":   0,
		"FILE_SOURCE_INLINE":        1,
		"FILE_SOURCE_LOCAL":         2,
		"FILE_SOURCE_CLOUD_STORAGE": 3,
		"FILE_SOURCE_CLOUD_DRIVE":   4,
		"FILE_SOURCE_URL":           5,
	}
)

Enum value maps for FileSource.

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 (
	ImageCharacteristics_ColorSpace_name = map[int32]string{
		0: "COLOR_SPACE_UNSPECIFIED",
		1: "RGB",
		2: "CMYK",
		3: "GRAYSCALE",
		4: "YUV",
		5: "OTHER_COLOR_SPACE",
	}
	ImageCharacteristics_ColorSpace_value = map[string]int32{
		"COLOR_SPACE_UNSPECIFIED": 0,
		"RGB":                     1,
		"CMYK":                    2,
		"GRAYSCALE":               3,
		"YUV":                     4,
		"OTHER_COLOR_SPACE":       5,
	}
)

Enum value maps for ImageCharacteristics_ColorSpace.

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

Enum value maps for TargetSite_Type.

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

Enum value maps for TargetSite_IndexingStatus.

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

Enum value maps for SiteVerificationInfo_SiteVerificationState.

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

Enum value maps for RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.

View Source 
var AclConfigService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.AclConfigService",
	HandlerType: (*AclConfigServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UpdateAclConfig",
			Handler:    _AclConfigService_UpdateAclConfig_Handler,
		},
		{
			MethodName: "GetAclConfig",
			Handler:    _AclConfigService_GetAclConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/acl_config_service.proto",
}

AclConfigService_ServiceDesc is the grpc.ServiceDesc for AclConfigService 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 ChunkService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.ChunkService",
	HandlerType: (*ChunkServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetChunk",
			Handler:    _ChunkService_GetChunk_Handler,
		},
		{
			MethodName: "ListChunks",
			Handler:    _ChunkService_ListChunks_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/chunk_service.proto",
}

ChunkService_ServiceDesc is the grpc.ServiceDesc for ChunkService 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.v1alpha.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/v1alpha/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.v1alpha.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/v1alpha/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.v1alpha.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{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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,
		},
		{
			MethodName: "GetDocumentProcessingConfig",
			Handler:    _DataStoreService_GetDocumentProcessingConfig_Handler,
		},
		{
			MethodName: "UpdateDocumentProcessingConfig",
			Handler:    _DataStoreService_UpdateDocumentProcessingConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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: "GetProcessedDocument",
			Handler:    _DocumentService_GetProcessedDocument_Handler,
		},
		{
			MethodName: "BatchGetDocumentsMetadata",
			Handler:    _DocumentService_BatchGetDocumentsMetadata_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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,
		},
		{
			MethodName: "PauseEngine",
			Handler:    _EngineService_PauseEngine_Handler,
		},
		{
			MethodName: "ResumeEngine",
			Handler:    _EngineService_ResumeEngine_Handler,
		},
		{
			MethodName: "TuneEngine",
			Handler:    _EngineService_TuneEngine_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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 EstimateBillingService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.EstimateBillingService",
	HandlerType: (*EstimateBillingServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "EstimateDataSize",
			Handler:    _EstimateBillingService_EstimateDataSize_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto",
}

EstimateBillingService_ServiceDesc is the grpc.ServiceDesc for EstimateBillingService 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 EvaluationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.EvaluationService",
	HandlerType: (*EvaluationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetEvaluation",
			Handler:    _EvaluationService_GetEvaluation_Handler,
		},
		{
			MethodName: "ListEvaluations",
			Handler:    _EvaluationService_ListEvaluations_Handler,
		},
		{
			MethodName: "CreateEvaluation",
			Handler:    _EvaluationService_CreateEvaluation_Handler,
		},
		{
			MethodName: "ListEvaluationResults",
			Handler:    _EvaluationService_ListEvaluationResults_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/evaluation_service.proto",
}

EvaluationService_ServiceDesc is the grpc.ServiceDesc for EvaluationService 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_v1alpha_acl_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_acl_config_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_answer_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_chunk_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_chunk_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_common_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_completion_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_completion_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_control_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_control_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_conversation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_conversational_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_custom_tuning_model_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_data_store_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_data_store_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_document_processing_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_document_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_document_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_estimate_billing_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_evaluation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_evaluation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_grounded_generation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_grounding_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_import_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_project_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_project_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_purge_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_rank_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_recommendation_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_sample_query_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_sample_query_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_sample_query_set_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_sample_query_set_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_schema_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_schema_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_search_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_search_tuning_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_serving_config_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_serving_config_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_session_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_session_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_user_event_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_discoveryengine_v1alpha_user_event_service_proto protoreflect.FileDescriptor
View Source 
var GroundedGenerationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.GroundedGenerationService",
	HandlerType: (*GroundedGenerationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CheckGrounding",
			Handler:    _GroundedGenerationService_CheckGrounding_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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 ProjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.ProjectService",
	HandlerType: (*ProjectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetProject",
			Handler:    _ProjectService_GetProject_Handler,
		},
		{
			MethodName: "ProvisionProject",
			Handler:    _ProjectService_ProvisionProject_Handler,
		},
		{
			MethodName: "ReportConsentChange",
			Handler:    _ProjectService_ReportConsentChange_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.RankService",
	HandlerType: (*RankServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Rank",
			Handler:    _RankService_Rank_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.RecommendationService",
	HandlerType: (*RecommendationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Recommend",
			Handler:    _RecommendationService_Recommend_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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 SampleQueryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.SampleQueryService",
	HandlerType: (*SampleQueryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSampleQuery",
			Handler:    _SampleQueryService_GetSampleQuery_Handler,
		},
		{
			MethodName: "ListSampleQueries",
			Handler:    _SampleQueryService_ListSampleQueries_Handler,
		},
		{
			MethodName: "CreateSampleQuery",
			Handler:    _SampleQueryService_CreateSampleQuery_Handler,
		},
		{
			MethodName: "UpdateSampleQuery",
			Handler:    _SampleQueryService_UpdateSampleQuery_Handler,
		},
		{
			MethodName: "DeleteSampleQuery",
			Handler:    _SampleQueryService_DeleteSampleQuery_Handler,
		},
		{
			MethodName: "ImportSampleQueries",
			Handler:    _SampleQueryService_ImportSampleQueries_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/sample_query_service.proto",
}

SampleQueryService_ServiceDesc is the grpc.ServiceDesc for SampleQueryService 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 SampleQuerySetService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.discoveryengine.v1alpha.SampleQuerySetService",
	HandlerType: (*SampleQuerySetServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSampleQuerySet",
			Handler:    _SampleQuerySetService_GetSampleQuerySet_Handler,
		},
		{
			MethodName: "ListSampleQuerySets",
			Handler:    _SampleQuerySetService_ListSampleQuerySets_Handler,
		},
		{
			MethodName: "CreateSampleQuerySet",
			Handler:    _SampleQuerySetService_CreateSampleQuerySet_Handler,
		},
		{
			MethodName: "UpdateSampleQuerySet",
			Handler:    _SampleQuerySetService_UpdateSampleQuerySet_Handler,
		},
		{
			MethodName: "DeleteSampleQuerySet",
			Handler:    _SampleQuerySetService_DeleteSampleQuerySet_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto",
}

SampleQuerySetService_ServiceDesc is the grpc.ServiceDesc for SampleQuerySetService 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.v1alpha.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/v1alpha/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.v1alpha.SearchService",
	HandlerType: (*SearchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Search",
			Handler:    _SearchService_Search_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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/v1alpha/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.v1alpha.ServingConfigService",
	HandlerType: (*ServingConfigServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UpdateServingConfig",
			Handler:    _ServingConfigService_UpdateServingConfig_Handler,
		},
		{
			MethodName: "GetServingConfig",
			Handler:    _ServingConfigService_GetServingConfig_Handler,
		},
		{
			MethodName: "ListServingConfigs",
			Handler:    _ServingConfigService_ListServingConfigs_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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,
		},
		{
			MethodName: "ListFiles",
			Handler:    _SessionService_ListFiles_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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: "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,
		},
		{
			MethodName: "SetUriPatternDocumentData",
			Handler:    _SiteSearchEngineService_SetUriPatternDocumentData_Handler,
		},
		{
			MethodName: "GetUriPatternDocumentData",
			Handler:    _SiteSearchEngineService_GetUriPatternDocumentData_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/discoveryengine/v1alpha/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.v1alpha.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/v1alpha/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)

Functions

func RegisterAclConfigServiceServer added in v1.6.0 

func RegisterAclConfigServiceServer(s grpc.ServiceRegistrar, srv AclConfigServiceServer)

func RegisterChunkServiceServer added in v1.6.0 

func RegisterChunkServiceServer(s grpc.ServiceRegistrar, srv ChunkServiceServer)

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 

func RegisterConversationalSearchServiceServer(s grpc.ServiceRegistrar, srv ConversationalSearchServiceServer)

func RegisterDataStoreServiceServer 

func RegisterDataStoreServiceServer(s grpc.ServiceRegistrar, srv DataStoreServiceServer)

func RegisterDocumentServiceServer 

func RegisterDocumentServiceServer(s grpc.ServiceRegistrar, srv DocumentServiceServer)

func RegisterEngineServiceServer 

func RegisterEngineServiceServer(s grpc.ServiceRegistrar, srv EngineServiceServer)

func RegisterEstimateBillingServiceServer added in v1.6.0 

func RegisterEstimateBillingServiceServer(s grpc.ServiceRegistrar, srv EstimateBillingServiceServer)

func RegisterEvaluationServiceServer added in v1.10.0 

func RegisterEvaluationServiceServer(s grpc.ServiceRegistrar, srv EvaluationServiceServer)

func RegisterGroundedGenerationServiceServer added in v1.7.0 

func RegisterGroundedGenerationServiceServer(s grpc.ServiceRegistrar, srv GroundedGenerationServiceServer)

func RegisterProjectServiceServer added in v1.7.0 

func RegisterProjectServiceServer(s grpc.ServiceRegistrar, srv ProjectServiceServer)

func RegisterRankServiceServer added in v1.7.0 

func RegisterRankServiceServer(s grpc.ServiceRegistrar, srv RankServiceServer)

func RegisterRecommendationServiceServer 

func RegisterRecommendationServiceServer(s grpc.ServiceRegistrar, srv RecommendationServiceServer)

func RegisterSampleQueryServiceServer added in v1.10.0 

func RegisterSampleQueryServiceServer(s grpc.ServiceRegistrar, srv SampleQueryServiceServer)

func RegisterSampleQuerySetServiceServer added in v1.10.0 

func RegisterSampleQuerySetServiceServer(s grpc.ServiceRegistrar, srv SampleQuerySetServiceServer)

func RegisterSchemaServiceServer 

func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)

func RegisterSearchServiceServer 

func RegisterSearchServiceServer(s grpc.ServiceRegistrar, srv SearchServiceServer)

func RegisterSearchTuningServiceServer added in v1.4.0 

func RegisterSearchTuningServiceServer(s grpc.ServiceRegistrar, srv SearchTuningServiceServer)

func RegisterServingConfigServiceServer added in v1.6.0 

func RegisterServingConfigServiceServer(s grpc.ServiceRegistrar, srv ServingConfigServiceServer)

func RegisterSessionServiceServer added in v1.21.0 

func RegisterSessionServiceServer(s grpc.ServiceRegistrar, srv SessionServiceServer)

func RegisterSiteSearchEngineServiceServer 

func RegisterSiteSearchEngineServiceServer(s grpc.ServiceRegistrar, srv SiteSearchEngineServiceServer)

func RegisterUserEventServiceServer 

func RegisterUserEventServiceServer(s grpc.ServiceRegistrar, srv UserEventServiceServer)

Types

type AclConfig added in v1.6.0 

type AclConfig struct {

	// Immutable. The full resource name of the acl configuration.
	// Format:
	// `projects/{project}/locations/{location}/aclConfig`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Identity provider config.
	IdpConfig *IdpConfig `protobuf:"bytes,2,opt,name=idp_config,json=idpConfig,proto3" json:"idp_config,omitempty"`
	// contains filtered or unexported fields
}

Access Control Configuration.

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

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

Deprecated: Use AclConfig.ProtoReflect.Descriptor instead.

func (*AclConfig) GetIdpConfig added in v1.6.0 

func (x *AclConfig) GetIdpConfig() *IdpConfig

func (*AclConfig) GetName added in v1.6.0 

func (x *AclConfig) GetName() string

func (*AclConfig) ProtoMessage added in v1.6.0 

func (*AclConfig) ProtoMessage()

func (*AclConfig) ProtoReflect added in v1.6.0 

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

func (*AclConfig) Reset added in v1.6.0 

func (x *AclConfig) Reset()

func (*AclConfig) String added in v1.6.0 

func (x *AclConfig) String() string

type AclConfigServiceClient added in v1.6.0 

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

AclConfigServiceClient is the client API for AclConfigService service.

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

func NewAclConfigServiceClient added in v1.6.0 

func NewAclConfigServiceClient(cc grpc.ClientConnInterface) AclConfigServiceClient

type AclConfigServiceServer added in v1.6.0 

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

AclConfigServiceServer is the server API for AclConfigService service. All implementations should embed UnimplementedAclConfigServiceServer for forward compatibility

type AlloyDbSource added in v1.12.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.12.0 

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

Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.

func (*AlloyDbSource) GetClusterId added in v1.12.0 

func (x *AlloyDbSource) GetClusterId() string

func (*AlloyDbSource) GetDatabaseId added in v1.12.0 

func (x *AlloyDbSource) GetDatabaseId() string

func (*AlloyDbSource) GetGcsStagingDir added in v1.12.0 

func (x *AlloyDbSource) GetGcsStagingDir() string

func (*AlloyDbSource) GetLocationId added in v1.12.0 

func (x *AlloyDbSource) GetLocationId() string

func (*AlloyDbSource) GetProjectId added in v1.12.0 

func (x *AlloyDbSource) GetProjectId() string

func (*AlloyDbSource) GetTableId added in v1.12.0 

func (x *AlloyDbSource) GetTableId() string

func (*AlloyDbSource) ProtoMessage added in v1.12.0 

func (*AlloyDbSource) ProtoMessage()

func (*AlloyDbSource) ProtoReflect added in v1.12.0 

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

func (*AlloyDbSource) Reset added in v1.12.0 

func (x *AlloyDbSource) Reset()

func (*AlloyDbSource) String added in v1.12.0 

func (x *AlloyDbSource) String() string

type Answer added in v1.7.0 

type Answer struct {

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

Defines an answer.

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

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

Deprecated: Use Answer.ProtoReflect.Descriptor instead.

func (*Answer) GetAnswerSkippedReasons added in v1.7.0 

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

func (*Answer) GetAnswerText added in v1.7.0 

func (x *Answer) GetAnswerText() string

func (*Answer) GetCitations added in v1.7.0 

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

func (*Answer) GetCompleteTime added in v1.7.0 

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

func (*Answer) GetCreateTime added in v1.7.0 

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

func (*Answer) GetName added in v1.7.0 

func (x *Answer) GetName() string

func (*Answer) GetQueryUnderstandingInfo added in v1.7.0 

func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfo

func (*Answer) GetReferences added in v1.7.0 

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

func (*Answer) GetRelatedQuestions added in v1.7.0 

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

func (*Answer) GetState added in v1.7.0 

func (x *Answer) GetState() Answer_State

func (*Answer) GetSteps added in v1.7.0 

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

func (*Answer) ProtoMessage added in v1.7.0 

func (*Answer) ProtoMessage()

func (*Answer) ProtoReflect added in v1.7.0 

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

func (*Answer) Reset added in v1.7.0 

func (x *Answer) Reset()

func (*Answer) String added in v1.7.0 

func (x *Answer) String() string

type AnswerQueryRequest added in v1.7.0 

type AnswerQueryRequest struct {

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

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

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

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

Deprecated: Use AnswerQueryRequest.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest) GetAnswerGenerationSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetAnswerGenerationSpec() *AnswerQueryRequest_AnswerGenerationSpec

func (*AnswerQueryRequest) GetAsynchronousMode added in v1.7.0 

func (x *AnswerQueryRequest) GetAsynchronousMode() bool

func (*AnswerQueryRequest) GetQuery added in v1.7.0 

func (x *AnswerQueryRequest) GetQuery() *Query

func (*AnswerQueryRequest) GetQueryUnderstandingSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetQueryUnderstandingSpec() *AnswerQueryRequest_QueryUnderstandingSpec

func (*AnswerQueryRequest) GetRelatedQuestionsSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetRelatedQuestionsSpec() *AnswerQueryRequest_RelatedQuestionsSpec

func (*AnswerQueryRequest) GetSafetySpec added in v1.7.0 

func (x *AnswerQueryRequest) GetSafetySpec() *AnswerQueryRequest_SafetySpec

func (*AnswerQueryRequest) GetSearchSpec added in v1.7.0 

func (x *AnswerQueryRequest) GetSearchSpec() *AnswerQueryRequest_SearchSpec

func (*AnswerQueryRequest) GetServingConfig added in v1.7.0 

func (x *AnswerQueryRequest) GetServingConfig() string

func (*AnswerQueryRequest) GetSession added in v1.7.0 

func (x *AnswerQueryRequest) GetSession() string

func (*AnswerQueryRequest) GetUserLabels added in v1.12.0 

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

func (*AnswerQueryRequest) GetUserPseudoId added in v1.7.0 

func (x *AnswerQueryRequest) GetUserPseudoId() string

func (*AnswerQueryRequest) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest) ProtoMessage()

func (*AnswerQueryRequest) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest) Reset added in v1.7.0 

func (x *AnswerQueryRequest) Reset()

func (*AnswerQueryRequest) String added in v1.7.0 

func (x *AnswerQueryRequest) String() string

type AnswerQueryRequest_AnswerGenerationSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec struct {

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

Answer generation specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode() string

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent added in v1.8.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations() bool

func (*AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec() *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec() *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec struct {

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

Answer Generation Model specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion() string

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String() string

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec added in v1.7.0 

type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec struct {

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

Answer generation prompt specification.

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

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

Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble() string

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset()

func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec struct {

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

Query understanding specification.

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

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {

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

Query classification specification.

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

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String() string

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type int32

Query classification types. 

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

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor added in v1.7.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor() protoreflect.EnumDescriptor

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number() protoreflect.EnumNumber

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String added in v1.7.0 

func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String() string

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type added in v1.7.0 

func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type() protoreflect.EnumType

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec added in v1.7.0 

type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec struct {

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

Query rephraser specification.

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

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

Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable() bool

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps() int32

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset()

func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String() string

type AnswerQueryRequest_RelatedQuestionsSpec added in v1.7.0 

type AnswerQueryRequest_RelatedQuestionsSpec struct {

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

Related questions specification.

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

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

Deprecated: Use AnswerQueryRequest_RelatedQuestionsSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_RelatedQuestionsSpec) GetEnable added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) GetEnable() bool

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage()

func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_RelatedQuestionsSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) Reset()

func (*AnswerQueryRequest_RelatedQuestionsSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_RelatedQuestionsSpec) String() string

type AnswerQueryRequest_SafetySpec added in v1.7.0 

type AnswerQueryRequest_SafetySpec struct {

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

Safety specification.

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

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

Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SafetySpec) GetEnable added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) GetEnable() bool

func (*AnswerQueryRequest_SafetySpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SafetySpec) ProtoMessage()

func (*AnswerQueryRequest_SafetySpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SafetySpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) Reset()

func (*AnswerQueryRequest_SafetySpec) String added in v1.7.0 

func (x *AnswerQueryRequest_SafetySpec) String() string

type AnswerQueryRequest_SearchSpec added in v1.7.0 

type AnswerQueryRequest_SearchSpec struct {

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

Search specification.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec) GetInput added in v1.7.0 

func (m *AnswerQueryRequest_SearchSpec) GetInput() isAnswerQueryRequest_SearchSpec_Input

func (*AnswerQueryRequest_SearchSpec) GetSearchParams added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchParams() *AnswerQueryRequest_SearchSpec_SearchParams

func (*AnswerQueryRequest_SearchSpec) GetSearchResultList added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) GetSearchResultList() *AnswerQueryRequest_SearchSpec_SearchResultList

func (*AnswerQueryRequest_SearchSpec) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) Reset()

func (*AnswerQueryRequest_SearchSpec) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec) String() string

type AnswerQueryRequest_SearchSpec_SearchParams added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchParams struct {

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

Search parameters.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec() *SearchRequest_BoostSpec

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetCustomFineTuningSpec added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetCustomFineTuningSpec() *CustomFineTuningSpec

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs added in v1.8.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetFilter() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy() string

func (*AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultMode

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchParams) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchParams) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchParams) String() string

type AnswerQueryRequest_SearchSpec_SearchParams_ added in v1.7.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList struct {

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

Search result list.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_ added in v1.7.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult struct {

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

Search result.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent added in v1.7.0 

func (m *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent() isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo struct {

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

Chunk information.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_ added in v1.7.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo struct {

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

Unstructured document information.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ added in v1.7.0 

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

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext struct {

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

Document context.

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer struct {

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

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

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String() string

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment added in v1.7.0 

type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment struct {

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

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

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

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

Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment.ProtoReflect.Descriptor instead.

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier() string

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage added in v1.7.0 

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset()

func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String added in v1.7.0 

func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String() string

type AnswerQueryResponse added in v1.7.0 

type AnswerQueryResponse struct {

	// Answer resource object.
	// If
	// [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
	// is greater than 1, use
	// [Answer.name][google.cloud.discoveryengine.v1alpha.Answer.name] to fetch
	// answer information using
	// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.ConversationalSearchService.AnswerQuery] method.

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

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

Deprecated: Use AnswerQueryResponse.ProtoReflect.Descriptor instead.

func (*AnswerQueryResponse) GetAnswer added in v1.7.0 

func (x *AnswerQueryResponse) GetAnswer() *Answer

func (*AnswerQueryResponse) GetAnswerQueryToken added in v1.8.0 

func (x *AnswerQueryResponse) GetAnswerQueryToken() string

func (*AnswerQueryResponse) GetSession added in v1.7.0 

func (x *AnswerQueryResponse) GetSession() *Session

func (*AnswerQueryResponse) ProtoMessage added in v1.7.0 

func (*AnswerQueryResponse) ProtoMessage()

func (*AnswerQueryResponse) ProtoReflect added in v1.7.0 

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

func (*AnswerQueryResponse) Reset added in v1.7.0 

func (x *AnswerQueryResponse) Reset()

func (*AnswerQueryResponse) String added in v1.7.0 

func (x *AnswerQueryResponse) String() string

type Answer_AnswerSkippedReason added in v1.7.0 

type Answer_AnswerSkippedReason int32

An enum for answer skipped reasons. 

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

func (Answer_AnswerSkippedReason) Descriptor added in v1.7.0 

func (Answer_AnswerSkippedReason) Descriptor() protoreflect.EnumDescriptor

func (Answer_AnswerSkippedReason) Enum added in v1.7.0 

func (x Answer_AnswerSkippedReason) Enum() *Answer_AnswerSkippedReason

func (Answer_AnswerSkippedReason) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.

func (Answer_AnswerSkippedReason) Number added in v1.7.0 

func (x Answer_AnswerSkippedReason) Number() protoreflect.EnumNumber

func (Answer_AnswerSkippedReason) String added in v1.7.0 

func (x Answer_AnswerSkippedReason) String() string

func (Answer_AnswerSkippedReason) Type added in v1.7.0 

func (Answer_AnswerSkippedReason) Type() protoreflect.EnumType

type Answer_Citation added in v1.7.0 

type Answer_Citation struct {

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

Citation info for a segment.

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

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

Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.

func (*Answer_Citation) GetEndIndex added in v1.7.0 

func (x *Answer_Citation) GetEndIndex() int64

func (*Answer_Citation) GetSources added in v1.7.0 

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

func (*Answer_Citation) GetStartIndex added in v1.7.0 

func (x *Answer_Citation) GetStartIndex() int64

func (*Answer_Citation) ProtoMessage added in v1.7.0 

func (*Answer_Citation) ProtoMessage()

func (*Answer_Citation) ProtoReflect added in v1.7.0 

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

func (*Answer_Citation) Reset added in v1.7.0 

func (x *Answer_Citation) Reset()

func (*Answer_Citation) String added in v1.7.0 

func (x *Answer_Citation) String() string

type Answer_CitationSource added in v1.7.0 

type Answer_CitationSource struct {

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

Citation source.

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

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

Deprecated: Use Answer_CitationSource.ProtoReflect.Descriptor instead.

func (*Answer_CitationSource) GetReferenceId added in v1.7.0 

func (x *Answer_CitationSource) GetReferenceId() string

func (*Answer_CitationSource) ProtoMessage added in v1.7.0 

func (*Answer_CitationSource) ProtoMessage()

func (*Answer_CitationSource) ProtoReflect added in v1.7.0 

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

func (*Answer_CitationSource) Reset added in v1.7.0 

func (x *Answer_CitationSource) Reset()

func (*Answer_CitationSource) String added in v1.7.0 

func (x *Answer_CitationSource) String() string

type Answer_QueryUnderstandingInfo added in v1.7.0 

type Answer_QueryUnderstandingInfo struct {

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

Query understanding information.

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

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

Deprecated: Use Answer_QueryUnderstandingInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo) GetQueryClassificationInfo added in v1.7.0 

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

func (*Answer_QueryUnderstandingInfo) ProtoMessage added in v1.7.0 

func (*Answer_QueryUnderstandingInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_QueryUnderstandingInfo) Reset added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo) Reset()

func (*Answer_QueryUnderstandingInfo) String added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo added in v1.7.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {

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

Query classification information.

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

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive() bool

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType() Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage added in v1.7.0 

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset()

func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) String added in v1.7.0 

func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) String() string

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type added in v1.7.0 

type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type int32

Query classification types. 

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

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor added in v1.7.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor() protoreflect.EnumDescriptor

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum() *Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number() protoreflect.EnumNumber

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String added in v1.7.0 

func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String() string

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type added in v1.7.0 

func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type() protoreflect.EnumType

type Answer_Reference added in v1.7.0 

type Answer_Reference struct {

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

Reference.

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

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

Deprecated: Use Answer_Reference.ProtoReflect.Descriptor instead.

func (*Answer_Reference) GetChunkInfo added in v1.7.0 

func (x *Answer_Reference) GetChunkInfo() *Answer_Reference_ChunkInfo

func (*Answer_Reference) GetContent added in v1.7.0 

func (m *Answer_Reference) GetContent() isAnswer_Reference_Content

func (*Answer_Reference) GetStructuredDocumentInfo added in v1.12.0 

func (x *Answer_Reference) GetStructuredDocumentInfo() *Answer_Reference_StructuredDocumentInfo

func (*Answer_Reference) GetUnstructuredDocumentInfo added in v1.7.0 

func (x *Answer_Reference) GetUnstructuredDocumentInfo() *Answer_Reference_UnstructuredDocumentInfo

func (*Answer_Reference) ProtoMessage added in v1.7.0 

func (*Answer_Reference) ProtoMessage()

func (*Answer_Reference) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference) Reset added in v1.7.0 

func (x *Answer_Reference) Reset()

func (*Answer_Reference) String added in v1.7.0 

func (x *Answer_Reference) String() string

type Answer_Reference_ChunkInfo added in v1.7.0 

type Answer_Reference_ChunkInfo struct {

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

Chunk information.

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

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

Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo) GetChunk added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetChunk() string

func (*Answer_Reference_ChunkInfo) GetContent added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetContent() string

func (*Answer_Reference_ChunkInfo) GetDocumentMetadata added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetDocumentMetadata() *Answer_Reference_ChunkInfo_DocumentMetadata

func (*Answer_Reference_ChunkInfo) GetRelevanceScore added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Reference_ChunkInfo) ProtoMessage added in v1.7.0 

func (*Answer_Reference_ChunkInfo) ProtoMessage()

func (*Answer_Reference_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_ChunkInfo) Reset added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) Reset()

func (*Answer_Reference_ChunkInfo) String added in v1.7.0 

func (x *Answer_Reference_ChunkInfo) String() string

type Answer_Reference_ChunkInfo_ added in v1.7.0 

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

type Answer_Reference_ChunkInfo_DocumentMetadata added in v1.7.0 

type Answer_Reference_ChunkInfo_DocumentMetadata struct {

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

Document metadata.

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

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

Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData added in v1.8.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetUri() string

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage added in v1.7.0 

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) Reset()

func (*Answer_Reference_ChunkInfo_DocumentMetadata) String added in v1.7.0 

func (x *Answer_Reference_ChunkInfo_DocumentMetadata) String() string

type Answer_Reference_StructuredDocumentInfo added in v1.12.0 

type Answer_Reference_StructuredDocumentInfo struct {

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

Structured search information.

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

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

Deprecated: Use Answer_Reference_StructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_StructuredDocumentInfo) GetDocument added in v1.12.0 

func (x *Answer_Reference_StructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_StructuredDocumentInfo) GetStructData added in v1.12.0 

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

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage added in v1.12.0 

func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_StructuredDocumentInfo) ProtoReflect added in v1.12.0 

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

func (*Answer_Reference_StructuredDocumentInfo) Reset added in v1.12.0 

func (x *Answer_Reference_StructuredDocumentInfo) Reset()

func (*Answer_Reference_StructuredDocumentInfo) String added in v1.12.0 

func (x *Answer_Reference_StructuredDocumentInfo) String() string

type Answer_Reference_StructuredDocumentInfo_ added in v1.12.0 

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

type Answer_Reference_UnstructuredDocumentInfo added in v1.7.0 

type Answer_Reference_UnstructuredDocumentInfo struct {

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

Unstructured document information.

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

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents added in v1.7.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) GetDocument added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetDocument() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetStructData added in v1.8.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) GetTitle added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetTitle() string

func (*Answer_Reference_UnstructuredDocumentInfo) GetUri added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) GetUri() string

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage added in v1.7.0 

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo) Reset added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo) String added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo) String() string

type Answer_Reference_UnstructuredDocumentInfo_ added in v1.7.0 

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

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent added in v1.7.0 

type Answer_Reference_UnstructuredDocumentInfo_ChunkContent struct {

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

Chunk content.

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

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

Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier() string

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore added in v1.12.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore() float32

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage added in v1.7.0 

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect added in v1.7.0 

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

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset()

func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String added in v1.7.0 

func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String() string

type Answer_State added in v1.7.0 

type Answer_State int32

Enumeration of the state of the answer generation. 

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

func (Answer_State) Descriptor added in v1.7.0 

func (Answer_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_State) Enum added in v1.7.0 

func (x Answer_State) Enum() *Answer_State

func (Answer_State) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_State.Descriptor instead.

func (Answer_State) Number added in v1.7.0 

func (x Answer_State) Number() protoreflect.EnumNumber

func (Answer_State) String added in v1.7.0 

func (x Answer_State) String() string

func (Answer_State) Type added in v1.7.0 

func (Answer_State) Type() protoreflect.EnumType

type Answer_Step added in v1.7.0 

type Answer_Step struct {

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

Step information.

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

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

Deprecated: Use Answer_Step.ProtoReflect.Descriptor instead.

func (*Answer_Step) GetActions added in v1.7.0 

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

func (*Answer_Step) GetDescription added in v1.7.0 

func (x *Answer_Step) GetDescription() string

func (*Answer_Step) GetState added in v1.7.0 

func (x *Answer_Step) GetState() Answer_Step_State

func (*Answer_Step) GetThought added in v1.7.0 

func (x *Answer_Step) GetThought() string

func (*Answer_Step) ProtoMessage added in v1.7.0 

func (*Answer_Step) ProtoMessage()

func (*Answer_Step) ProtoReflect added in v1.7.0 

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

func (*Answer_Step) Reset added in v1.7.0 

func (x *Answer_Step) Reset()

func (*Answer_Step) String added in v1.7.0 

func (x *Answer_Step) String() string

type Answer_Step_Action added in v1.7.0 

type Answer_Step_Action struct {

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

Action.

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

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

Deprecated: Use Answer_Step_Action.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action) GetAction added in v1.7.0 

func (m *Answer_Step_Action) GetAction() isAnswer_Step_Action_Action

func (*Answer_Step_Action) GetObservation added in v1.7.0 

func (x *Answer_Step_Action) GetObservation() *Answer_Step_Action_Observation

func (*Answer_Step_Action) GetSearchAction added in v1.7.0 

func (x *Answer_Step_Action) GetSearchAction() *Answer_Step_Action_SearchAction

func (*Answer_Step_Action) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action) ProtoMessage()

func (*Answer_Step_Action) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action) Reset added in v1.7.0 

func (x *Answer_Step_Action) Reset()

func (*Answer_Step_Action) String added in v1.7.0 

func (x *Answer_Step_Action) String() string

type Answer_Step_Action_Observation added in v1.7.0 

type Answer_Step_Action_Observation struct {

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

Observation.

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

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

Deprecated: Use Answer_Step_Action_Observation.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation) GetSearchResults added in v1.7.0 

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

func (*Answer_Step_Action_Observation) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation) ProtoMessage()

func (*Answer_Step_Action_Observation) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation) Reset()

func (*Answer_Step_Action_Observation) String added in v1.7.0 

func (x *Answer_Step_Action_Observation) String() string

type Answer_Step_Action_Observation_SearchResult added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult struct {

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

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult) GetChunkInfo added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetDocument added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetDocument() string

func (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetStructData added in v1.12.0 

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

func (*Answer_Step_Action_Observation_SearchResult) GetTitle added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetTitle() string

func (*Answer_Step_Action_Observation_SearchResult) GetUri added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) GetUri() string

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) Reset()

func (*Answer_Step_Action_Observation_SearchResult) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult) String() string

type Answer_Step_Action_Observation_SearchResult_ChunkInfo added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult_ChunkInfo struct {

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

Chunk information.

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent() string

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore() float32

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) String() string

type Answer_Step_Action_Observation_SearchResult_SnippetInfo added in v1.7.0 

type Answer_Step_Action_Observation_SearchResult_SnippetInfo struct {

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

Snippet information.

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

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

Deprecated: Use Answer_Step_Action_Observation_SearchResult_SnippetInfo.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus() string

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset()

func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) String added in v1.7.0 

func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) String() string

type Answer_Step_Action_SearchAction added in v1.7.0 

type Answer_Step_Action_SearchAction struct {

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

Search action.

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

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

Deprecated: Use Answer_Step_Action_SearchAction.ProtoReflect.Descriptor instead.

func (*Answer_Step_Action_SearchAction) GetQuery added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) GetQuery() string

func (*Answer_Step_Action_SearchAction) ProtoMessage added in v1.7.0 

func (*Answer_Step_Action_SearchAction) ProtoMessage()

func (*Answer_Step_Action_SearchAction) ProtoReflect added in v1.7.0 

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

func (*Answer_Step_Action_SearchAction) Reset added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) Reset()

func (*Answer_Step_Action_SearchAction) String added in v1.7.0 

func (x *Answer_Step_Action_SearchAction) String() string

type Answer_Step_Action_SearchAction_ added in v1.7.0 

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

type Answer_Step_State added in v1.7.0 

type Answer_Step_State int32

Enumeration of the state of the step. 

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

func (Answer_Step_State) Descriptor added in v1.7.0 

func (Answer_Step_State) Descriptor() protoreflect.EnumDescriptor

func (Answer_Step_State) Enum added in v1.7.0 

func (x Answer_Step_State) Enum() *Answer_Step_State

func (Answer_Step_State) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use Answer_Step_State.Descriptor instead.

func (Answer_Step_State) Number added in v1.7.0 

func (x Answer_Step_State) Number() protoreflect.EnumNumber

func (Answer_Step_State) String added in v1.7.0 

func (x Answer_Step_State) String() string

func (Answer_Step_State) Type added in v1.7.0 

func (Answer_Step_State) Type() protoreflect.EnumType

type BatchCreateTargetSiteMetadata added in v1.4.0 

type BatchCreateTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSiteMetadata) GetCreateTime added in v1.4.0 

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

func (*BatchCreateTargetSiteMetadata) GetUpdateTime added in v1.4.0 

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

func (*BatchCreateTargetSiteMetadata) ProtoMessage added in v1.4.0 

func (*BatchCreateTargetSiteMetadata) ProtoMessage()

func (*BatchCreateTargetSiteMetadata) ProtoReflect added in v1.4.0 

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

func (*BatchCreateTargetSiteMetadata) Reset added in v1.4.0 

func (x *BatchCreateTargetSiteMetadata) Reset()

func (*BatchCreateTargetSiteMetadata) String added in v1.4.0 

func (x *BatchCreateTargetSiteMetadata) String() string

type BatchCreateTargetSitesRequest added in v1.4.0 

type BatchCreateTargetSitesRequest struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesRequest) GetParent added in v1.4.0 

func (x *BatchCreateTargetSitesRequest) GetParent() string

func (*BatchCreateTargetSitesRequest) GetRequests added in v1.4.0 

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

func (*BatchCreateTargetSitesRequest) ProtoMessage added in v1.4.0 

func (*BatchCreateTargetSitesRequest) ProtoMessage()

func (*BatchCreateTargetSitesRequest) ProtoReflect added in v1.4.0 

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

func (*BatchCreateTargetSitesRequest) Reset added in v1.4.0 

func (x *BatchCreateTargetSitesRequest) Reset()

func (*BatchCreateTargetSitesRequest) String added in v1.4.0 

func (x *BatchCreateTargetSitesRequest) String() string

type BatchCreateTargetSitesResponse added in v1.4.0 

type BatchCreateTargetSitesResponse struct {

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

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

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

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

Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTargetSitesResponse) GetTargetSites added in v1.4.0 

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

func (*BatchCreateTargetSitesResponse) ProtoMessage added in v1.4.0 

func (*BatchCreateTargetSitesResponse) ProtoMessage()

func (*BatchCreateTargetSitesResponse) ProtoReflect added in v1.4.0 

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

func (*BatchCreateTargetSitesResponse) Reset added in v1.4.0 

func (x *BatchCreateTargetSitesResponse) Reset()

func (*BatchCreateTargetSitesResponse) String added in v1.4.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.v1alpha.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.v1alpha.DocumentService.BatchGetDocumentsMetadata] method.

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

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

Deprecated: Use BatchGetDocumentsMetadataRequest.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest) GetMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetMatcher() *BatchGetDocumentsMetadataRequest_Matcher

func (*BatchGetDocumentsMetadataRequest) GetParent added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) GetParent() string

func (*BatchGetDocumentsMetadataRequest) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) Reset()

func (*BatchGetDocumentsMetadataRequest) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest) String() string

type BatchGetDocumentsMetadataRequest_Matcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_Matcher struct {

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

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

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

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

Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataRequest_Matcher) GetMatcher added in v1.14.0 

func (m *BatchGetDocumentsMetadataRequest_Matcher) GetMatcher() isBatchGetDocumentsMetadataRequest_Matcher_Matcher

func (*BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher() *BatchGetDocumentsMetadataRequest_UrisMatcher

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage()

func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataRequest_Matcher) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) Reset()

func (*BatchGetDocumentsMetadataRequest_Matcher) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataRequest_Matcher) String() string

type BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher added in v1.14.0 

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

type BatchGetDocumentsMetadataRequest_UrisMatcher added in v1.14.0 

type BatchGetDocumentsMetadataRequest_UrisMatcher struct {

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

Matcher for the Document[google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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 `` /* 146-byte string literal not displayed */
	// The timestamp of the last time the
	// [Document][google.cloud.discoveryengine.v1alpha.Document] was last
	// indexed.
	LastRefreshedTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_refreshed_time,json=lastRefreshedTime,proto3" json:"last_refreshed_time,omitempty"`
	// contains filtered or unexported fields
}

The metadata of a Document[google.cloud.discoveryengine.v1alpha.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) 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.v1alpha.Document].
	//
	// Types that are assignable to MatcherValue:
	//
	//	*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri
	MatcherValue isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue `protobuf_oneof:"matcher_value"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue added in v1.14.0 

func (m *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue() isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri() string

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage added in v1.14.0 

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect added in v1.14.0 

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

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset()

func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String added in v1.14.0 

func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String() string

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri added in v1.14.0 

type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri struct {
	// If match by URI, the URI of the
	// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]. 

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

func (BatchGetDocumentsMetadataResponse_State) Descriptor added in v1.14.0 

func (BatchGetDocumentsMetadataResponse_State) Descriptor() protoreflect.EnumDescriptor

func (BatchGetDocumentsMetadataResponse_State) Enum added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Enum() *BatchGetDocumentsMetadataResponse_State

func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor deprecated added in v1.14.0 

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

Deprecated: Use BatchGetDocumentsMetadataResponse_State.Descriptor instead.

func (BatchGetDocumentsMetadataResponse_State) Number added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) Number() protoreflect.EnumNumber

func (BatchGetDocumentsMetadataResponse_State) String added in v1.14.0 

func (x BatchGetDocumentsMetadataResponse_State) String() string

func (BatchGetDocumentsMetadataResponse_State) Type added in v1.14.0 

func (BatchGetDocumentsMetadataResponse_State) Type() protoreflect.EnumType

type BatchVerifyTargetSitesMetadata added in v1.4.0 

type BatchVerifyTargetSitesMetadata struct {

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesMetadata) GetCreateTime added in v1.4.0 

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

func (*BatchVerifyTargetSitesMetadata) GetUpdateTime added in v1.4.0 

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

func (*BatchVerifyTargetSitesMetadata) ProtoMessage added in v1.4.0 

func (*BatchVerifyTargetSitesMetadata) ProtoMessage()

func (*BatchVerifyTargetSitesMetadata) ProtoReflect added in v1.4.0 

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

func (*BatchVerifyTargetSitesMetadata) Reset added in v1.4.0 

func (x *BatchVerifyTargetSitesMetadata) Reset()

func (*BatchVerifyTargetSitesMetadata) String added in v1.4.0 

func (x *BatchVerifyTargetSitesMetadata) String() string

type BatchVerifyTargetSitesRequest added in v1.4.0 

type BatchVerifyTargetSitesRequest struct {

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesRequest) GetParent added in v1.4.0 

func (x *BatchVerifyTargetSitesRequest) GetParent() string

func (*BatchVerifyTargetSitesRequest) ProtoMessage added in v1.4.0 

func (*BatchVerifyTargetSitesRequest) ProtoMessage()

func (*BatchVerifyTargetSitesRequest) ProtoReflect added in v1.4.0 

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

func (*BatchVerifyTargetSitesRequest) Reset added in v1.4.0 

func (x *BatchVerifyTargetSitesRequest) Reset()

func (*BatchVerifyTargetSitesRequest) String added in v1.4.0 

func (x *BatchVerifyTargetSitesRequest) String() string

type BatchVerifyTargetSitesResponse added in v1.4.0 

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

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

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

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

Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.

func (*BatchVerifyTargetSitesResponse) ProtoMessage added in v1.4.0 

func (*BatchVerifyTargetSitesResponse) ProtoMessage()

func (*BatchVerifyTargetSitesResponse) ProtoReflect added in v1.4.0 

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

func (*BatchVerifyTargetSitesResponse) Reset added in v1.4.0 

func (x *BatchVerifyTargetSitesResponse) Reset()

func (*BatchVerifyTargetSitesResponse) String added in v1.4.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.v1alpha.UserEvent] per row.
	//
	// Supported values for document imports:
	//
	// * `document` (default): One
	// [Document][google.cloud.discoveryengine.v1alpha.Document] format per
	//
	//	row. Each document must have a valid
	//	[Document.id][google.cloud.discoveryengine.v1alpha.Document.id] and one
	//	of
	//	[Document.json_data][google.cloud.discoveryengine.v1alpha.Document.json_data]
	//	or
	//	[Document.struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data].
	//   - `custom`: One custom data per row in arbitrary format that conforms to
	//     the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
	//     data store. This can only be used by 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 `` /* 137-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.v1alpha.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 `` /* 137-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.v1alpha.BigtableOptions_Type" json:"type,omitempty"`
	// The list of objects that contains column level information for each
	// column. If a column is not present in this list it will be ignored.
	Columns []*BigtableOptions_BigtableColumn `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
	// contains filtered or unexported fields
}

The column family of the Bigtable.

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

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

Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.

func (*BigtableOptions_BigtableColumnFamily) GetColumns added in v1.7.0 

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

func (*BigtableOptions_BigtableColumnFamily) GetEncoding added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetEncoding() BigtableOptions_Encoding

func (*BigtableOptions_BigtableColumnFamily) GetFieldName added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() string

func (*BigtableOptions_BigtableColumnFamily) GetType added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) GetType() BigtableOptions_Type

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage added in v1.7.0 

func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()

func (*BigtableOptions_BigtableColumnFamily) ProtoReflect added in v1.7.0 

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

func (*BigtableOptions_BigtableColumnFamily) Reset added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) Reset()

func (*BigtableOptions_BigtableColumnFamily) String added in v1.7.0 

func (x *BigtableOptions_BigtableColumnFamily) String() string

type BigtableOptions_Encoding added in v1.7.0 

type BigtableOptions_Encoding int32

The encoding mode of a Bigtable column or column family. 

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

func (BigtableOptions_Encoding) Descriptor added in v1.7.0 

func (BigtableOptions_Encoding) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Encoding) Enum added in v1.7.0 

func (x BigtableOptions_Encoding) Enum() *BigtableOptions_Encoding

func (BigtableOptions_Encoding) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Encoding.Descriptor instead.

func (BigtableOptions_Encoding) Number added in v1.7.0 

func (x BigtableOptions_Encoding) Number() protoreflect.EnumNumber

func (BigtableOptions_Encoding) String added in v1.7.0 

func (x BigtableOptions_Encoding) String() string

func (BigtableOptions_Encoding) Type added in v1.7.0 

func (BigtableOptions_Encoding) Type() protoreflect.EnumType

type BigtableOptions_Type added in v1.7.0 

type BigtableOptions_Type int32

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

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

func (BigtableOptions_Type) Descriptor added in v1.7.0 

func (BigtableOptions_Type) Descriptor() protoreflect.EnumDescriptor

func (BigtableOptions_Type) Enum added in v1.7.0 

func (x BigtableOptions_Type) Enum() *BigtableOptions_Type

func (BigtableOptions_Type) EnumDescriptor deprecated added in v1.7.0 

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

Deprecated: Use BigtableOptions_Type.Descriptor instead.

func (BigtableOptions_Type) Number added in v1.7.0 

func (x BigtableOptions_Type) Number() protoreflect.EnumNumber

func (BigtableOptions_Type) String added in v1.7.0 

func (x BigtableOptions_Type) String() string

func (BigtableOptions_Type) Type added in v1.7.0 

func (BigtableOptions_Type) Type() protoreflect.EnumType

type BigtableSource added in v1.7.0 

type BigtableSource struct {

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

The Cloud Bigtable source for importing data.

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

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

Deprecated: Use BigtableSource.ProtoReflect.Descriptor instead.

func (*BigtableSource) GetBigtableOptions added in v1.7.0 

func (x *BigtableSource) GetBigtableOptions() *BigtableOptions

func (*BigtableSource) GetInstanceId added in v1.7.0 

func (x *BigtableSource) GetInstanceId() string

func (*BigtableSource) GetProjectId added in v1.7.0 

func (x *BigtableSource) GetProjectId() string

func (*BigtableSource) GetTableId added in v1.7.0 

func (x *BigtableSource) GetTableId() string

func (*BigtableSource) ProtoMessage added in v1.7.0 

func (*BigtableSource) ProtoMessage()

func (*BigtableSource) ProtoReflect added in v1.7.0 

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

func (*BigtableSource) Reset added in v1.7.0 

func (x *BigtableSource) Reset()

func (*BigtableSource) String added in v1.7.0 

func (x *BigtableSource) String() string

type CheckGroundingRequest added in v1.7.0 

type CheckGroundingRequest struct {

	// Required. The resource name of the grounding config, such as
	// `projects/*/locations/global/groundingConfigs/default_grounding_config`.
	GroundingConfig string `protobuf:"bytes,1,opt,name=grounding_config,json=groundingConfig,proto3" json:"grounding_config,omitempty"`
	// Answer candidate to check. Can have a maximum length of 1024 characters.
	AnswerCandidate string `protobuf:"bytes,2,opt,name=answer_candidate,json=answerCandidate,proto3" json:"answer_candidate,omitempty"`
	// List of facts for the grounding check.
	// We support up to 200 facts.
	Facts []*GroundingFact `protobuf:"bytes,3,rep,name=facts,proto3" json:"facts,omitempty"`
	// Configuration of the grounding check.
	GroundingSpec *CheckGroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
	// The user labels applied to a resource must meet the following requirements:
	//
	//   - Each resource can have multiple labels, up to a maximum of 64.
	//   - Each label must be a key-value pair.
	//   - Keys have a minimum length of 1 character and a maximum length of 63
	//     characters and cannot be empty. Values can be empty and have a maximum
	//     length of 63 characters.
	//   - Keys and values can contain only lowercase letters, numeric characters,
	//     underscores, and dashes. All characters must use UTF-8 encoding, and
	//     international characters are allowed.
	//   - The key portion of a label must be unique. However, you can use the same
	//     key with multiple resources.
	//   - Keys must start with a lowercase letter or international character.
	//
	// See [Google Cloud
	// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
	// for more details.
	UserLabels map[string]string `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CheckGroundingRequest.ProtoReflect.Descriptor instead.

func (*CheckGroundingRequest) GetAnswerCandidate added in v1.7.0 

func (x *CheckGroundingRequest) GetAnswerCandidate() string

func (*CheckGroundingRequest) GetFacts added in v1.7.0 

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

func (*CheckGroundingRequest) GetGroundingConfig added in v1.7.0 

func (x *CheckGroundingRequest) GetGroundingConfig() string

func (*CheckGroundingRequest) GetGroundingSpec added in v1.7.0 

func (x *CheckGroundingRequest) GetGroundingSpec() *CheckGroundingSpec

func (*CheckGroundingRequest) GetUserLabels added in v1.8.0 

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

func (*CheckGroundingRequest) ProtoMessage added in v1.7.0 

func (*CheckGroundingRequest) ProtoMessage()

func (*CheckGroundingRequest) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingRequest) Reset added in v1.7.0 

func (x *CheckGroundingRequest) Reset()

func (*CheckGroundingRequest) String added in v1.7.0 

func (x *CheckGroundingRequest) String() string

type CheckGroundingResponse added in v1.7.0 

type CheckGroundingResponse struct {

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

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

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

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

Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse) GetCitedChunks added in v1.7.0 

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

func (*CheckGroundingResponse) GetClaims added in v1.7.0 

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

func (*CheckGroundingResponse) GetSupportScore added in v1.7.0 

func (x *CheckGroundingResponse) GetSupportScore() float32

func (*CheckGroundingResponse) ProtoMessage added in v1.7.0 

func (*CheckGroundingResponse) ProtoMessage()

func (*CheckGroundingResponse) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingResponse) Reset added in v1.7.0 

func (x *CheckGroundingResponse) Reset()

func (*CheckGroundingResponse) String added in v1.7.0 

func (x *CheckGroundingResponse) String() string

type CheckGroundingResponse_Claim added in v1.7.0 

type CheckGroundingResponse_Claim struct {

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

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

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

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

Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.

func (*CheckGroundingResponse_Claim) GetCitationIndices added in v1.7.0 

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

func (*CheckGroundingResponse_Claim) GetClaimText added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetClaimText() string

func (*CheckGroundingResponse_Claim) GetEndPos added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetEndPos() int32

func (*CheckGroundingResponse_Claim) GetGroundingCheckRequired added in v1.8.0 

func (x *CheckGroundingResponse_Claim) GetGroundingCheckRequired() bool

func (*CheckGroundingResponse_Claim) GetStartPos added in v1.7.0 

func (x *CheckGroundingResponse_Claim) GetStartPos() int32

func (*CheckGroundingResponse_Claim) ProtoMessage added in v1.7.0 

func (*CheckGroundingResponse_Claim) ProtoMessage()

func (*CheckGroundingResponse_Claim) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingResponse_Claim) Reset added in v1.7.0 

func (x *CheckGroundingResponse_Claim) Reset()

func (*CheckGroundingResponse_Claim) String added in v1.7.0 

func (x *CheckGroundingResponse_Claim) String() string

type CheckGroundingSpec added in v1.7.0 

type CheckGroundingSpec struct {

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

Specification for the grounding check.

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

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

Deprecated: Use CheckGroundingSpec.ProtoReflect.Descriptor instead.

func (*CheckGroundingSpec) GetCitationThreshold added in v1.7.0 

func (x *CheckGroundingSpec) GetCitationThreshold() float64

func (*CheckGroundingSpec) ProtoMessage added in v1.7.0 

func (*CheckGroundingSpec) ProtoMessage()

func (*CheckGroundingSpec) ProtoReflect added in v1.7.0 

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

func (*CheckGroundingSpec) Reset added in v1.7.0 

func (x *CheckGroundingSpec) Reset()

func (*CheckGroundingSpec) String added in v1.7.0 

func (x *CheckGroundingSpec) String() string

type Chunk added in v1.6.0 

type Chunk struct {

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

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

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

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetChunkMetadata added in v1.7.0 

func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadata

func (*Chunk) GetContent added in v1.6.0 

func (x *Chunk) GetContent() string

func (*Chunk) GetDerivedStructData added in v1.6.0 

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

func (*Chunk) GetDocumentMetadata added in v1.6.0 

func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadata

func (*Chunk) GetId added in v1.6.0 

func (x *Chunk) GetId() string

func (*Chunk) GetName added in v1.6.0 

func (x *Chunk) GetName() string

func (*Chunk) GetPageSpan added in v1.7.0 

func (x *Chunk) GetPageSpan() *Chunk_PageSpan

func (*Chunk) GetRelevanceScore added in v1.8.0 

func (x *Chunk) GetRelevanceScore() float64

func (*Chunk) ProtoMessage added in v1.6.0 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect added in v1.6.0 

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

func (*Chunk) Reset added in v1.6.0 

func (x *Chunk) Reset()

func (*Chunk) String added in v1.6.0 

func (x *Chunk) String() string

type ChunkServiceClient added in v1.6.0 

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

ChunkServiceClient is the client API for ChunkService service.

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

func NewChunkServiceClient added in v1.6.0 

func NewChunkServiceClient(cc grpc.ClientConnInterface) ChunkServiceClient

type ChunkServiceServer added in v1.6.0 

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

ChunkServiceServer is the server API for ChunkService service. All implementations should embed UnimplementedChunkServiceServer for forward compatibility

type Chunk_ChunkMetadata added in v1.7.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.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
	// This field is only populated on
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
	// This field is only populated on
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchService.Search] API.

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

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

Deprecated: Use Chunk_ChunkMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_ChunkMetadata) GetNextChunks added in v1.7.0 

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

func (*Chunk_ChunkMetadata) GetPreviousChunks added in v1.7.0 

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

func (*Chunk_ChunkMetadata) ProtoMessage added in v1.7.0 

func (*Chunk_ChunkMetadata) ProtoMessage()

func (*Chunk_ChunkMetadata) ProtoReflect added in v1.7.0 

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

func (*Chunk_ChunkMetadata) Reset added in v1.7.0 

func (x *Chunk_ChunkMetadata) Reset()

func (*Chunk_ChunkMetadata) String added in v1.7.0 

func (x *Chunk_ChunkMetadata) String() string

type Chunk_DocumentMetadata added in v1.6.0 

type Chunk_DocumentMetadata struct {

	// Uri of the document.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Title of the document.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Data representation.
	// The structured JSON data for the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,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.6.0 

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

Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.

func (*Chunk_DocumentMetadata) GetStructData added in v1.7.0 

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

func (*Chunk_DocumentMetadata) GetTitle added in v1.6.0 

func (x *Chunk_DocumentMetadata) GetTitle() string

func (*Chunk_DocumentMetadata) GetUri added in v1.6.0 

func (x *Chunk_DocumentMetadata) GetUri() string

func (*Chunk_DocumentMetadata) ProtoMessage added in v1.6.0 

func (*Chunk_DocumentMetadata) ProtoMessage()

func (*Chunk_DocumentMetadata) ProtoReflect added in v1.6.0 

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

func (*Chunk_DocumentMetadata) Reset added in v1.6.0 

func (x *Chunk_DocumentMetadata) Reset()

func (*Chunk_DocumentMetadata) String added in v1.6.0 

func (x *Chunk_DocumentMetadata) String() string

type Chunk_PageSpan added in v1.7.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.7.0 

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

Deprecated: Use Chunk_PageSpan.ProtoReflect.Descriptor instead.

func (*Chunk_PageSpan) GetPageEnd added in v1.7.0 

func (x *Chunk_PageSpan) GetPageEnd() int32

func (*Chunk_PageSpan) GetPageStart added in v1.7.0 

func (x *Chunk_PageSpan) GetPageStart() int32

func (*Chunk_PageSpan) ProtoMessage added in v1.7.0 

func (*Chunk_PageSpan) ProtoMessage()

func (*Chunk_PageSpan) ProtoReflect added in v1.7.0 

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

func (*Chunk_PageSpan) Reset added in v1.7.0 

func (x *Chunk_PageSpan) Reset()

func (*Chunk_PageSpan) String added in v1.7.0 

func (x *Chunk_PageSpan) String() string

type CloudSqlSource added in v1.7.0 

type CloudSqlSource struct {

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

Cloud SQL source import data from.

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

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

Deprecated: Use CloudSqlSource.ProtoReflect.Descriptor instead.

func (*CloudSqlSource) GetDatabaseId added in v1.7.0 

func (x *CloudSqlSource) GetDatabaseId() string

func (*CloudSqlSource) GetGcsStagingDir added in v1.7.0 

func (x *CloudSqlSource) GetGcsStagingDir() string

func (*CloudSqlSource) GetInstanceId added in v1.7.0 

func (x *CloudSqlSource) GetInstanceId() string

func (*CloudSqlSource) GetOffload added in v1.7.0 

func (x *CloudSqlSource) GetOffload() bool

func (*CloudSqlSource) GetProjectId added in v1.7.0 

func (x *CloudSqlSource) GetProjectId() string

func (*CloudSqlSource) GetTableId added in v1.7.0 

func (x *CloudSqlSource) GetTableId() string

func (*CloudSqlSource) ProtoMessage added in v1.7.0 

func (*CloudSqlSource) ProtoMessage()

func (*CloudSqlSource) ProtoReflect added in v1.7.0 

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

func (*CloudSqlSource) Reset added in v1.7.0 

func (x *CloudSqlSource) Reset()

func (*CloudSqlSource) String added in v1.7.0 

func (x *CloudSqlSource) String() string

type CollectUserEventRequest 

type CollectUserEventRequest struct {

	// Required. The parent DataStore resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. URL encoded UserEvent proto with a length limit of 2,000,000
	// characters.
	UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// The URL including cgi-parameters but excluding the hash fragment with a
	// length limit of 5,000 characters. This is often more useful than the
	// referer URL, because many browsers only send the domain for third-party
	// requests.
	Uri *string `protobuf:"bytes,3,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
	// The event timestamp in milliseconds. This prevents browser caching of
	// otherwise identical get requests. The name is abbreviated to reduce the
	// payload bytes.
	Ets *int64 `protobuf:"varint,4,opt,name=ets,proto3,oneof" json:"ets,omitempty"`
	// contains filtered or unexported fields
}

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor deprecated 

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

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetEts 

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent 

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri 

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent 

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage 

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect 

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

func (*CollectUserEventRequest) Reset 

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String 

func (x *CollectUserEventRequest) String() string

type CompleteQueryRequest 

type CompleteQueryRequest struct {

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

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

func (*CompleteQueryRequest) Descriptor deprecated 

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

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetDataStore 

func (x *CompleteQueryRequest) GetDataStore() string

func (*CompleteQueryRequest) GetIncludeTailSuggestions 

func (x *CompleteQueryRequest) GetIncludeTailSuggestions() bool

func (*CompleteQueryRequest) GetQuery 

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetQueryModel 

func (x *CompleteQueryRequest) GetQueryModel() string

func (*CompleteQueryRequest) GetUserPseudoId 

func (x *CompleteQueryRequest) GetUserPseudoId() string

func (*CompleteQueryRequest) ProtoMessage 

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect 

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

func (*CompleteQueryRequest) Reset 

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String 

func (x *CompleteQueryRequest) String() string

type CompleteQueryResponse 

type CompleteQueryResponse struct {

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

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

func (*CompleteQueryResponse) Descriptor deprecated 

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

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetQuerySuggestions 

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

func (*CompleteQueryResponse) GetTailMatchTriggered 

func (x *CompleteQueryResponse) GetTailMatchTriggered() bool

func (*CompleteQueryResponse) ProtoMessage 

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect 

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

func (*CompleteQueryResponse) Reset 

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String 

func (x *CompleteQueryResponse) String() string

type CompleteQueryResponse_QuerySuggestion 

type CompleteQueryResponse_QuerySuggestion struct {

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

Suggestions as search queries.

func (*CompleteQueryResponse_QuerySuggestion) Descriptor deprecated 

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

Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths 

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

func (*CompleteQueryResponse_QuerySuggestion) GetSuggestion 

func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() string

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage 

func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()

func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect 

func (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.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion].
	SelectedSuggestion string `protobuf:"bytes,1,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
	// End user selected
	// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion]
	// position, starting from 0.
	SelectedPosition int32 `protobuf:"varint,2,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`
	// contains filtered or unexported fields
}

Detailed completion information including completion attribution token and clicked completion info.

func (*CompletionInfo) Descriptor deprecated 

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

Deprecated: Use CompletionInfo.ProtoReflect.Descriptor instead.

func (*CompletionInfo) GetSelectedPosition 

func (x *CompletionInfo) GetSelectedPosition() int32

func (*CompletionInfo) GetSelectedSuggestion 

func (x *CompletionInfo) GetSelectedSuggestion() string

func (*CompletionInfo) ProtoMessage 

func (*CompletionInfo) ProtoMessage()

func (*CompletionInfo) ProtoReflect 

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

func (*CompletionInfo) Reset 

func (x *CompletionInfo) Reset()

func (*CompletionInfo) String 

func (x *CompletionInfo) String() string

type CompletionServiceClient 

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

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

Deprecated: Use CompletionSuggestion.ProtoReflect.Descriptor instead.

func (*CompletionSuggestion) GetAlternativePhrases added in v1.12.0 

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

func (*CompletionSuggestion) GetFrequency added in v1.12.0 

func (x *CompletionSuggestion) GetFrequency() int64

func (*CompletionSuggestion) GetGlobalScore added in v1.12.0 

func (x *CompletionSuggestion) GetGlobalScore() float64

func (*CompletionSuggestion) GetGroupId added in v1.12.0 

func (x *CompletionSuggestion) GetGroupId() string

func (*CompletionSuggestion) GetGroupScore added in v1.12.0 

func (x *CompletionSuggestion) GetGroupScore() float64

func (*CompletionSuggestion) GetLanguageCode added in v1.12.0 

func (x *CompletionSuggestion) GetLanguageCode() string

func (*CompletionSuggestion) GetRankingInfo added in v1.12.0 

func (m *CompletionSuggestion) GetRankingInfo() isCompletionSuggestion_RankingInfo

func (*CompletionSuggestion) GetSuggestion added in v1.12.0 

func (x *CompletionSuggestion) GetSuggestion() string

func (*CompletionSuggestion) ProtoMessage added in v1.12.0 

func (*CompletionSuggestion) ProtoMessage()

func (*CompletionSuggestion) ProtoReflect added in v1.12.0 

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

func (*CompletionSuggestion) Reset added in v1.12.0 

func (x *CompletionSuggestion) Reset()

func (*CompletionSuggestion) String added in v1.12.0 

func (x *CompletionSuggestion) String() string

type CompletionSuggestion_Frequency added in v1.12.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.12.0 

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

type Condition added in v1.8.0 

type Condition struct {

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

Defines circumstances to be checked before allowing a behavior

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

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

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetActiveTimeRange added in v1.8.0 

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

func (*Condition) GetQueryTerms added in v1.8.0 

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

func (*Condition) ProtoMessage added in v1.8.0 

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect added in v1.8.0 

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

func (*Condition) Reset added in v1.8.0 

func (x *Condition) Reset()

func (*Condition) String added in v1.8.0 

func (x *Condition) String() string

type Condition_QueryTerm added in v1.8.0 

type Condition_QueryTerm struct {

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

Matcher for search request query

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

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

Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.

func (*Condition_QueryTerm) GetFullMatch added in v1.8.0 

func (x *Condition_QueryTerm) GetFullMatch() bool

func (*Condition_QueryTerm) GetValue added in v1.8.0 

func (x *Condition_QueryTerm) GetValue() string

func (*Condition_QueryTerm) ProtoMessage added in v1.8.0 

func (*Condition_QueryTerm) ProtoMessage()

func (*Condition_QueryTerm) ProtoReflect added in v1.8.0 

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

func (*Condition_QueryTerm) Reset added in v1.8.0 

func (x *Condition_QueryTerm) Reset()

func (*Condition_QueryTerm) String added in v1.8.0 

func (x *Condition_QueryTerm) String() string

type Condition_TimeRange added in v1.8.0 

type Condition_TimeRange struct {

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

Used for time-dependent conditions.

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

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

Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.

func (*Condition_TimeRange) GetEndTime added in v1.8.0 

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

func (*Condition_TimeRange) GetStartTime added in v1.8.0 

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

func (*Condition_TimeRange) ProtoMessage added in v1.8.0 

func (*Condition_TimeRange) ProtoMessage()

func (*Condition_TimeRange) ProtoReflect added in v1.8.0 

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

func (*Condition_TimeRange) Reset added in v1.8.0 

func (x *Condition_TimeRange) Reset()

func (*Condition_TimeRange) String added in v1.8.0 

func (x *Condition_TimeRange) String() string

type Control added in v1.8.0 

type Control struct {

	// Actions are restricted by Vertical and Solution
	//
	// Required.
	//
	// Types that are assignable to Action:
	//
	//	*Control_BoostAction_
	//	*Control_FilterAction_
	//	*Control_RedirectAction_
	//	*Control_SynonymsAction_
	Action isControl_Action `protobuf_oneof:"action"`
	// Immutable. Fully qualified name
	// `projects/*/locations/global/dataStore/*/controls/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Human readable name. The identifier used in UI views.
	//
	// Must be UTF-8 encoded string. Length limit is 128 characters.
	// Otherwise an INVALID ARGUMENT error is thrown.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. List of all
	// [ServingConfig][google.cloud.discoveryengine.v1alpha.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 `` /* 153-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.v1alpha.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.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
	UseCases []SearchUseCase `` /* 149-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.v1alpha.ServingConfig] to be considered at serving time. Permitted actions dependent on `SolutionType`.

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

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

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetAction added in v1.8.0 

func (m *Control) GetAction() isControl_Action

func (*Control) GetAssociatedServingConfigIds added in v1.8.0 

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

func (*Control) GetBoostAction added in v1.8.0 

func (x *Control) GetBoostAction() *Control_BoostAction

func (*Control) GetConditions added in v1.8.0 

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

func (*Control) GetDisplayName added in v1.8.0 

func (x *Control) GetDisplayName() string

func (*Control) GetFilterAction added in v1.8.0 

func (x *Control) GetFilterAction() *Control_FilterAction

func (*Control) GetName added in v1.8.0 

func (x *Control) GetName() string

func (*Control) GetRedirectAction added in v1.8.0 

func (x *Control) GetRedirectAction() *Control_RedirectAction

func (*Control) GetSolutionType added in v1.8.0 

func (x *Control) GetSolutionType() SolutionType

func (*Control) GetSynonymsAction added in v1.8.0 

func (x *Control) GetSynonymsAction() *Control_SynonymsAction

func (*Control) GetUseCases added in v1.8.0 

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

func (*Control) ProtoMessage added in v1.8.0 

func (*Control) ProtoMessage()

func (*Control) ProtoReflect added in v1.8.0 

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

func (*Control) Reset added in v1.8.0 

func (x *Control) Reset()

func (*Control) String added in v1.8.0 

func (x *Control) String() string

type ControlServiceClient added in v1.8.0 

type ControlServiceClient interface {
	// Creates a Control.
	//
	// By default 1000 controls are allowed for a data store.
	// A request can be submitted to adjust this limit.
	// If the [Control][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.Control] action type cannot
	// be changed. If the [Control][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.Control] action type cannot
	// be changed. If the [Control][google.cloud.discoveryengine.v1alpha.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.v1alpha.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 {

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

Adjusts order of products in returned list.

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

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

Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.

func (*Control_BoostAction) GetBoost added in v1.8.0 

func (x *Control_BoostAction) GetBoost() float32

func (*Control_BoostAction) GetDataStore added in v1.8.0 

func (x *Control_BoostAction) GetDataStore() string

func (*Control_BoostAction) GetFilter added in v1.8.0 

func (x *Control_BoostAction) GetFilter() string

func (*Control_BoostAction) ProtoMessage added in v1.8.0 

func (*Control_BoostAction) ProtoMessage()

func (*Control_BoostAction) ProtoReflect added in v1.8.0 

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

func (*Control_BoostAction) Reset added in v1.8.0 

func (x *Control_BoostAction) Reset()

func (*Control_BoostAction) String added in v1.8.0 

func (x *Control_BoostAction) String() string

type Control_BoostAction_ added in v1.8.0 

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

type Control_FilterAction added in v1.8.0 

type Control_FilterAction struct {

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

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

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

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

Deprecated: Use Control_FilterAction.ProtoReflect.Descriptor instead.

func (*Control_FilterAction) GetDataStore added in v1.8.0 

func (x *Control_FilterAction) GetDataStore() string

func (*Control_FilterAction) GetFilter added in v1.8.0 

func (x *Control_FilterAction) GetFilter() string

func (*Control_FilterAction) ProtoMessage added in v1.8.0 

func (*Control_FilterAction) ProtoMessage()

func (*Control_FilterAction) ProtoReflect added in v1.8.0 

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

func (*Control_FilterAction) Reset added in v1.8.0 

func (x *Control_FilterAction) Reset()

func (*Control_FilterAction) String added in v1.8.0 

func (x *Control_FilterAction) String() string

type Control_FilterAction_ added in v1.8.0 

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

type Control_RedirectAction added in v1.8.0 

type Control_RedirectAction struct {

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

Redirects a shopper to the provided URI.

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

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

Deprecated: Use Control_RedirectAction.ProtoReflect.Descriptor instead.

func (*Control_RedirectAction) GetRedirectUri added in v1.8.0 

func (x *Control_RedirectAction) GetRedirectUri() string

func (*Control_RedirectAction) ProtoMessage added in v1.8.0 

func (*Control_RedirectAction) ProtoMessage()

func (*Control_RedirectAction) ProtoReflect added in v1.8.0 

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

func (*Control_RedirectAction) Reset added in v1.8.0 

func (x *Control_RedirectAction) Reset()

func (*Control_RedirectAction) String added in v1.8.0 

func (x *Control_RedirectAction) String() string

type Control_RedirectAction_ added in v1.8.0 

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

type Control_SynonymsAction added in v1.8.0 

type Control_SynonymsAction struct {

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

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

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

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

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

Deprecated: Use Control_SynonymsAction.ProtoReflect.Descriptor instead.

func (*Control_SynonymsAction) GetSynonyms added in v1.8.0 

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

func (*Control_SynonymsAction) ProtoMessage added in v1.8.0 

func (*Control_SynonymsAction) ProtoMessage()

func (*Control_SynonymsAction) ProtoReflect added in v1.8.0 

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

func (*Control_SynonymsAction) Reset added in v1.8.0 

func (x *Control_SynonymsAction) Reset()

func (*Control_SynonymsAction) String added in v1.8.0 

func (x *Control_SynonymsAction) String() string

type Control_SynonymsAction_ added in v1.8.0 

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

type Conversation 

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.v1alpha.Conversation_State" json:"state,omitempty"`
	// A unique identifier for tracking users.
	UserPseudoId string `protobuf:"bytes,3,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
	// Conversation messages.
	Messages []*ConversationMessage `protobuf:"bytes,4,rep,name=messages,proto3" json:"messages,omitempty"`
	// Output only. The time the conversation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The time the conversation finished.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

External conversation proto definition.

func (*Conversation) Descriptor deprecated 

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

Deprecated: Use Conversation.ProtoReflect.Descriptor instead.

func (*Conversation) GetEndTime 

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

func (*Conversation) GetMessages 

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

func (*Conversation) GetName 

func (x *Conversation) GetName() string

func (*Conversation) GetStartTime 

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

func (*Conversation) GetState 

func (x *Conversation) GetState() Conversation_State

func (*Conversation) GetUserPseudoId 

func (x *Conversation) GetUserPseudoId() string

func (*Conversation) ProtoMessage 

func (*Conversation) ProtoMessage()

func (*Conversation) ProtoReflect 

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

func (*Conversation) Reset 

func (x *Conversation) Reset()

func (*Conversation) String 

func (x *Conversation) String() string

type ConversationContext 

type ConversationContext struct {

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

Defines context of the conversation

func (*ConversationContext) Descriptor deprecated 

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

Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.

func (*ConversationContext) GetActiveDocument 

func (x *ConversationContext) GetActiveDocument() string

func (*ConversationContext) GetContextDocuments 

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

func (*ConversationContext) ProtoMessage 

func (*ConversationContext) ProtoMessage()

func (*ConversationContext) ProtoReflect 

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

func (*ConversationContext) Reset 

func (x *ConversationContext) Reset()

func (*ConversationContext) String 

func (x *ConversationContext) String() string

type ConversationMessage 

type ConversationMessage struct {

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

Defines a conversation message.

func (*ConversationMessage) Descriptor deprecated 

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

Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.

func (*ConversationMessage) GetCreateTime 

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

func (*ConversationMessage) GetMessage 

func (m *ConversationMessage) GetMessage() isConversationMessage_Message

func (*ConversationMessage) GetReply 

func (x *ConversationMessage) GetReply() *Reply

func (*ConversationMessage) GetUserInput 

func (x *ConversationMessage) GetUserInput() *TextInput

func (*ConversationMessage) ProtoMessage 

func (*ConversationMessage) ProtoMessage()

func (*ConversationMessage) ProtoReflect 

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

func (*ConversationMessage) Reset 

func (x *ConversationMessage) Reset()

func (*ConversationMessage) String 

func (x *ConversationMessage) String() string

type ConversationMessage_Reply 

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

type ConversationMessage_UserInput 

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

type Conversation_State 

type Conversation_State int32

Enumeration of the state of the conversation. 

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

func (Conversation_State) Descriptor 

func (Conversation_State) Descriptor() protoreflect.EnumDescriptor

func (Conversation_State) Enum 

func (x Conversation_State) Enum() *Conversation_State

func (Conversation_State) EnumDescriptor deprecated 

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

Deprecated: Use Conversation_State.Descriptor instead.

func (Conversation_State) Number 

func (x Conversation_State) Number() protoreflect.EnumNumber

func (Conversation_State) String 

func (x Conversation_State) String() string

func (Conversation_State) Type 

func (Conversation_State) Type() protoreflect.EnumType

type ConversationalSearchServiceClient 

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

func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClient

type ConversationalSearchServiceServer 

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

ConversationalSearchServiceServer is the server API for ConversationalSearchService service. All implementations should embed UnimplementedConversationalSearchServiceServer for forward compatibility

type ConverseConversationRequest 

type ConverseConversationRequest struct {

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

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

func (*ConverseConversationRequest) Descriptor deprecated 

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

Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.

func (*ConverseConversationRequest) GetBoostSpec added in v1.6.0 

func (x *ConverseConversationRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*ConverseConversationRequest) GetConversation 

func (x *ConverseConversationRequest) GetConversation() *Conversation

func (*ConverseConversationRequest) GetFilter added in v1.4.0 

func (x *ConverseConversationRequest) GetFilter() string

func (*ConverseConversationRequest) GetName 

func (x *ConverseConversationRequest) GetName() string

func (*ConverseConversationRequest) GetQuery 

func (x *ConverseConversationRequest) GetQuery() *TextInput

func (*ConverseConversationRequest) GetSafeSearch 

func (x *ConverseConversationRequest) GetSafeSearch() bool

func (*ConverseConversationRequest) GetServingConfig 

func (x *ConverseConversationRequest) GetServingConfig() string

func (*ConverseConversationRequest) GetSummarySpec 

func (x *ConverseConversationRequest) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpec

func (*ConverseConversationRequest) GetUserLabels 

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

func (*ConverseConversationRequest) ProtoMessage 

func (*ConverseConversationRequest) ProtoMessage()

func (*ConverseConversationRequest) ProtoReflect 

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

func (*ConverseConversationRequest) Reset 

func (x *ConverseConversationRequest) Reset()

func (*ConverseConversationRequest) String 

func (x *ConverseConversationRequest) String() string

type ConverseConversationResponse 

type ConverseConversationResponse struct {

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

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

func (*ConverseConversationResponse) Descriptor deprecated 

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

Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.

func (*ConverseConversationResponse) GetConversation 

func (x *ConverseConversationResponse) GetConversation() *Conversation

func (*ConverseConversationResponse) GetRelatedQuestions 

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

func (*ConverseConversationResponse) GetReply 

func (x *ConverseConversationResponse) GetReply() *Reply

func (*ConverseConversationResponse) GetSearchResults 

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

func (*ConverseConversationResponse) ProtoMessage 

func (*ConverseConversationResponse) ProtoMessage()

func (*ConverseConversationResponse) ProtoReflect 

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

func (*ConverseConversationResponse) Reset 

func (x *ConverseConversationResponse) Reset()

func (*ConverseConversationResponse) String 

func (x *ConverseConversationResponse) String() string

type CreateControlRequest added in v1.8.0 

type CreateControlRequest struct {

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

Request for CreateControl method.

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

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

Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.

func (*CreateControlRequest) GetControl added in v1.8.0 

func (x *CreateControlRequest) GetControl() *Control

func (*CreateControlRequest) GetControlId added in v1.8.0 

func (x *CreateControlRequest) GetControlId() string

func (*CreateControlRequest) GetParent added in v1.8.0 

func (x *CreateControlRequest) GetParent() string

func (*CreateControlRequest) ProtoMessage added in v1.8.0 

func (*CreateControlRequest) ProtoMessage()

func (*CreateControlRequest) ProtoReflect added in v1.8.0 

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

func (*CreateControlRequest) Reset added in v1.8.0 

func (x *CreateControlRequest) Reset()

func (*CreateControlRequest) String added in v1.8.0 

func (x *CreateControlRequest) String() string

type CreateConversationRequest 

type CreateConversationRequest struct {

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

Request for CreateConversation method.

func (*CreateConversationRequest) Descriptor deprecated 

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

Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.

func (*CreateConversationRequest) GetConversation 

func (x *CreateConversationRequest) GetConversation() *Conversation

func (*CreateConversationRequest) GetParent 

func (x *CreateConversationRequest) GetParent() string

func (*CreateConversationRequest) ProtoMessage 

func (*CreateConversationRequest) ProtoMessage()

func (*CreateConversationRequest) ProtoReflect 

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

func (*CreateConversationRequest) Reset 

func (x *CreateConversationRequest) Reset()

func (*CreateConversationRequest) String 

func (x *CreateConversationRequest) String() string

type CreateDataStoreMetadata 

type CreateDataStoreMetadata struct {

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

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

func (*CreateDataStoreMetadata) Descriptor deprecated 

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

Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*CreateDataStoreMetadata) GetCreateTime 

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

func (*CreateDataStoreMetadata) GetUpdateTime 

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

func (*CreateDataStoreMetadata) ProtoMessage 

func (*CreateDataStoreMetadata) ProtoMessage()

func (*CreateDataStoreMetadata) ProtoReflect 

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

func (*CreateDataStoreMetadata) Reset 

func (x *CreateDataStoreMetadata) Reset()

func (*CreateDataStoreMetadata) String 

func (x *CreateDataStoreMetadata) String() string

type CreateDataStoreRequest 

type CreateDataStoreRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
	// to create.
	DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// Required. The ID to use for the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], which will
	// become the final component of the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s resource
	// name.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
	// A boolean flag indicating whether user want to directly create an advanced
	// data store for site search.
	// If the data store is not configured as site
	// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
	// be ignored.
	CreateAdvancedSiteSearch bool `` /* 138-byte string literal not displayed */
	// 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.v1alpha.DataStoreService.CreateDataStore] method.

func (*CreateDataStoreRequest) Descriptor deprecated 

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

Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.

func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch 

func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() bool

func (*CreateDataStoreRequest) GetDataStore 

func (x *CreateDataStoreRequest) GetDataStore() *DataStore

func (*CreateDataStoreRequest) GetDataStoreId 

func (x *CreateDataStoreRequest) GetDataStoreId() string

func (*CreateDataStoreRequest) GetParent 

func (x *CreateDataStoreRequest) GetParent() string

func (*CreateDataStoreRequest) GetSkipDefaultSchemaCreation added in v1.12.0 

func (x *CreateDataStoreRequest) GetSkipDefaultSchemaCreation() bool

func (*CreateDataStoreRequest) ProtoMessage 

func (*CreateDataStoreRequest) ProtoMessage()

func (*CreateDataStoreRequest) ProtoReflect 

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

func (*CreateDataStoreRequest) Reset 

func (x *CreateDataStoreRequest) Reset()

func (*CreateDataStoreRequest) String 

func (x *CreateDataStoreRequest) String() string

type CreateDocumentRequest 

type CreateDocumentRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Document][google.cloud.discoveryengine.v1alpha.Document] to
	// create.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Required. The ID to use for the
	// [Document][google.cloud.discoveryengine.v1alpha.Document], which becomes
	// the final component of the
	// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name].
	//
	// If the caller does not have permission to create the
	// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// This field must be unique among all
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s with the same
	// [parent][google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent].
	// Otherwise, an `ALREADY_EXISTS` error is returned.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateDocumentRequest) Descriptor deprecated 

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

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocument 

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId 

func (x *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetParent 

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect 

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

func (*CreateDocumentRequest) Reset 

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (x *CreateDocumentRequest) String() string

type CreateEngineMetadata 

type CreateEngineMetadata struct {

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

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

func (*CreateEngineMetadata) Descriptor deprecated 

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

Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.

func (*CreateEngineMetadata) GetCreateTime 

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

func (*CreateEngineMetadata) GetUpdateTime 

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

func (*CreateEngineMetadata) ProtoMessage 

func (*CreateEngineMetadata) ProtoMessage()

func (*CreateEngineMetadata) ProtoReflect 

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

func (*CreateEngineMetadata) Reset 

func (x *CreateEngineMetadata) Reset()

func (*CreateEngineMetadata) String 

func (x *CreateEngineMetadata) String() string

type CreateEngineRequest 

type CreateEngineRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Engine][google.cloud.discoveryengine.v1alpha.Engine] to
	// create.
	Engine *Engine `protobuf:"bytes,2,opt,name=engine,proto3" json:"engine,omitempty"`
	// Required. The ID to use for the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], which will become
	// the final component of the
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s resource name.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	EngineId string `protobuf:"bytes,3,opt,name=engine_id,json=engineId,proto3" json:"engine_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateEngineRequest) Descriptor deprecated 

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

Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.

func (*CreateEngineRequest) GetEngine 

func (x *CreateEngineRequest) GetEngine() *Engine

func (*CreateEngineRequest) GetEngineId 

func (x *CreateEngineRequest) GetEngineId() string

func (*CreateEngineRequest) GetParent 

func (x *CreateEngineRequest) GetParent() string

func (*CreateEngineRequest) ProtoMessage 

func (*CreateEngineRequest) ProtoMessage()

func (*CreateEngineRequest) ProtoReflect 

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

func (*CreateEngineRequest) Reset 

func (x *CreateEngineRequest) Reset()

func (*CreateEngineRequest) String 

func (x *CreateEngineRequest) String() string

type CreateEvaluationMetadata added in v1.10.0 

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

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

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

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

Deprecated: Use CreateEvaluationMetadata.ProtoReflect.Descriptor instead.

func (*CreateEvaluationMetadata) ProtoMessage added in v1.10.0 

func (*CreateEvaluationMetadata) ProtoMessage()

func (*CreateEvaluationMetadata) ProtoReflect added in v1.10.0 

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

func (*CreateEvaluationMetadata) Reset added in v1.10.0 

func (x *CreateEvaluationMetadata) Reset()

func (*CreateEvaluationMetadata) String added in v1.10.0 

func (x *CreateEvaluationMetadata) String() string

type CreateEvaluationRequest added in v1.10.0 

type CreateEvaluationRequest struct {

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

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

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

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

Deprecated: Use CreateEvaluationRequest.ProtoReflect.Descriptor instead.

func (*CreateEvaluationRequest) GetEvaluation added in v1.10.0 

func (x *CreateEvaluationRequest) GetEvaluation() *Evaluation

func (*CreateEvaluationRequest) GetParent added in v1.10.0 

func (x *CreateEvaluationRequest) GetParent() string

func (*CreateEvaluationRequest) ProtoMessage added in v1.10.0 

func (*CreateEvaluationRequest) ProtoMessage()

func (*CreateEvaluationRequest) ProtoReflect added in v1.10.0 

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

func (*CreateEvaluationRequest) Reset added in v1.10.0 

func (x *CreateEvaluationRequest) Reset()

func (*CreateEvaluationRequest) String added in v1.10.0 

func (x *CreateEvaluationRequest) String() string

type CreateSampleQueryRequest added in v1.10.0 

type CreateSampleQueryRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to create.
	SampleQuery *SampleQuery `protobuf:"bytes,2,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
	// Required. The ID to use for the
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], which will
	// become the final component of the
	// [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name].
	//
	// If the caller does not have permission to create the
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
	// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// This field must be unique among all
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s with the
	// same
	// [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent].
	// Otherwise, an `ALREADY_EXISTS` error is returned.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	SampleQueryId string `protobuf:"bytes,3,opt,name=sample_query_id,json=sampleQueryId,proto3" json:"sample_query_id,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CreateSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*CreateSampleQueryRequest) GetParent added in v1.10.0 

func (x *CreateSampleQueryRequest) GetParent() string

func (*CreateSampleQueryRequest) GetSampleQuery added in v1.10.0 

func (x *CreateSampleQueryRequest) GetSampleQuery() *SampleQuery

func (*CreateSampleQueryRequest) GetSampleQueryId added in v1.10.0 

func (x *CreateSampleQueryRequest) GetSampleQueryId() string

func (*CreateSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*CreateSampleQueryRequest) ProtoMessage()

func (*CreateSampleQueryRequest) ProtoReflect added in v1.10.0 

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

func (*CreateSampleQueryRequest) Reset added in v1.10.0 

func (x *CreateSampleQueryRequest) Reset()

func (*CreateSampleQueryRequest) String added in v1.10.0 

func (x *CreateSampleQueryRequest) String() string

type CreateSampleQuerySetRequest added in v1.10.0 

type CreateSampleQuerySetRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
	// create.
	SampleQuerySet *SampleQuerySet `protobuf:"bytes,2,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
	// Required. The ID to use for the
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
	// which will become the final component of the
	// [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name].
	//
	// If the caller does not have permission to create the
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
	// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
	// returned.
	//
	// This field must be unique among all
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s with
	// the same
	// [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent].
	// Otherwise, an `ALREADY_EXISTS` error is returned.
	//
	// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
	// standard with a length limit of 63 characters. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	SampleQuerySetId string `protobuf:"bytes,3,opt,name=sample_query_set_id,json=sampleQuerySetId,proto3" json:"sample_query_set_id,omitempty"`
	// contains filtered or unexported fields
}

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

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

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

Deprecated: Use CreateSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*CreateSampleQuerySetRequest) GetParent added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetParent() string

func (*CreateSampleQuerySetRequest) GetSampleQuerySet added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetSampleQuerySet() *SampleQuerySet

func (*CreateSampleQuerySetRequest) GetSampleQuerySetId added in v1.10.0 

func (x *CreateSampleQuerySetRequest) GetSampleQuerySetId() string

func (*CreateSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*CreateSampleQuerySetRequest) ProtoMessage()

func (*CreateSampleQuerySetRequest) ProtoReflect added in v1.10.0 

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

func (*CreateSampleQuerySetRequest) Reset added in v1.10.0 

func (x *CreateSampleQuerySetRequest) Reset()

func (*CreateSampleQuerySetRequest) String added in v1.10.0 

func (x *CreateSampleQuerySetRequest) String() string

type CreateSchemaMetadata 

type CreateSchemaMetadata struct {

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

Metadata for Create Schema LRO.

func (*CreateSchemaMetadata) Descriptor deprecated 

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

Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.

func (*CreateSchemaMetadata) GetCreateTime 

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

func (*CreateSchemaMetadata) GetUpdateTime 

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

func (*CreateSchemaMetadata) ProtoMessage 

func (*CreateSchemaMetadata) ProtoMessage()

func (*CreateSchemaMetadata) ProtoReflect 

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

func (*CreateSchemaMetadata) Reset 

func (x *CreateSchemaMetadata) Reset()

func (*CreateSchemaMetadata) String 

func (x *CreateSchemaMetadata) String() string

type CreateSchemaRequest 

type CreateSchemaRequest struct {

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

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

func (*CreateSchemaRequest) Descriptor deprecated 

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

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent 

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema 

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId 

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage 

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect 

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

func (*CreateSchemaRequest) Reset 

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String 

func (x *CreateSchemaRequest) String() string

type CreateSessionRequest added in v1.7.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.7.0 

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

Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.

func (*CreateSessionRequest) GetParent added in v1.7.0 

func (x *CreateSessionRequest) GetParent() string

func (*CreateSessionRequest) GetSession added in v1.7.0 

func (x *CreateSessionRequest) GetSession() *Session

func (*CreateSessionRequest) ProtoMessage added in v1.7.0 

func (*CreateSessionRequest) ProtoMessage()

func (*CreateSessionRequest) ProtoReflect added in v1.7.0 

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

func (*CreateSessionRequest) Reset added in v1.7.0 

func (x *CreateSessionRequest) Reset()

func (*CreateSessionRequest) String added in v1.7.0 

func (x *CreateSessionRequest) String() string

type CreateTargetSiteMetadata added in v1.4.0 

type CreateTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteMetadata) GetCreateTime added in v1.4.0 

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

func (*CreateTargetSiteMetadata) GetUpdateTime added in v1.4.0 

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

func (*CreateTargetSiteMetadata) ProtoMessage added in v1.4.0 

func (*CreateTargetSiteMetadata) ProtoMessage()

func (*CreateTargetSiteMetadata) ProtoReflect added in v1.4.0 

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

func (*CreateTargetSiteMetadata) Reset added in v1.4.0 

func (x *CreateTargetSiteMetadata) Reset()

func (*CreateTargetSiteMetadata) String added in v1.4.0 

func (x *CreateTargetSiteMetadata) String() string

type CreateTargetSiteRequest added in v1.4.0 

type CreateTargetSiteRequest struct {

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

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

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

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

Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*CreateTargetSiteRequest) GetParent added in v1.4.0 

func (x *CreateTargetSiteRequest) GetParent() string

func (*CreateTargetSiteRequest) GetTargetSite added in v1.4.0 

func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSite

func (*CreateTargetSiteRequest) ProtoMessage added in v1.4.0 

func (*CreateTargetSiteRequest) ProtoMessage()

func (*CreateTargetSiteRequest) ProtoReflect added in v1.4.0 

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

func (*CreateTargetSiteRequest) Reset added in v1.4.0 

func (x *CreateTargetSiteRequest) Reset()

func (*CreateTargetSiteRequest) String added in v1.4.0 

func (x *CreateTargetSiteRequest) String() string

type CustomAttribute 

type CustomAttribute struct {

	// The textual values of this custom attribute. For example, `["yellow",
	// "green"]` when the key is "color".
	//
	// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
	// returned.
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
	// when the key is "lengths_cm".
	//
	// Exactly one of
	// [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text]
	// or
	// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
	// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
	Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CustomAttribute) Descriptor deprecated 

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

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetNumbers 

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

func (*CustomAttribute) GetText 

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

func (*CustomAttribute) ProtoMessage 

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect 

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

func (*CustomAttribute) Reset 

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String 

func (x *CustomAttribute) String() string

type CustomFineTuningSpec added in v1.6.0 

type CustomFineTuningSpec struct {

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

Defines custom fine tuning spec.

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

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

Deprecated: Use CustomFineTuningSpec.ProtoReflect.Descriptor instead.

func (*CustomFineTuningSpec) GetEnableSearchAdaptor added in v1.6.0 

func (x *CustomFineTuningSpec) GetEnableSearchAdaptor() bool

func (*CustomFineTuningSpec) ProtoMessage added in v1.6.0 

func (*CustomFineTuningSpec) ProtoMessage()

func (*CustomFineTuningSpec) ProtoReflect added in v1.6.0 

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

func (*CustomFineTuningSpec) Reset added in v1.6.0 

func (x *CustomFineTuningSpec) Reset()

func (*CustomFineTuningSpec) String added in v1.6.0 

func (x *CustomFineTuningSpec) String() string

type CustomTuningModel added in v1.8.0 

type CustomTuningModel struct {

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

Metadata that describes a custom tuned model.

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

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

Deprecated: Use CustomTuningModel.ProtoReflect.Descriptor instead.

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

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

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

func (*CustomTuningModel) GetDisplayName added in v1.8.0 

func (x *CustomTuningModel) GetDisplayName() string

func (*CustomTuningModel) GetMetrics added in v1.12.0 

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

func (*CustomTuningModel) GetModelState added in v1.8.0 

func (x *CustomTuningModel) GetModelState() CustomTuningModel_ModelState

func (*CustomTuningModel) GetModelVersion added in v1.8.0 

func (x *CustomTuningModel) GetModelVersion() int64

func (*CustomTuningModel) GetName added in v1.8.0 

func (x *CustomTuningModel) GetName() string

func (*CustomTuningModel) GetTrainingStartTime added in v1.8.0 

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

func (*CustomTuningModel) ProtoMessage added in v1.8.0 

func (*CustomTuningModel) ProtoMessage()

func (*CustomTuningModel) ProtoReflect added in v1.8.0 

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

func (*CustomTuningModel) Reset added in v1.8.0 

func (x *CustomTuningModel) Reset()

func (*CustomTuningModel) String added in v1.8.0 

func (x *CustomTuningModel) String() string

type CustomTuningModel_ModelState added in v1.8.0 

type CustomTuningModel_ModelState int32

The state of the model. 

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

func (CustomTuningModel_ModelState) Descriptor added in v1.8.0 

func (CustomTuningModel_ModelState) Descriptor() protoreflect.EnumDescriptor

func (CustomTuningModel_ModelState) Enum added in v1.8.0 

func (x CustomTuningModel_ModelState) Enum() *CustomTuningModel_ModelState

func (CustomTuningModel_ModelState) EnumDescriptor deprecated added in v1.8.0 

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

Deprecated: Use CustomTuningModel_ModelState.Descriptor instead.

func (CustomTuningModel_ModelState) Number added in v1.8.0 

func (x CustomTuningModel_ModelState) Number() protoreflect.EnumNumber

func (CustomTuningModel_ModelState) String added in v1.8.0 

func (x CustomTuningModel_ModelState) String() string

func (CustomTuningModel_ModelState) Type added in v1.8.0 

func (CustomTuningModel_ModelState) Type() protoreflect.EnumType

type DataStore 

type DataStore struct {

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

DataStore captures global settings and configs at the DataStore level.

func (*DataStore) Descriptor deprecated 

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

Deprecated: Use DataStore.ProtoReflect.Descriptor instead.

func (*DataStore) GetAclEnabled added in v1.6.0 

func (x *DataStore) GetAclEnabled() bool

func (*DataStore) GetContentConfig 

func (x *DataStore) GetContentConfig() DataStore_ContentConfig

func (*DataStore) GetCreateTime 

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

func (*DataStore) GetDefaultSchemaId 

func (x *DataStore) GetDefaultSchemaId() string

func (*DataStore) GetDisplayName 

func (x *DataStore) GetDisplayName() string

func (*DataStore) GetDocumentProcessingConfig added in v1.6.0 

func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfig

func (*DataStore) GetIdpConfig added in v1.6.0 

func (x *DataStore) GetIdpConfig() *IdpConfig

func (*DataStore) GetIndustryVertical 

func (x *DataStore) GetIndustryVertical() IndustryVertical

func (*DataStore) GetLanguageInfo added in v1.12.0 

func (x *DataStore) GetLanguageInfo() *LanguageInfo

func (*DataStore) GetName 

func (x *DataStore) GetName() string

func (*DataStore) GetSolutionTypes 

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

func (*DataStore) GetStartingSchema added in v1.6.0 

func (x *DataStore) GetStartingSchema() *Schema

func (*DataStore) GetWorkspaceConfig added in v1.14.0 

func (x *DataStore) GetWorkspaceConfig() *WorkspaceConfig

func (*DataStore) ProtoMessage 

func (*DataStore) ProtoMessage()

func (*DataStore) ProtoReflect 

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

func (*DataStore) Reset 

func (x *DataStore) Reset()

func (*DataStore) String 

func (x *DataStore) String() string

type DataStoreServiceClient 

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

DataStoreServiceClient is the client API for DataStoreService service.

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

func NewDataStoreServiceClient 

func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClient

type DataStoreServiceServer 

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

DataStoreServiceServer is the server API for DataStoreService service. All implementations should embed UnimplementedDataStoreServiceServer for forward compatibility

type DataStore_ContentConfig 

type DataStore_ContentConfig int32

Content config of the data store. 

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

func (DataStore_ContentConfig) Descriptor 

func (DataStore_ContentConfig) Descriptor() protoreflect.EnumDescriptor

func (DataStore_ContentConfig) Enum 

func (x DataStore_ContentConfig) Enum() *DataStore_ContentConfig

func (DataStore_ContentConfig) EnumDescriptor deprecated 

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

Deprecated: Use DataStore_ContentConfig.Descriptor instead.

func (DataStore_ContentConfig) Number 

func (x DataStore_ContentConfig) Number() protoreflect.EnumNumber

func (DataStore_ContentConfig) String 

func (x DataStore_ContentConfig) String() string

func (DataStore_ContentConfig) Type 

func (DataStore_ContentConfig) Type() protoreflect.EnumType

type DeleteControlRequest added in v1.8.0 

type DeleteControlRequest struct {

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

Request for DeleteControl method.

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

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

Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.

func (*DeleteControlRequest) GetName added in v1.8.0 

func (x *DeleteControlRequest) GetName() string

func (*DeleteControlRequest) ProtoMessage added in v1.8.0 

func (*DeleteControlRequest) ProtoMessage()

func (*DeleteControlRequest) ProtoReflect added in v1.8.0 

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

func (*DeleteControlRequest) Reset added in v1.8.0 

func (x *DeleteControlRequest) Reset()

func (*DeleteControlRequest) String added in v1.8.0 

func (x *DeleteControlRequest) String() string

type DeleteConversationRequest 

type DeleteConversationRequest struct {

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

Request for DeleteConversation method.

func (*DeleteConversationRequest) Descriptor deprecated 

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

Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.

func (*DeleteConversationRequest) GetName 

func (x *DeleteConversationRequest) GetName() string

func (*DeleteConversationRequest) ProtoMessage 

func (*DeleteConversationRequest) ProtoMessage()

func (*DeleteConversationRequest) ProtoReflect 

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

func (*DeleteConversationRequest) Reset 

func (x *DeleteConversationRequest) Reset()

func (*DeleteConversationRequest) String 

func (x *DeleteConversationRequest) String() string

type DeleteDataStoreMetadata 

type DeleteDataStoreMetadata struct {

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

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

func (*DeleteDataStoreMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreMetadata) GetCreateTime 

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

func (*DeleteDataStoreMetadata) GetUpdateTime 

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

func (*DeleteDataStoreMetadata) ProtoMessage 

func (*DeleteDataStoreMetadata) ProtoMessage()

func (*DeleteDataStoreMetadata) ProtoReflect 

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

func (*DeleteDataStoreMetadata) Reset 

func (x *DeleteDataStoreMetadata) Reset()

func (*DeleteDataStoreMetadata) String 

func (x *DeleteDataStoreMetadata) String() string

type DeleteDataStoreRequest 

type DeleteDataStoreRequest struct {

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

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

func (*DeleteDataStoreRequest) Descriptor deprecated 

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

Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataStoreRequest) GetName 

func (x *DeleteDataStoreRequest) GetName() string

func (*DeleteDataStoreRequest) ProtoMessage 

func (*DeleteDataStoreRequest) ProtoMessage()

func (*DeleteDataStoreRequest) ProtoReflect 

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

func (*DeleteDataStoreRequest) Reset 

func (x *DeleteDataStoreRequest) Reset()

func (*DeleteDataStoreRequest) String 

func (x *DeleteDataStoreRequest) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

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

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

func (*DeleteDocumentRequest) Descriptor deprecated 

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

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetName 

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

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

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteEngineMetadata 

type DeleteEngineMetadata struct {

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

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

func (*DeleteEngineMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.

func (*DeleteEngineMetadata) GetCreateTime 

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

func (*DeleteEngineMetadata) GetUpdateTime 

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

func (*DeleteEngineMetadata) ProtoMessage 

func (*DeleteEngineMetadata) ProtoMessage()

func (*DeleteEngineMetadata) ProtoReflect 

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

func (*DeleteEngineMetadata) Reset 

func (x *DeleteEngineMetadata) Reset()

func (*DeleteEngineMetadata) String 

func (x *DeleteEngineMetadata) String() string

type DeleteEngineRequest 

type DeleteEngineRequest struct {

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

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

func (*DeleteEngineRequest) Descriptor deprecated 

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

Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.

func (*DeleteEngineRequest) GetName 

func (x *DeleteEngineRequest) GetName() string

func (*DeleteEngineRequest) ProtoMessage 

func (*DeleteEngineRequest) ProtoMessage()

func (*DeleteEngineRequest) ProtoReflect 

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

func (*DeleteEngineRequest) Reset 

func (x *DeleteEngineRequest) Reset()

func (*DeleteEngineRequest) String 

func (x *DeleteEngineRequest) String() string

type DeleteSampleQueryRequest added in v1.10.0 

type DeleteSampleQueryRequest struct {

	// Required. Full resource name of
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
	//
	// If the caller does not have permission to delete the
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
	// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to
	// delete does not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] method.

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

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

Deprecated: Use DeleteSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*DeleteSampleQueryRequest) GetName added in v1.10.0 

func (x *DeleteSampleQueryRequest) GetName() string

func (*DeleteSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*DeleteSampleQueryRequest) ProtoMessage()

func (*DeleteSampleQueryRequest) ProtoReflect added in v1.10.0 

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

func (*DeleteSampleQueryRequest) Reset added in v1.10.0 

func (x *DeleteSampleQueryRequest) Reset()

func (*DeleteSampleQueryRequest) String added in v1.10.0 

func (x *DeleteSampleQueryRequest) String() string

type DeleteSampleQuerySetRequest added in v1.10.0 

type DeleteSampleQuerySetRequest struct {

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

Request message for [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] method.

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

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

Deprecated: Use DeleteSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*DeleteSampleQuerySetRequest) GetName added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) GetName() string

func (*DeleteSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*DeleteSampleQuerySetRequest) ProtoMessage()

func (*DeleteSampleQuerySetRequest) ProtoReflect added in v1.10.0 

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

func (*DeleteSampleQuerySetRequest) Reset added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) Reset()

func (*DeleteSampleQuerySetRequest) String added in v1.10.0 

func (x *DeleteSampleQuerySetRequest) String() string

type DeleteSchemaMetadata 

type DeleteSchemaMetadata struct {

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

Metadata for DeleteSchema LRO.

func (*DeleteSchemaMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSchemaMetadata) GetCreateTime 

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

func (*DeleteSchemaMetadata) GetUpdateTime 

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

func (*DeleteSchemaMetadata) ProtoMessage 

func (*DeleteSchemaMetadata) ProtoMessage()

func (*DeleteSchemaMetadata) ProtoReflect 

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

func (*DeleteSchemaMetadata) Reset 

func (x *DeleteSchemaMetadata) Reset()

func (*DeleteSchemaMetadata) String 

func (x *DeleteSchemaMetadata) String() string

type DeleteSchemaRequest 

type DeleteSchemaRequest struct {

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

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

func (*DeleteSchemaRequest) Descriptor deprecated 

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

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName 

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage 

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect 

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

func (*DeleteSchemaRequest) Reset 

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String 

func (x *DeleteSchemaRequest) String() string

type DeleteSessionRequest added in v1.7.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.7.0 

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

Deprecated: Use DeleteSessionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSessionRequest) GetName added in v1.7.0 

func (x *DeleteSessionRequest) GetName() string

func (*DeleteSessionRequest) ProtoMessage added in v1.7.0 

func (*DeleteSessionRequest) ProtoMessage()

func (*DeleteSessionRequest) ProtoReflect added in v1.7.0 

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

func (*DeleteSessionRequest) Reset added in v1.7.0 

func (x *DeleteSessionRequest) Reset()

func (*DeleteSessionRequest) String added in v1.7.0 

func (x *DeleteSessionRequest) String() string

type DeleteTargetSiteMetadata added in v1.4.0 

type DeleteTargetSiteMetadata struct {

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

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

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

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

Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteMetadata) GetCreateTime added in v1.4.0 

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

func (*DeleteTargetSiteMetadata) GetUpdateTime added in v1.4.0 

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

func (*DeleteTargetSiteMetadata) ProtoMessage added in v1.4.0 

func (*DeleteTargetSiteMetadata) ProtoMessage()

func (*DeleteTargetSiteMetadata) ProtoReflect added in v1.4.0 

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

func (*DeleteTargetSiteMetadata) Reset added in v1.4.0 

func (x *DeleteTargetSiteMetadata) Reset()

func (*DeleteTargetSiteMetadata) String added in v1.4.0 

func (x *DeleteTargetSiteMetadata) String() string

type DeleteTargetSiteRequest added in v1.4.0 

type DeleteTargetSiteRequest struct {

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

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

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

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

Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*DeleteTargetSiteRequest) GetName added in v1.4.0 

func (x *DeleteTargetSiteRequest) GetName() string

func (*DeleteTargetSiteRequest) ProtoMessage added in v1.4.0 

func (*DeleteTargetSiteRequest) ProtoMessage()

func (*DeleteTargetSiteRequest) ProtoReflect added in v1.4.0 

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

func (*DeleteTargetSiteRequest) Reset added in v1.4.0 

func (x *DeleteTargetSiteRequest) Reset()

func (*DeleteTargetSiteRequest) String added in v1.4.0 

func (x *DeleteTargetSiteRequest) String() string

type DisableAdvancedSiteSearchMetadata added in v1.4.0 

type DisableAdvancedSiteSearchMetadata struct {

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchMetadata) GetCreateTime added in v1.4.0 

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

func (*DisableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.4.0 

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

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage added in v1.4.0 

func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()

func (*DisableAdvancedSiteSearchMetadata) ProtoReflect added in v1.4.0 

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

func (*DisableAdvancedSiteSearchMetadata) Reset added in v1.4.0 

func (x *DisableAdvancedSiteSearchMetadata) Reset()

func (*DisableAdvancedSiteSearchMetadata) String added in v1.4.0 

func (x *DisableAdvancedSiteSearchMetadata) String() string

type DisableAdvancedSiteSearchRequest added in v1.4.0 

type DisableAdvancedSiteSearchRequest struct {

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.4.0 

func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*DisableAdvancedSiteSearchRequest) ProtoMessage added in v1.4.0 

func (*DisableAdvancedSiteSearchRequest) ProtoMessage()

func (*DisableAdvancedSiteSearchRequest) ProtoReflect added in v1.4.0 

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

func (*DisableAdvancedSiteSearchRequest) Reset added in v1.4.0 

func (x *DisableAdvancedSiteSearchRequest) Reset()

func (*DisableAdvancedSiteSearchRequest) String added in v1.4.0 

func (x *DisableAdvancedSiteSearchRequest) String() string

type DisableAdvancedSiteSearchResponse added in v1.4.0 

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

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

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

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

Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*DisableAdvancedSiteSearchResponse) ProtoMessage added in v1.4.0 

func (*DisableAdvancedSiteSearchResponse) ProtoMessage()

func (*DisableAdvancedSiteSearchResponse) ProtoReflect added in v1.4.0 

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

func (*DisableAdvancedSiteSearchResponse) Reset added in v1.4.0 

func (x *DisableAdvancedSiteSearchResponse) Reset()

func (*DisableAdvancedSiteSearchResponse) String added in v1.4.0 

func (x *DisableAdvancedSiteSearchResponse) String() string

type Document 

type Document struct {

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

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

func (*Document) Descriptor deprecated 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetAclInfo added in v1.6.0 

func (x *Document) GetAclInfo() *Document_AclInfo

func (*Document) GetContent 

func (x *Document) GetContent() *Document_Content

func (*Document) GetData 

func (m *Document) GetData() isDocument_Data

func (*Document) GetDerivedStructData 

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

func (*Document) GetId 

func (x *Document) GetId() string

func (*Document) GetIndexStatus added in v1.14.0 

func (x *Document) GetIndexStatus() *Document_IndexStatus

func (*Document) GetIndexTime added in v1.6.0 

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

func (*Document) GetJsonData 

func (x *Document) GetJsonData() string

func (*Document) GetName 

func (x *Document) GetName() string

func (*Document) GetParentDocumentId 

func (x *Document) GetParentDocumentId() string

func (*Document) GetSchemaId 

func (x *Document) GetSchemaId() string

func (*Document) GetStructData 

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

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

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

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type DocumentInfo 

type DocumentInfo struct {

	// A required descriptor of the associated
	// [Document][google.cloud.discoveryengine.v1alpha.Document].
	//
	// * If [id][google.cloud.discoveryengine.v1alpha.DocumentInfo.id] is
	// specified, then the default values for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are
	// used when annotating with the stored Document.
	//
	// * If [name][google.cloud.discoveryengine.v1alpha.DocumentInfo.name] is
	// specified, then the provided values (default values allowed) for
	// `{location}`, `{collection_id}`, `{data_store_id}`, and
	// `{branch_id}` are used when annotating with the stored Document.
	//
	// Types that are assignable to DocumentDescriptor:
	//
	//	*DocumentInfo_Id
	//	*DocumentInfo_Name
	//	*DocumentInfo_Uri
	DocumentDescriptor isDocumentInfo_DocumentDescriptor `protobuf_oneof:"document_descriptor"`
	// Quantity of the Document associated with the user event. Defaults to 1.
	//
	// For example, this field is 2 if two quantities of the same Document
	// are involved in a `add-to-cart` event.
	//
	// Required for events of the following event types:
	//
	// * `add-to-cart`
	// * `purchase`
	Quantity *int32 `protobuf:"varint,3,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
	// The promotion IDs associated with this Document.
	// Currently, this field is restricted to at most one ID.
	PromotionIds []string `protobuf:"bytes,4,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
	// Output only. Whether the referenced Document can be found in the data
	// store.
	Joined bool `protobuf:"varint,5,opt,name=joined,proto3" json:"joined,omitempty"`
	// contains filtered or unexported fields
}

Detailed document information associated with a user event.

func (*DocumentInfo) Descriptor deprecated 

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

Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.

func (*DocumentInfo) GetDocumentDescriptor 

func (m *DocumentInfo) GetDocumentDescriptor() isDocumentInfo_DocumentDescriptor

func (*DocumentInfo) GetId 

func (x *DocumentInfo) GetId() string

func (*DocumentInfo) GetJoined added in v1.14.0 

func (x *DocumentInfo) GetJoined() bool

func (*DocumentInfo) GetName 

func (x *DocumentInfo) GetName() string

func (*DocumentInfo) GetPromotionIds 

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

func (*DocumentInfo) GetQuantity 

func (x *DocumentInfo) GetQuantity() int32

func (*DocumentInfo) GetUri 

func (x *DocumentInfo) GetUri() string

func (*DocumentInfo) ProtoMessage 

func (*DocumentInfo) ProtoMessage()

func (*DocumentInfo) ProtoReflect 

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

func (*DocumentInfo) Reset 

func (x *DocumentInfo) Reset()

func (*DocumentInfo) String 

func (x *DocumentInfo) String() string

type DocumentInfo_Id 

type DocumentInfo_Id struct {
	// The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
	// ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type DocumentInfo_Name 

type DocumentInfo_Name struct {
	// The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
	// full name, of the form:
	// `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
	Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}

type DocumentInfo_Uri 

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

type DocumentProcessingConfig added in v1.6.0 

type DocumentProcessingConfig struct {

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

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

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

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

Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig) GetChunkingConfig added in v1.6.0 

func (x *DocumentProcessingConfig) GetChunkingConfig() *DocumentProcessingConfig_ChunkingConfig

func (*DocumentProcessingConfig) GetDefaultParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig) GetDefaultParsingConfig() *DocumentProcessingConfig_ParsingConfig

func (*DocumentProcessingConfig) GetName added in v1.6.0 

func (x *DocumentProcessingConfig) GetName() string

func (*DocumentProcessingConfig) GetParsingConfigOverrides added in v1.6.0 

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

func (*DocumentProcessingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig) ProtoMessage()

func (*DocumentProcessingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig) Reset()

func (*DocumentProcessingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig added in v1.6.0 

type DocumentProcessingConfig_ChunkingConfig struct {

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

Configuration for chunking config.

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

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode added in v1.6.0 

func (m *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkMode

func (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig() *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ChunkingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig added in v1.6.0 

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {

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

Configuration for the layout based chunking.

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

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

Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize() int32

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings() bool

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset()

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String() string

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ added in v1.6.0 

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

type DocumentProcessingConfig_ParsingConfig added in v1.6.0 

type DocumentProcessingConfig_ParsingConfig struct {

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

Related configurations applied to a specific type of document parser.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig() *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig added in v1.6.0 

func (m *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig added in v1.6.0 

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

The digital parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_ added in v1.6.0 

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

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig added in v1.6.0 

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

The layout parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ added in v1.6.0 

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

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig added in v1.6.0 

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {

	// [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/v1alpha/document_processing_config.proto.
	EnhancedDocumentElements []string `` /* 135-byte string literal not displayed */
	// If true, will use native text instead of OCR text on pages containing
	// native text.
	UseNativeText bool `protobuf:"varint,2,opt,name=use_native_text,json=useNativeText,proto3" json:"use_native_text,omitempty"`
	// contains filtered or unexported fields
}

The OCR parsing configurations for documents.

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

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

Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.

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

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

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText() bool

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage added in v1.6.0 

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect added in v1.6.0 

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset()

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String added in v1.6.0 

func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String() string

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_ added in v1.6.0 

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

type DocumentServiceClient 

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

type Document_AclInfo struct {

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

ACL Information of the Document.

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

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

Deprecated: Use Document_AclInfo.ProtoReflect.Descriptor instead.

func (*Document_AclInfo) GetReaders added in v1.6.0 

func (x *Document_AclInfo) GetReaders() []*Document_AclInfo_AccessRestriction

func (*Document_AclInfo) ProtoMessage added in v1.6.0 

func (*Document_AclInfo) ProtoMessage()

func (*Document_AclInfo) ProtoReflect added in v1.6.0 

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

func (*Document_AclInfo) Reset added in v1.6.0 

func (x *Document_AclInfo) Reset()

func (*Document_AclInfo) String added in v1.6.0 

func (x *Document_AclInfo) String() string

type Document_AclInfo_AccessRestriction added in v1.6.0 

type Document_AclInfo_AccessRestriction struct {

	// List of principals.
	Principals []*Principal `protobuf:"bytes,1,rep,name=principals,proto3" json:"principals,omitempty"`
	// 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.6.0 

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

Deprecated: Use Document_AclInfo_AccessRestriction.ProtoReflect.Descriptor instead.

func (*Document_AclInfo_AccessRestriction) GetIdpWide added in v1.12.0 

func (x *Document_AclInfo_AccessRestriction) GetIdpWide() bool

func (*Document_AclInfo_AccessRestriction) GetPrincipals added in v1.6.0 

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

func (*Document_AclInfo_AccessRestriction) ProtoMessage added in v1.6.0 

func (*Document_AclInfo_AccessRestriction) ProtoMessage()

func (*Document_AclInfo_AccessRestriction) ProtoReflect added in v1.6.0 

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

func (*Document_AclInfo_AccessRestriction) Reset added in v1.6.0 

func (x *Document_AclInfo_AccessRestriction) Reset()

func (*Document_AclInfo_AccessRestriction) String added in v1.6.0 

func (x *Document_AclInfo_AccessRestriction) String() string

type Document_Content 

type Document_Content struct {

	// Types that are assignable to Content:
	//
	//	*Document_Content_RawBytes
	//	*Document_Content_Uri
	Content isDocument_Content_Content `protobuf_oneof:"content"`
	// The MIME type of the content. Supported types:
	//
	// * `application/pdf` (PDF, only native PDFs are supported for now)
	// * `text/html` (HTML)
	// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
	// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
	// * `text/plain` (TXT)
	//
	// See https://www.iana.org/assignments/media-types/media-types.xhtml.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

Unstructured data linked to this document.

func (*Document_Content) Descriptor deprecated 

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

Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.

func (*Document_Content) GetContent 

func (m *Document_Content) GetContent() isDocument_Content_Content

func (*Document_Content) GetMimeType 

func (x *Document_Content) GetMimeType() string

func (*Document_Content) GetRawBytes 

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

func (*Document_Content) GetUri 

func (x *Document_Content) GetUri() string

func (*Document_Content) ProtoMessage 

func (*Document_Content) ProtoMessage()

func (*Document_Content) ProtoReflect 

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

func (*Document_Content) Reset 

func (x *Document_Content) Reset()

func (*Document_Content) String 

func (x *Document_Content) String() string

type Document_Content_RawBytes 

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

type Document_Content_Uri 

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

type Document_IndexStatus added in v1.14.0 

type Document_IndexStatus struct {

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

Index status of the document.

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

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

Deprecated: Use Document_IndexStatus.ProtoReflect.Descriptor instead.

func (*Document_IndexStatus) GetErrorSamples added in v1.14.0 

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

func (*Document_IndexStatus) GetIndexTime added in v1.14.0 

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

func (*Document_IndexStatus) ProtoMessage added in v1.14.0 

func (*Document_IndexStatus) ProtoMessage()

func (*Document_IndexStatus) ProtoReflect added in v1.14.0 

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

func (*Document_IndexStatus) Reset added in v1.14.0 

func (x *Document_IndexStatus) Reset()

func (*Document_IndexStatus) String added in v1.14.0 

func (x *Document_IndexStatus) String() string

type Document_JsonData 

type Document_JsonData struct {
	// The JSON string representation of the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	JsonData string `protobuf:"bytes,5,opt,name=json_data,json=jsonData,proto3,oneof"`
}

type Document_StructData 

type Document_StructData struct {
	// The structured JSON data for the document. It should conform to the
	// registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
	// `INVALID_ARGUMENT` error is thrown.
	StructData *structpb.Struct `protobuf:"bytes,4,opt,name=struct_data,json=structData,proto3,oneof"`
}

type DoubleList 

type DoubleList struct {

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

Double list.

func (*DoubleList) Descriptor deprecated 

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

Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.

func (*DoubleList) GetValues 

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

func (*DoubleList) ProtoMessage 

func (*DoubleList) ProtoMessage()

func (*DoubleList) ProtoReflect 

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

func (*DoubleList) Reset 

func (x *DoubleList) Reset()

func (*DoubleList) String 

func (x *DoubleList) String() string

type EmbeddingConfig added in v1.6.0 

type EmbeddingConfig struct {

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

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

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

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

Deprecated: Use EmbeddingConfig.ProtoReflect.Descriptor instead.

func (*EmbeddingConfig) GetFieldPath added in v1.6.0 

func (x *EmbeddingConfig) GetFieldPath() string

func (*EmbeddingConfig) ProtoMessage added in v1.6.0 

func (*EmbeddingConfig) ProtoMessage()

func (*EmbeddingConfig) ProtoReflect added in v1.6.0 

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

func (*EmbeddingConfig) Reset added in v1.6.0 

func (x *EmbeddingConfig) Reset()

func (*EmbeddingConfig) String added in v1.6.0 

func (x *EmbeddingConfig) String() string

type EnableAdvancedSiteSearchMetadata added in v1.4.0 

type EnableAdvancedSiteSearchMetadata struct {

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchMetadata) GetCreateTime added in v1.4.0 

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

func (*EnableAdvancedSiteSearchMetadata) GetUpdateTime added in v1.4.0 

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

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage added in v1.4.0 

func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()

func (*EnableAdvancedSiteSearchMetadata) ProtoReflect added in v1.4.0 

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

func (*EnableAdvancedSiteSearchMetadata) Reset added in v1.4.0 

func (x *EnableAdvancedSiteSearchMetadata) Reset()

func (*EnableAdvancedSiteSearchMetadata) String added in v1.4.0 

func (x *EnableAdvancedSiteSearchMetadata) String() string

type EnableAdvancedSiteSearchRequest added in v1.4.0 

type EnableAdvancedSiteSearchRequest struct {

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine added in v1.4.0 

func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() string

func (*EnableAdvancedSiteSearchRequest) ProtoMessage added in v1.4.0 

func (*EnableAdvancedSiteSearchRequest) ProtoMessage()

func (*EnableAdvancedSiteSearchRequest) ProtoReflect added in v1.4.0 

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

func (*EnableAdvancedSiteSearchRequest) Reset added in v1.4.0 

func (x *EnableAdvancedSiteSearchRequest) Reset()

func (*EnableAdvancedSiteSearchRequest) String added in v1.4.0 

func (x *EnableAdvancedSiteSearchRequest) String() string

type EnableAdvancedSiteSearchResponse added in v1.4.0 

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

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

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

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

Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.

func (*EnableAdvancedSiteSearchResponse) ProtoMessage added in v1.4.0 

func (*EnableAdvancedSiteSearchResponse) ProtoMessage()

func (*EnableAdvancedSiteSearchResponse) ProtoReflect added in v1.4.0 

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

func (*EnableAdvancedSiteSearchResponse) Reset added in v1.4.0 

func (x *EnableAdvancedSiteSearchResponse) Reset()

func (*EnableAdvancedSiteSearchResponse) String added in v1.4.0 

func (x *EnableAdvancedSiteSearchResponse) String() string

type Engine 

type Engine struct {

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

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

func (*Engine) Descriptor deprecated 

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

Deprecated: Use Engine.ProtoReflect.Descriptor instead.

func (*Engine) GetChatEngineConfig 

func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfig

func (*Engine) GetChatEngineMetadata 

func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadata

func (*Engine) GetCommonConfig 

func (x *Engine) GetCommonConfig() *Engine_CommonConfig

func (*Engine) GetCreateTime 

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

func (*Engine) GetDataStoreIds 

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

func (*Engine) GetDisplayName 

func (x *Engine) GetDisplayName() string

func (*Engine) GetEngineConfig 

func (m *Engine) GetEngineConfig() isEngine_EngineConfig

func (*Engine) GetEngineMetadata 

func (m *Engine) GetEngineMetadata() isEngine_EngineMetadata

func (*Engine) GetIndustryVertical 

func (x *Engine) GetIndustryVertical() IndustryVertical

func (*Engine) GetMediaRecommendationEngineConfig 

func (x *Engine) GetMediaRecommendationEngineConfig() *Engine_MediaRecommendationEngineConfig

func (*Engine) GetName 

func (x *Engine) GetName() string

func (*Engine) GetRecommendationMetadata 

func (x *Engine) GetRecommendationMetadata() *Engine_RecommendationMetadata

func (*Engine) GetSearchEngineConfig 

func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfig

func (*Engine) GetSimilarDocumentsConfig 

func (x *Engine) GetSimilarDocumentsConfig() *Engine_SimilarDocumentsEngineConfig

func (*Engine) GetSolutionType 

func (x *Engine) GetSolutionType() SolutionType

func (*Engine) GetUpdateTime 

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

func (*Engine) ProtoMessage 

func (*Engine) ProtoMessage()

func (*Engine) ProtoReflect 

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

func (*Engine) Reset 

func (x *Engine) Reset()

func (*Engine) String 

func (x *Engine) String() string

type EngineServiceClient 

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

EngineServiceClient is the client API for EngineService service.

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

func NewEngineServiceClient 

func NewEngineServiceClient(cc grpc.ClientConnInterface) EngineServiceClient

type EngineServiceServer 

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

EngineServiceServer is the server API for EngineService service. All implementations should embed UnimplementedEngineServiceServer for forward compatibility

type Engine_ChatEngineConfig 

type Engine_ChatEngineConfig struct {

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

Configurations for a Chat Engine.

func (*Engine_ChatEngineConfig) Descriptor deprecated 

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

Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig) GetAgentCreationConfig 

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

func (*Engine_ChatEngineConfig) ProtoMessage 

func (*Engine_ChatEngineConfig) ProtoMessage()

func (*Engine_ChatEngineConfig) ProtoReflect 

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

func (*Engine_ChatEngineConfig) Reset 

func (x *Engine_ChatEngineConfig) Reset()

func (*Engine_ChatEngineConfig) String 

func (x *Engine_ChatEngineConfig) String() string

type Engine_ChatEngineConfig_ 

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

type Engine_ChatEngineConfig_AgentCreationConfig 

type Engine_ChatEngineConfig_AgentCreationConfig struct {

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

Configurations for generating a Dialogflow agent.

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

func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor deprecated 

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

Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation added in v1.6.0 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetLocation() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone() string

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage 

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage()

func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect 

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

func (*Engine_ChatEngineConfig_AgentCreationConfig) Reset 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) Reset()

func (*Engine_ChatEngineConfig_AgentCreationConfig) String 

func (x *Engine_ChatEngineConfig_AgentCreationConfig) String() string

type Engine_ChatEngineMetadata 

type Engine_ChatEngineMetadata struct {

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

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

func (*Engine_ChatEngineMetadata) Descriptor deprecated 

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

Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.

func (*Engine_ChatEngineMetadata) GetDialogflowAgent 

func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() string

func (*Engine_ChatEngineMetadata) ProtoMessage 

func (*Engine_ChatEngineMetadata) ProtoMessage()

func (*Engine_ChatEngineMetadata) ProtoReflect 

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

func (*Engine_ChatEngineMetadata) Reset 

func (x *Engine_ChatEngineMetadata) Reset()

func (*Engine_ChatEngineMetadata) String 

func (x *Engine_ChatEngineMetadata) String() string

type Engine_ChatEngineMetadata_ 

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

type Engine_CommonConfig 

type Engine_CommonConfig struct {

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

Common configurations for an Engine.

func (*Engine_CommonConfig) Descriptor deprecated 

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

Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.

func (*Engine_CommonConfig) GetCompanyName 

func (x *Engine_CommonConfig) GetCompanyName() string

func (*Engine_CommonConfig) ProtoMessage 

func (*Engine_CommonConfig) ProtoMessage()

func (*Engine_CommonConfig) ProtoReflect 

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

func (*Engine_CommonConfig) Reset 

func (x *Engine_CommonConfig) Reset()

func (*Engine_CommonConfig) String 

func (x *Engine_CommonConfig) String() string

type Engine_MediaRecommendationEngineConfig 

type Engine_MediaRecommendationEngineConfig struct {

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

Additional config specs for a Media Recommendation engine.

func (*Engine_MediaRecommendationEngineConfig) Descriptor deprecated 

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

Deprecated: Use Engine_MediaRecommendationEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjective 

func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjective() string

func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig 

func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig() *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig

func (*Engine_MediaRecommendationEngineConfig) GetTrainingState 

func (x *Engine_MediaRecommendationEngineConfig) GetTrainingState() Engine_MediaRecommendationEngineConfig_TrainingState

func (*Engine_MediaRecommendationEngineConfig) GetType 

func (x *Engine_MediaRecommendationEngineConfig) GetType() string

func (*Engine_MediaRecommendationEngineConfig) ProtoMessage 

func (*Engine_MediaRecommendationEngineConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig) ProtoReflect 

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

func (*Engine_MediaRecommendationEngineConfig) Reset 

func (x *Engine_MediaRecommendationEngineConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig) String 

func (x *Engine_MediaRecommendationEngineConfig) String() string

type Engine_MediaRecommendationEngineConfig_ 

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

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig 

type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig struct {

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

Custom threshold for `cvr` optimization_objective.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor deprecated 

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

Deprecated: Use Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig.ProtoReflect.Descriptor instead.

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField() string

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat() float32

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage 

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage()

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect 

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

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset()

func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String 

func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String() string

type Engine_MediaRecommendationEngineConfig_TrainingState 

type Engine_MediaRecommendationEngineConfig_TrainingState int32

The training state of the engine. 

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

func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor 

func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor() protoreflect.EnumDescriptor

func (Engine_MediaRecommendationEngineConfig_TrainingState) Enum 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) Enum() *Engine_MediaRecommendationEngineConfig_TrainingState

func (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor deprecated 

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

Deprecated: Use Engine_MediaRecommendationEngineConfig_TrainingState.Descriptor instead.

func (Engine_MediaRecommendationEngineConfig_TrainingState) Number 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) Number() protoreflect.EnumNumber

func (Engine_MediaRecommendationEngineConfig_TrainingState) String 

func (x Engine_MediaRecommendationEngineConfig_TrainingState) String() string

func (Engine_MediaRecommendationEngineConfig_TrainingState) Type 

func (Engine_MediaRecommendationEngineConfig_TrainingState) Type() protoreflect.EnumType

type Engine_RecommendationMetadata 

type Engine_RecommendationMetadata struct {

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

Additional information of a recommendation engine.

func (*Engine_RecommendationMetadata) Descriptor deprecated 

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

Deprecated: Use Engine_RecommendationMetadata.ProtoReflect.Descriptor instead.

func (*Engine_RecommendationMetadata) GetDataState 

func (x *Engine_RecommendationMetadata) GetDataState() Engine_RecommendationMetadata_DataState

func (*Engine_RecommendationMetadata) GetLastTuneTime 

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

func (*Engine_RecommendationMetadata) GetServingState 

func (x *Engine_RecommendationMetadata) GetServingState() Engine_RecommendationMetadata_ServingState

func (*Engine_RecommendationMetadata) GetTuningOperation 

func (x *Engine_RecommendationMetadata) GetTuningOperation() string

func (*Engine_RecommendationMetadata) ProtoMessage 

func (*Engine_RecommendationMetadata) ProtoMessage()

func (*Engine_RecommendationMetadata) ProtoReflect 

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

func (*Engine_RecommendationMetadata) Reset 

func (x *Engine_RecommendationMetadata) Reset()

func (*Engine_RecommendationMetadata) String 

func (x *Engine_RecommendationMetadata) String() string

type Engine_RecommendationMetadata_ 

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

type Engine_RecommendationMetadata_DataState 

type Engine_RecommendationMetadata_DataState int32

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

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

func (Engine_RecommendationMetadata_DataState) Descriptor 

func (Engine_RecommendationMetadata_DataState) Descriptor() protoreflect.EnumDescriptor

func (Engine_RecommendationMetadata_DataState) Enum 

func (x Engine_RecommendationMetadata_DataState) Enum() *Engine_RecommendationMetadata_DataState

func (Engine_RecommendationMetadata_DataState) EnumDescriptor deprecated 

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

Deprecated: Use Engine_RecommendationMetadata_DataState.Descriptor instead.

func (Engine_RecommendationMetadata_DataState) Number 

func (x Engine_RecommendationMetadata_DataState) Number() protoreflect.EnumNumber

func (Engine_RecommendationMetadata_DataState) String 

func (x Engine_RecommendationMetadata_DataState) String() string

func (Engine_RecommendationMetadata_DataState) Type 

func (Engine_RecommendationMetadata_DataState) Type() protoreflect.EnumType

type Engine_RecommendationMetadata_ServingState 

type Engine_RecommendationMetadata_ServingState int32

The serving state of the recommendation engine. 

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

func (Engine_RecommendationMetadata_ServingState) Descriptor 

func (Engine_RecommendationMetadata_ServingState) Descriptor() protoreflect.EnumDescriptor

func (Engine_RecommendationMetadata_ServingState) Enum 

func (x Engine_RecommendationMetadata_ServingState) Enum() *Engine_RecommendationMetadata_ServingState

func (Engine_RecommendationMetadata_ServingState) EnumDescriptor deprecated 

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

Deprecated: Use Engine_RecommendationMetadata_ServingState.Descriptor instead.

func (Engine_RecommendationMetadata_ServingState) Number 

func (x Engine_RecommendationMetadata_ServingState) Number() protoreflect.EnumNumber

func (Engine_RecommendationMetadata_ServingState) String 

func (x Engine_RecommendationMetadata_ServingState) String() string

func (Engine_RecommendationMetadata_ServingState) Type 

func (Engine_RecommendationMetadata_ServingState) Type() protoreflect.EnumType

type Engine_SearchEngineConfig 

type Engine_SearchEngineConfig struct {

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

Configurations for a Search Engine.

func (*Engine_SearchEngineConfig) Descriptor deprecated 

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

Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SearchEngineConfig) GetSearchAddOns 

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

func (*Engine_SearchEngineConfig) GetSearchTier 

func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTier

func (*Engine_SearchEngineConfig) ProtoMessage 

func (*Engine_SearchEngineConfig) ProtoMessage()

func (*Engine_SearchEngineConfig) ProtoReflect 

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

func (*Engine_SearchEngineConfig) Reset 

func (x *Engine_SearchEngineConfig) Reset()

func (*Engine_SearchEngineConfig) String 

func (x *Engine_SearchEngineConfig) String() string

type Engine_SearchEngineConfig_ 

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

type Engine_SimilarDocumentsConfig 

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

type Engine_SimilarDocumentsEngineConfig 

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

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

func (*Engine_SimilarDocumentsEngineConfig) Descriptor deprecated 

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

Deprecated: Use Engine_SimilarDocumentsEngineConfig.ProtoReflect.Descriptor instead.

func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage 

func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage()

func (*Engine_SimilarDocumentsEngineConfig) ProtoReflect 

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

func (*Engine_SimilarDocumentsEngineConfig) Reset 

func (x *Engine_SimilarDocumentsEngineConfig) Reset()

func (*Engine_SimilarDocumentsEngineConfig) String 

func (x *Engine_SimilarDocumentsEngineConfig) String() string

type EstimateBillingServiceClient added in v1.6.0 

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

EstimateBillingServiceClient is the client API for EstimateBillingService service.

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

func NewEstimateBillingServiceClient added in v1.6.0 

func NewEstimateBillingServiceClient(cc grpc.ClientConnInterface) EstimateBillingServiceClient

type EstimateBillingServiceServer added in v1.6.0 

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

EstimateBillingServiceServer is the server API for EstimateBillingService service. All implementations should embed UnimplementedEstimateBillingServiceServer for forward compatibility

type EstimateDataSizeMetadata added in v1.6.0 

type EstimateDataSizeMetadata struct {

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

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

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

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

Deprecated: Use EstimateDataSizeMetadata.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeMetadata) GetCreateTime added in v1.6.0 

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

func (*EstimateDataSizeMetadata) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeMetadata) ProtoMessage()

func (*EstimateDataSizeMetadata) ProtoReflect added in v1.6.0 

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

func (*EstimateDataSizeMetadata) Reset added in v1.6.0 

func (x *EstimateDataSizeMetadata) Reset()

func (*EstimateDataSizeMetadata) String added in v1.6.0 

func (x *EstimateDataSizeMetadata) String() string

type EstimateDataSizeRequest added in v1.6.0 

type EstimateDataSizeRequest struct {

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

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

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

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

Deprecated: Use EstimateDataSizeRequest.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest) GetDataSource added in v1.6.0 

func (m *EstimateDataSizeRequest) GetDataSource() isEstimateDataSizeRequest_DataSource

func (*EstimateDataSizeRequest) GetFileDataSource added in v1.6.0 

func (x *EstimateDataSizeRequest) GetFileDataSource() *EstimateDataSizeRequest_FileDataSource

func (*EstimateDataSizeRequest) GetLocation added in v1.6.0 

func (x *EstimateDataSizeRequest) GetLocation() string

func (*EstimateDataSizeRequest) GetWebsiteDataSource added in v1.6.0 

func (x *EstimateDataSizeRequest) GetWebsiteDataSource() *EstimateDataSizeRequest_WebsiteDataSource

func (*EstimateDataSizeRequest) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeRequest) ProtoMessage()

func (*EstimateDataSizeRequest) ProtoReflect added in v1.6.0 

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

func (*EstimateDataSizeRequest) Reset added in v1.6.0 

func (x *EstimateDataSizeRequest) Reset()

func (*EstimateDataSizeRequest) String added in v1.6.0 

func (x *EstimateDataSizeRequest) String() string

type EstimateDataSizeRequest_FileDataSource added in v1.6.0 

type EstimateDataSizeRequest_FileDataSource struct {

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

Data source contains files either in Cloud Storage or BigQuery.

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

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

Deprecated: Use EstimateDataSizeRequest_FileDataSource.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_FileDataSource) GetBigquerySource added in v1.6.0 

func (x *EstimateDataSizeRequest_FileDataSource) GetBigquerySource() *BigQuerySource

func (*EstimateDataSizeRequest_FileDataSource) GetGcsSource added in v1.6.0 

func (x *EstimateDataSizeRequest_FileDataSource) GetGcsSource() *GcsSource

func (*EstimateDataSizeRequest_FileDataSource) GetSource added in v1.6.0 

func (m *EstimateDataSizeRequest_FileDataSource) GetSource() isEstimateDataSizeRequest_FileDataSource_Source

func (*EstimateDataSizeRequest_FileDataSource) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeRequest_FileDataSource) ProtoMessage()

func (*EstimateDataSizeRequest_FileDataSource) ProtoReflect added in v1.6.0 

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

func (*EstimateDataSizeRequest_FileDataSource) Reset added in v1.6.0 

func (x *EstimateDataSizeRequest_FileDataSource) Reset()

func (*EstimateDataSizeRequest_FileDataSource) String added in v1.6.0 

func (x *EstimateDataSizeRequest_FileDataSource) String() string

type EstimateDataSizeRequest_FileDataSource_ added in v1.6.0 

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

type EstimateDataSizeRequest_FileDataSource_BigquerySource added in v1.6.0 

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

type EstimateDataSizeRequest_FileDataSource_GcsSource added in v1.6.0 

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

type EstimateDataSizeRequest_WebsiteDataSource added in v1.6.0 

type EstimateDataSizeRequest_WebsiteDataSource struct {

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

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

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

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

Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_WebsiteDataSource) GetEstimatorUriPatterns added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource) GetEstimatorUriPatterns() []*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern

func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoMessage()

func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoReflect added in v1.6.0 

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

func (*EstimateDataSizeRequest_WebsiteDataSource) Reset added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource) Reset()

func (*EstimateDataSizeRequest_WebsiteDataSource) String added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource) String() string

type EstimateDataSizeRequest_WebsiteDataSource_ added in v1.6.0 

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

type EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern added in v1.6.0 

type EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern struct {

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

URI patterns that we use to crawl.

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

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

Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExactMatch added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExactMatch() bool

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExclusive added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExclusive() bool

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetProvidedUriPattern added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetProvidedUriPattern() string

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoMessage()

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoReflect added in v1.6.0 

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

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Reset added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Reset()

func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) String added in v1.6.0 

func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) String() string

type EstimateDataSizeResponse added in v1.6.0 

type EstimateDataSizeResponse struct {

	// Data size in terms of bytes.
	DataSizeBytes int64 `protobuf:"varint,1,opt,name=data_size_bytes,json=dataSizeBytes,proto3" json:"data_size_bytes,omitempty"`
	// Total number of documents.
	DocumentCount int64 `protobuf:"varint,2,opt,name=document_count,json=documentCount,proto3" json:"document_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*EstimateDataSizeResponse) Descriptor deprecated added in v1.6.0 

func (*EstimateDataSizeResponse) Descriptor() ([]byte, []int)

Deprecated: Use EstimateDataSizeResponse.ProtoReflect.Descriptor instead.

func (*EstimateDataSizeResponse) GetDataSizeBytes added in v1.6.0 

func (x *EstimateDataSizeResponse) GetDataSizeBytes() int64

func (*EstimateDataSizeResponse) GetDocumentCount added in v1.6.0 

func (x *EstimateDataSizeResponse) GetDocumentCount() int64

func (*EstimateDataSizeResponse) ProtoMessage added in v1.6.0 

func (*EstimateDataSizeResponse) ProtoMessage()

func (*EstimateDataSizeResponse) ProtoReflect added in v1.6.0 

func (x *EstimateDataSizeResponse) ProtoReflect() protoreflect.Message

func (*EstimateDataSizeResponse) Reset added in v1.6.0 

func (x *EstimateDataSizeResponse) Reset()

func (*EstimateDataSizeResponse) String added in v1.6.0 

func (x *EstimateDataSizeResponse) String() string

type Evaluation added in v1.10.0 

type Evaluation struct {

	// Identifier. The full resource name of the
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
	// format of
	// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The specification of the evaluation.
	EvaluationSpec *Evaluation_EvaluationSpec `protobuf:"bytes,2,opt,name=evaluation_spec,json=evaluationSpec,proto3" json:"evaluation_spec,omitempty"`
	// Output only. The metrics produced by the evaluation, averaged across all
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s in the
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
	//
	// Only populated when the evaluation's state is SUCCEEDED.
	QualityMetrics *QualityMetrics `protobuf:"bytes,3,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
	// Output only. The state of the evaluation.
	State Evaluation_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.Evaluation_State" json:"state,omitempty"`
	// Output only. The error that occurred during evaluation. Only populated when
	// the evaluation's state is FAILED.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. Timestamp the
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was created
	// at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp the
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was completed
	// at.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,8,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

func (*Evaluation) Descriptor deprecated added in v1.10.0 

func (*Evaluation) Descriptor() ([]byte, []int)

Deprecated: Use Evaluation.ProtoReflect.Descriptor instead.

func (*Evaluation) GetCreateTime added in v1.10.0 

func (x *Evaluation) GetCreateTime() *timestamppb.Timestamp

func (*Evaluation) GetEndTime added in v1.10.0 

func (x *Evaluation) GetEndTime() *timestamppb.Timestamp

func (*Evaluation) GetError added in v1.10.0 

func (x *Evaluation) GetError() *status.Status

func (*Evaluation) GetErrorSamples added in v1.10.0 

func (x *Evaluation) GetErrorSamples() []*status.Status

func (*Evaluation) GetEvaluationSpec added in v1.10.0 

func (x *Evaluation) GetEvaluationSpec() *Evaluation_EvaluationSpec

func (*Evaluation) GetName added in v1.10.0 

func (x *Evaluation) GetName() string

func (*Evaluation) GetQualityMetrics added in v1.10.0 

func (x *Evaluation) GetQualityMetrics() *QualityMetrics

func (*Evaluation) GetState added in v1.10.0 

func (x *Evaluation) GetState() Evaluation_State

func (*Evaluation) ProtoMessage added in v1.10.0 

func (*Evaluation) ProtoMessage()

func (*Evaluation) ProtoReflect added in v1.10.0 

func (x *Evaluation) ProtoReflect() protoreflect.Message

func (*Evaluation) Reset added in v1.10.0 

func (x *Evaluation) Reset()

func (*Evaluation) String added in v1.10.0 

func (x *Evaluation) String() string

type EvaluationServiceClient added in v1.10.0 

type EvaluationServiceClient interface {
	// Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
	// Gets a list of
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
	ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
	// Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	//
	// Upon creation, the evaluation will be automatically triggered and begin
	// execution.
	CreateEvaluation(ctx context.Context, in *CreateEvaluationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a list of results for a given a
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	ListEvaluationResults(ctx context.Context, in *ListEvaluationResultsRequest, opts ...grpc.CallOption) (*ListEvaluationResultsResponse, error)
}

EvaluationServiceClient is the client API for EvaluationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEvaluationServiceClient added in v1.10.0 

func NewEvaluationServiceClient(cc grpc.ClientConnInterface) EvaluationServiceClient

type EvaluationServiceServer added in v1.10.0 

type EvaluationServiceServer interface {
	// Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)
	// Gets a list of
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
	ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)
	// Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	//
	// Upon creation, the evaluation will be automatically triggered and begin
	// execution.
	CreateEvaluation(context.Context, *CreateEvaluationRequest) (*longrunningpb.Operation, error)
	// Gets a list of results for a given a
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
	ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)
}

EvaluationServiceServer is the server API for EvaluationService service. All implementations should embed UnimplementedEvaluationServiceServer for forward compatibility

type Evaluation_EvaluationSpec added in v1.10.0 

type Evaluation_EvaluationSpec struct {

	// The search specification.
	//
	// Types that are assignable to SearchSpec:
	//
	//	*Evaluation_EvaluationSpec_SearchRequest
	SearchSpec isEvaluation_EvaluationSpec_SearchSpec `protobuf_oneof:"search_spec"`
	// Required. The specification of the query set.
	QuerySetSpec *Evaluation_EvaluationSpec_QuerySetSpec `protobuf:"bytes,1,opt,name=query_set_spec,json=querySetSpec,proto3" json:"query_set_spec,omitempty"`
	// contains filtered or unexported fields
}

Describes the specification of the evaluation.

func (*Evaluation_EvaluationSpec) Descriptor deprecated added in v1.10.0 

func (*Evaluation_EvaluationSpec) Descriptor() ([]byte, []int)

Deprecated: Use Evaluation_EvaluationSpec.ProtoReflect.Descriptor instead.

func (*Evaluation_EvaluationSpec) GetQuerySetSpec added in v1.10.0 

func (x *Evaluation_EvaluationSpec) GetQuerySetSpec() *Evaluation_EvaluationSpec_QuerySetSpec

func (*Evaluation_EvaluationSpec) GetSearchRequest added in v1.10.0 

func (x *Evaluation_EvaluationSpec) GetSearchRequest() *SearchRequest

func (*Evaluation_EvaluationSpec) GetSearchSpec added in v1.10.0 

func (m *Evaluation_EvaluationSpec) GetSearchSpec() isEvaluation_EvaluationSpec_SearchSpec

func (*Evaluation_EvaluationSpec) ProtoMessage added in v1.10.0 

func (*Evaluation_EvaluationSpec) ProtoMessage()

func (*Evaluation_EvaluationSpec) ProtoReflect added in v1.10.0 

func (x *Evaluation_EvaluationSpec) ProtoReflect() protoreflect.Message

func (*Evaluation_EvaluationSpec) Reset added in v1.10.0 

func (x *Evaluation_EvaluationSpec) Reset()

func (*Evaluation_EvaluationSpec) String added in v1.10.0 

func (x *Evaluation_EvaluationSpec) String() string

type Evaluation_EvaluationSpec_QuerySetSpec added in v1.10.0 

type Evaluation_EvaluationSpec_QuerySetSpec struct {

	// Required. The full resource name of the
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
	// used for the evaluation, in the format of
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	SampleQuerySet string `protobuf:"bytes,1,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
	// contains filtered or unexported fields
}

Describes the specification of the query set.

func (*Evaluation_EvaluationSpec_QuerySetSpec) Descriptor deprecated added in v1.10.0 

func (*Evaluation_EvaluationSpec_QuerySetSpec) Descriptor() ([]byte, []int)

Deprecated: Use Evaluation_EvaluationSpec_QuerySetSpec.ProtoReflect.Descriptor instead.

func (*Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet() string

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage added in v1.10.0 

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage()

func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoReflect added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) ProtoReflect() protoreflect.Message

func (*Evaluation_EvaluationSpec_QuerySetSpec) Reset added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) Reset()

func (*Evaluation_EvaluationSpec_QuerySetSpec) String added in v1.10.0 

func (x *Evaluation_EvaluationSpec_QuerySetSpec) String() string

type Evaluation_EvaluationSpec_SearchRequest added in v1.10.0 

type Evaluation_EvaluationSpec_SearchRequest struct {
	// Required. The search request that is used to perform the evaluation.
	//
	// Only the following fields within SearchRequest are supported; if any
	// other fields are provided, an UNSUPPORTED error will be returned:
	//
	// * [SearchRequest.serving_config][google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config]
	// * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
	// * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
	// * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
	// * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
	// * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
	// * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
	SearchRequest *SearchRequest `protobuf:"bytes,2,opt,name=search_request,json=searchRequest,proto3,oneof"`
}

type Evaluation_State added in v1.10.0 

type Evaluation_State int32

Describes the state of an evaluation. 

const (
	// The evaluation is unspecified.
	Evaluation_STATE_UNSPECIFIED Evaluation_State = 0
	// The service is preparing to run the evaluation.
	Evaluation_PENDING Evaluation_State = 1
	// The evaluation is in progress.
	Evaluation_RUNNING Evaluation_State = 2
	// The evaluation completed successfully.
	Evaluation_SUCCEEDED Evaluation_State = 3
	// The evaluation failed.
	Evaluation_FAILED Evaluation_State = 4
)

func (Evaluation_State) Descriptor added in v1.10.0 

func (Evaluation_State) Descriptor() protoreflect.EnumDescriptor

func (Evaluation_State) Enum added in v1.10.0 

func (x Evaluation_State) Enum() *Evaluation_State

func (Evaluation_State) EnumDescriptor deprecated added in v1.10.0 

func (Evaluation_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Evaluation_State.Descriptor instead.

func (Evaluation_State) Number added in v1.10.0 

func (x Evaluation_State) Number() protoreflect.EnumNumber

func (Evaluation_State) String added in v1.10.0 

func (x Evaluation_State) String() string

func (Evaluation_State) Type added in v1.10.0 

func (Evaluation_State) Type() protoreflect.EnumType

type FactChunk added in v1.7.0 

type FactChunk struct {

	// Text content of the fact chunk. Can be at most 10K characters long.
	ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
	// Source from which this fact chunk was retrieved. If it was retrieved
	// from the GroundingFacts provided in the request then this field will
	// contain the index of the specific fact from which this chunk was
	// retrieved.
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The index of this chunk. Currently, only used for the streaming mode.
	Index int32 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
	// More fine-grained information for the source reference.
	SourceMetadata map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

Fact Chunk.

func (*FactChunk) Descriptor deprecated added in v1.7.0 

func (*FactChunk) Descriptor() ([]byte, []int)

Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.

func (*FactChunk) GetChunkText added in v1.7.0 

func (x *FactChunk) GetChunkText() string

func (*FactChunk) GetIndex added in v1.8.0 

func (x *FactChunk) GetIndex() int32

func (*FactChunk) GetSource added in v1.7.0 

func (x *FactChunk) GetSource() string

func (*FactChunk) GetSourceMetadata added in v1.7.0 

func (x *FactChunk) GetSourceMetadata() map[string]string

func (*FactChunk) ProtoMessage added in v1.7.0 

func (*FactChunk) ProtoMessage()

func (*FactChunk) ProtoReflect added in v1.7.0 

func (x *FactChunk) ProtoReflect() protoreflect.Message

func (*FactChunk) Reset added in v1.7.0 

func (x *FactChunk) Reset()

func (*FactChunk) String added in v1.7.0 

func (x *FactChunk) String() string

type FetchDomainVerificationStatusRequest added in v1.4.0 

type FetchDomainVerificationStatusRequest struct {

	// Required. The site search engine resource under which we fetch all the
	// domain verification status.
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// Requested page size. Server may return fewer items than requested. If
	// unspecified, server will pick an appropriate default. The maximum value is
	// 1000; values above 1000 will be coerced to 1000.
	//
	// If this field is negative, an INVALID_ARGUMENT error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `FetchDomainVerificationStatus`
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `FetchDomainVerificationStatus` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusRequest) Descriptor deprecated added in v1.4.0 

func (*FetchDomainVerificationStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusRequest) GetPageSize added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) GetPageSize() int32

func (*FetchDomainVerificationStatusRequest) GetPageToken added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) GetPageToken() string

func (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() string

func (*FetchDomainVerificationStatusRequest) ProtoMessage added in v1.4.0 

func (*FetchDomainVerificationStatusRequest) ProtoMessage()

func (*FetchDomainVerificationStatusRequest) ProtoReflect added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) ProtoReflect() protoreflect.Message

func (*FetchDomainVerificationStatusRequest) Reset added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) Reset()

func (*FetchDomainVerificationStatusRequest) String added in v1.4.0 

func (x *FetchDomainVerificationStatusRequest) String() string

type FetchDomainVerificationStatusResponse added in v1.4.0 

type FetchDomainVerificationStatusResponse struct {

	// List of TargetSites containing the site verification status.
	TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
	// A token that can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The total number of items matching the request.
	// This will always be populated in the response.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.

func (*FetchDomainVerificationStatusResponse) Descriptor deprecated added in v1.4.0 

func (*FetchDomainVerificationStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.

func (*FetchDomainVerificationStatusResponse) GetNextPageToken added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() string

func (*FetchDomainVerificationStatusResponse) GetTargetSites added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) GetTargetSites() []*TargetSite

func (*FetchDomainVerificationStatusResponse) GetTotalSize added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32

func (*FetchDomainVerificationStatusResponse) ProtoMessage added in v1.4.0 

func (*FetchDomainVerificationStatusResponse) ProtoMessage()

func (*FetchDomainVerificationStatusResponse) ProtoReflect added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) ProtoReflect() protoreflect.Message

func (*FetchDomainVerificationStatusResponse) Reset added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) Reset()

func (*FetchDomainVerificationStatusResponse) String added in v1.4.0 

func (x *FetchDomainVerificationStatusResponse) String() string

type FhirStoreSource added in v1.7.0 

type FhirStoreSource struct {

	// Required. The full resource name of the FHIR store to import data from, in
	// the format of
	// `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
	FhirStore string `protobuf:"bytes,1,opt,name=fhir_store,json=fhirStore,proto3" json:"fhir_store,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// FhirStore export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,2,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The FHIR resource types to import. The resource types should be a subset of
	// all [supported FHIR resource
	// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
	// Default to all supported FHIR resource types if empty.
	ResourceTypes []string `protobuf:"bytes,3,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
	// contains filtered or unexported fields
}

Cloud FhirStore source import data from.

func (*FhirStoreSource) Descriptor deprecated added in v1.7.0 

func (*FhirStoreSource) Descriptor() ([]byte, []int)

Deprecated: Use FhirStoreSource.ProtoReflect.Descriptor instead.

func (*FhirStoreSource) GetFhirStore added in v1.7.0 

func (x *FhirStoreSource) GetFhirStore() string

func (*FhirStoreSource) GetGcsStagingDir added in v1.7.0 

func (x *FhirStoreSource) GetGcsStagingDir() string

func (*FhirStoreSource) GetResourceTypes added in v1.12.0 

func (x *FhirStoreSource) GetResourceTypes() []string

func (*FhirStoreSource) ProtoMessage added in v1.7.0 

func (*FhirStoreSource) ProtoMessage()

func (*FhirStoreSource) ProtoReflect added in v1.7.0 

func (x *FhirStoreSource) ProtoReflect() protoreflect.Message

func (*FhirStoreSource) Reset added in v1.7.0 

func (x *FhirStoreSource) Reset()

func (*FhirStoreSource) String added in v1.7.0 

func (x *FhirStoreSource) String() string

type FieldConfig 

type FieldConfig struct {

	// Required. Field path of the schema field.
	// For example: `title`, `description`, `release_info.release_year`.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
	// Output only. Raw type of the field.
	FieldType FieldConfig_FieldType `` /* 153-byte string literal not displayed */
	// If
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is
	// [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
	// field values are indexed so that it can be filtered or faceted in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
	//
	// If
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is unset, the server behavior defaults to
	// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
	// for fields that support setting indexable options. For those fields that do
	// not support setting indexable options, such as `object` and `boolean` and
	// key properties, the server will skip
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// setting, and setting
	// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	IndexableOption FieldConfig_IndexableOption `` /* 177-byte string literal not displayed */
	// If
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// is
	// [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
	// field values are available for dynamic facet. Could only be
	// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
	// if
	// [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
	// is
	// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
	// Otherwise, an `INVALID_ARGUMENT` error will be returned.
	//
	// If
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// is unset, the server behavior defaults to
	// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
	// for fields that support setting dynamic facetable options. For those fields
	// that do not support setting dynamic facetable options, such as `object` and
	// `boolean`, the server will skip dynamic facetable option setting, and
	// setting
	// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	DynamicFacetableOption FieldConfig_DynamicFacetableOption `` /* 207-byte string literal not displayed */
	// If
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// is
	// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
	// field values are searchable by text queries in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
	//
	// If
	// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
	// but field type is numerical, field values will not be searchable by text
	// queries in
	// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
	// as there are no text values associated to numerical fields.
	//
	// If
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// is unset, the server behavior defaults to
	// [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
	// for fields that support setting searchable options. Only `string` fields
	// that have no key property mapping support setting
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].
	//
	// For those fields that do not support setting searchable options, the server
	// will skip searchable option setting, and setting
	// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	SearchableOption FieldConfig_SearchableOption `` /* 181-byte string literal not displayed */
	// If
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// is
	// [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
	// field values are included in the search results.
	//
	// If
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// is unset, the server behavior defaults to
	// [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
	// for fields that support setting retrievable options. For those fields
	// that do not support setting retrievable options, such as `object` and
	// `boolean`, the server will skip retrievable option setting, and setting
	// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	RetrievableOption FieldConfig_RetrievableOption `` /* 185-byte string literal not displayed */
	// If
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// is
	// [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
	// field values are directly used and returned as suggestions for Autocomplete
	// in
	// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
	//
	// If
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// is unset, the server behavior defaults to
	// [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
	// for fields that support setting completable options, which are just
	// `string` fields. For those fields that do not support setting completable
	// options, the server will skip completable option setting, and setting
	// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
	// for those fields will throw `INVALID_ARGUMENT` error.
	CompletableOption FieldConfig_CompletableOption `` /* 185-byte string literal not displayed */
	// If
	// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
	// is
	// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
	// field values are filterable by filter expression in
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
	//
	// If
	// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
	// but the field type is numerical, field values are not filterable by text
	// queries in
	// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
	// Only textual fields are supported.
	//
	// If
	// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
	// is unset, the default setting is
	// [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
	// for fields that support setting filterable options.
	//
	// When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
	// generated and an empty result is returned.
	RecsFilterableOption FieldConfig_FilterableOption `` /* 195-byte string literal not displayed */
	// Output only. Type of the key property that this field is mapped to. Empty
	// string if this is not annotated as mapped to a key property.
	//
	// Example types are `title`, `description`. Full list is defined
	// by `keyPropertyMapping` in the schema field annotation.
	//
	// If the schema field has a `KeyPropertyMapping` annotation,
	// `indexable_option` and `searchable_option` of this field cannot be
	// modified.
	KeyPropertyType string `protobuf:"bytes,7,opt,name=key_property_type,json=keyPropertyType,proto3" json:"key_property_type,omitempty"`
	// If this field is set, only the corresponding source will be indexed for
	// this field. Otherwise, the values from different sources are merged.
	//
	// Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
	// map:
	//
	//	if this enum is set to METATAGS, we will only index `<author, a>`;
	//	if this enum is not set, we will merge them and index `<author, [a, b]>`.
	AdvancedSiteSearchDataSources []FieldConfig_AdvancedSiteSearchDataSource `` /* 246-byte string literal not displayed */
	// Field paths for indexing custom attribute from schema.org data. More
	// details of schema.org and its defined types can be found at
	// [schema.org](https://schema.org).
	//
	// It is only used on advanced site search schema.
	//
	// Currently only support full path from root. The full path to a field is
	// constructed by concatenating field names, starting from `_root`, with
	// a period `.` as the delimiter. Examples:
	//
	// * Publish date of the root: _root.datePublished
	// * Publish date of the reviews: _root.review.datePublished
	SchemaOrgPaths []string `protobuf:"bytes,11,rep,name=schema_org_paths,json=schemaOrgPaths,proto3" json:"schema_org_paths,omitempty"`
	// contains filtered or unexported fields
}

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

func (*FieldConfig) Descriptor deprecated 

func (*FieldConfig) Descriptor() ([]byte, []int)

Deprecated: Use FieldConfig.ProtoReflect.Descriptor instead.

func (*FieldConfig) GetAdvancedSiteSearchDataSources added in v1.7.0 

func (x *FieldConfig) GetAdvancedSiteSearchDataSources() []FieldConfig_AdvancedSiteSearchDataSource

func (*FieldConfig) GetCompletableOption 

func (x *FieldConfig) GetCompletableOption() FieldConfig_CompletableOption

func (*FieldConfig) GetDynamicFacetableOption 

func (x *FieldConfig) GetDynamicFacetableOption() FieldConfig_DynamicFacetableOption

func (*FieldConfig) GetFieldPath 

func (x *FieldConfig) GetFieldPath() string

func (*FieldConfig) GetFieldType 

func (x *FieldConfig) GetFieldType() FieldConfig_FieldType

func (*FieldConfig) GetIndexableOption 

func (x *FieldConfig) GetIndexableOption() FieldConfig_IndexableOption

func (*FieldConfig) GetKeyPropertyType 

func (x *FieldConfig) GetKeyPropertyType() string

func (*FieldConfig) GetRecsFilterableOption 

func (x *FieldConfig) GetRecsFilterableOption() FieldConfig_FilterableOption

func (*FieldConfig) GetRetrievableOption 

func (x *FieldConfig) GetRetrievableOption() FieldConfig_RetrievableOption

func (*FieldConfig) GetSchemaOrgPaths added in v1.8.0 

func (x *FieldConfig) GetSchemaOrgPaths() []string

func (*FieldConfig) GetSearchableOption 

func (x *FieldConfig) GetSearchableOption() FieldConfig_SearchableOption

func (*FieldConfig) ProtoMessage 

func (*FieldConfig) ProtoMessage()

func (*FieldConfig) ProtoReflect 

func (x *FieldConfig) ProtoReflect() protoreflect.Message

func (*FieldConfig) Reset 

func (x *FieldConfig) Reset()

func (*FieldConfig) String 

func (x *FieldConfig) String() string

type FieldConfig_AdvancedSiteSearchDataSource added in v1.7.0 

type FieldConfig_AdvancedSiteSearchDataSource int32

Optional source of the advanced site search field. 

const (
	// Value used when unset.
	FieldConfig_ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED FieldConfig_AdvancedSiteSearchDataSource = 0
	// Retrieve value from meta tag.
	FieldConfig_METATAGS FieldConfig_AdvancedSiteSearchDataSource = 1
	// Retrieve value from page map.
	FieldConfig_PAGEMAP FieldConfig_AdvancedSiteSearchDataSource = 2
	// Retrieve value from the attributes set by
	// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
	// API.
	FieldConfig_URI_PATTERN_MAPPING FieldConfig_AdvancedSiteSearchDataSource = 3
	// Retrieve value from schema.org data.
	FieldConfig_SCHEMA_ORG FieldConfig_AdvancedSiteSearchDataSource = 4
)

func (FieldConfig_AdvancedSiteSearchDataSource) Descriptor added in v1.7.0 

func (FieldConfig_AdvancedSiteSearchDataSource) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_AdvancedSiteSearchDataSource) Enum added in v1.7.0 

func (x FieldConfig_AdvancedSiteSearchDataSource) Enum() *FieldConfig_AdvancedSiteSearchDataSource

func (FieldConfig_AdvancedSiteSearchDataSource) EnumDescriptor deprecated added in v1.7.0 

func (FieldConfig_AdvancedSiteSearchDataSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_AdvancedSiteSearchDataSource.Descriptor instead.

func (FieldConfig_AdvancedSiteSearchDataSource) Number added in v1.7.0 

func (x FieldConfig_AdvancedSiteSearchDataSource) Number() protoreflect.EnumNumber

func (FieldConfig_AdvancedSiteSearchDataSource) String added in v1.7.0 

func (x FieldConfig_AdvancedSiteSearchDataSource) String() string

func (FieldConfig_AdvancedSiteSearchDataSource) Type added in v1.7.0 

func (FieldConfig_AdvancedSiteSearchDataSource) Type() protoreflect.EnumType

type FieldConfig_CompletableOption 

type FieldConfig_CompletableOption int32

The setting of Completable options in schema. 

const (
	// Value used when unset.
	FieldConfig_COMPLETABLE_OPTION_UNSPECIFIED FieldConfig_CompletableOption = 0
	// Completable option enabled for a schema field.
	FieldConfig_COMPLETABLE_ENABLED FieldConfig_CompletableOption = 1
	// Completable option disabled for a schema field.
	FieldConfig_COMPLETABLE_DISABLED FieldConfig_CompletableOption = 2
)

func (FieldConfig_CompletableOption) Descriptor 

func (FieldConfig_CompletableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_CompletableOption) Enum 

func (x FieldConfig_CompletableOption) Enum() *FieldConfig_CompletableOption

func (FieldConfig_CompletableOption) EnumDescriptor deprecated 

func (FieldConfig_CompletableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_CompletableOption.Descriptor instead.

func (FieldConfig_CompletableOption) Number 

func (x FieldConfig_CompletableOption) Number() protoreflect.EnumNumber

func (FieldConfig_CompletableOption) String 

func (x FieldConfig_CompletableOption) String() string

func (FieldConfig_CompletableOption) Type 

func (FieldConfig_CompletableOption) Type() protoreflect.EnumType

type FieldConfig_DynamicFacetableOption 

type FieldConfig_DynamicFacetableOption int32

The status of the dynamic facetable option of a schema field. 

const (
	// Value used when unset.
	FieldConfig_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED FieldConfig_DynamicFacetableOption = 0
	// Dynamic facetable option enabled for a schema field.
	FieldConfig_DYNAMIC_FACETABLE_ENABLED FieldConfig_DynamicFacetableOption = 1
	// Dynamic facetable option disabled for a schema field.
	FieldConfig_DYNAMIC_FACETABLE_DISABLED FieldConfig_DynamicFacetableOption = 2
)

func (FieldConfig_DynamicFacetableOption) Descriptor 

func (FieldConfig_DynamicFacetableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_DynamicFacetableOption) Enum 

func (x FieldConfig_DynamicFacetableOption) Enum() *FieldConfig_DynamicFacetableOption

func (FieldConfig_DynamicFacetableOption) EnumDescriptor deprecated 

func (FieldConfig_DynamicFacetableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_DynamicFacetableOption.Descriptor instead.

func (FieldConfig_DynamicFacetableOption) Number 

func (x FieldConfig_DynamicFacetableOption) Number() protoreflect.EnumNumber

func (FieldConfig_DynamicFacetableOption) String 

func (x FieldConfig_DynamicFacetableOption) String() string

func (FieldConfig_DynamicFacetableOption) Type 

func (FieldConfig_DynamicFacetableOption) Type() protoreflect.EnumType

type FieldConfig_FieldType 

type FieldConfig_FieldType int32

Field value type in the Schema. 

const (
	// Field type is unspecified.
	FieldConfig_FIELD_TYPE_UNSPECIFIED FieldConfig_FieldType = 0
	// Field value type is Object.
	FieldConfig_OBJECT FieldConfig_FieldType = 1
	// Field value type is String.
	FieldConfig_STRING FieldConfig_FieldType = 2
	// Field value type is Number.
	FieldConfig_NUMBER FieldConfig_FieldType = 3
	// Field value type is Integer.
	FieldConfig_INTEGER FieldConfig_FieldType = 4
	// Field value type is Boolean.
	FieldConfig_BOOLEAN FieldConfig_FieldType = 5
	// Field value type is Geolocation. Geolocation is expressed as an object
	// with the following keys:
	//
	// * `id`: a string representing the location id
	// * `longitude`: a number representing the longitude coordinate of the
	// location
	// * `latitude`: a number repesenting the latitude coordinate of the
	// location
	// * `address`: a string representing the full address of the location
	//
	// `latitude` and `longitude` must always be provided together. At least one
	// of a) `address` or b) `latitude`-`longitude` pair must be provided.
	FieldConfig_GEOLOCATION FieldConfig_FieldType = 6
	// Field value type is Datetime. Datetime can be expressed as either:
	//
	// * a number representing milliseconds-since-the-epoch
	// * a string representing milliseconds-since-the-epoch. e.g.
	// `"1420070400001"`
	// * a string representing the [ISO
	// 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g.
	// `"2015-01-01"` or `"2015-01-01T12:10:30Z"`
	FieldConfig_DATETIME FieldConfig_FieldType = 7
)

func (FieldConfig_FieldType) Descriptor 

func (FieldConfig_FieldType) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_FieldType) Enum 

func (x FieldConfig_FieldType) Enum() *FieldConfig_FieldType

func (FieldConfig_FieldType) EnumDescriptor deprecated 

func (FieldConfig_FieldType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_FieldType.Descriptor instead.

func (FieldConfig_FieldType) Number 

func (x FieldConfig_FieldType) Number() protoreflect.EnumNumber

func (FieldConfig_FieldType) String 

func (x FieldConfig_FieldType) String() string

func (FieldConfig_FieldType) Type 

func (FieldConfig_FieldType) Type() protoreflect.EnumType

type FieldConfig_FilterableOption 

type FieldConfig_FilterableOption int32

Sets the filterable option for schema fields. 

const (
	// Value used when unset.
	FieldConfig_FILTERABLE_OPTION_UNSPECIFIED FieldConfig_FilterableOption = 0
	// Filterable option enabled for a schema field.
	FieldConfig_FILTERABLE_ENABLED FieldConfig_FilterableOption = 1
	// Filterable option disabled for a schema field.
	FieldConfig_FILTERABLE_DISABLED FieldConfig_FilterableOption = 2
)

func (FieldConfig_FilterableOption) Descriptor 

func (FieldConfig_FilterableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_FilterableOption) Enum 

func (x FieldConfig_FilterableOption) Enum() *FieldConfig_FilterableOption

func (FieldConfig_FilterableOption) EnumDescriptor deprecated 

func (FieldConfig_FilterableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_FilterableOption.Descriptor instead.

func (FieldConfig_FilterableOption) Number 

func (x FieldConfig_FilterableOption) Number() protoreflect.EnumNumber

func (FieldConfig_FilterableOption) String 

func (x FieldConfig_FilterableOption) String() string

func (FieldConfig_FilterableOption) Type 

func (FieldConfig_FilterableOption) Type() protoreflect.EnumType

type FieldConfig_IndexableOption 

type FieldConfig_IndexableOption int32

The setting of Indexable options in schema. 

const (
	// Value used when unset.
	FieldConfig_INDEXABLE_OPTION_UNSPECIFIED FieldConfig_IndexableOption = 0
	// Indexable option enabled for a schema field.
	FieldConfig_INDEXABLE_ENABLED FieldConfig_IndexableOption = 1
	// Indexable option disabled for a schema field.
	FieldConfig_INDEXABLE_DISABLED FieldConfig_IndexableOption = 2
)

func (FieldConfig_IndexableOption) Descriptor 

func (FieldConfig_IndexableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_IndexableOption) Enum 

func (x FieldConfig_IndexableOption) Enum() *FieldConfig_IndexableOption

func (FieldConfig_IndexableOption) EnumDescriptor deprecated 

func (FieldConfig_IndexableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_IndexableOption.Descriptor instead.

func (FieldConfig_IndexableOption) Number 

func (x FieldConfig_IndexableOption) Number() protoreflect.EnumNumber

func (FieldConfig_IndexableOption) String 

func (x FieldConfig_IndexableOption) String() string

func (FieldConfig_IndexableOption) Type 

func (FieldConfig_IndexableOption) Type() protoreflect.EnumType

type FieldConfig_RetrievableOption 

type FieldConfig_RetrievableOption int32

The setting of Retrievable options in schema. 

const (
	// Value used when unset.
	FieldConfig_RETRIEVABLE_OPTION_UNSPECIFIED FieldConfig_RetrievableOption = 0
	// Retrievable option enabled for a schema field.
	FieldConfig_RETRIEVABLE_ENABLED FieldConfig_RetrievableOption = 1
	// Retrievable option disabled for a schema field.
	FieldConfig_RETRIEVABLE_DISABLED FieldConfig_RetrievableOption = 2
)

func (FieldConfig_RetrievableOption) Descriptor 

func (FieldConfig_RetrievableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_RetrievableOption) Enum 

func (x FieldConfig_RetrievableOption) Enum() *FieldConfig_RetrievableOption

func (FieldConfig_RetrievableOption) EnumDescriptor deprecated 

func (FieldConfig_RetrievableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_RetrievableOption.Descriptor instead.

func (FieldConfig_RetrievableOption) Number 

func (x FieldConfig_RetrievableOption) Number() protoreflect.EnumNumber

func (FieldConfig_RetrievableOption) String 

func (x FieldConfig_RetrievableOption) String() string

func (FieldConfig_RetrievableOption) Type 

func (FieldConfig_RetrievableOption) Type() protoreflect.EnumType

type FieldConfig_SearchableOption 

type FieldConfig_SearchableOption int32

The setting of Searchable options in schema. 

const (
	// Value used when unset.
	FieldConfig_SEARCHABLE_OPTION_UNSPECIFIED FieldConfig_SearchableOption = 0
	// Searchable option enabled for a schema field.
	FieldConfig_SEARCHABLE_ENABLED FieldConfig_SearchableOption = 1
	// Searchable option disabled for a schema field.
	FieldConfig_SEARCHABLE_DISABLED FieldConfig_SearchableOption = 2
)

func (FieldConfig_SearchableOption) Descriptor 

func (FieldConfig_SearchableOption) Descriptor() protoreflect.EnumDescriptor

func (FieldConfig_SearchableOption) Enum 

func (x FieldConfig_SearchableOption) Enum() *FieldConfig_SearchableOption

func (FieldConfig_SearchableOption) EnumDescriptor deprecated 

func (FieldConfig_SearchableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldConfig_SearchableOption.Descriptor instead.

func (FieldConfig_SearchableOption) Number 

func (x FieldConfig_SearchableOption) Number() protoreflect.EnumNumber

func (FieldConfig_SearchableOption) String 

func (x FieldConfig_SearchableOption) String() string

func (FieldConfig_SearchableOption) Type 

func (FieldConfig_SearchableOption) Type() protoreflect.EnumType

type FileCharacteristics added in v1.21.0 

type FileCharacteristics struct {

	// Output only. Generic map of characteristics.
	Characteristics map[string]string `` /* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

Caracteristics of other file types.

func (*FileCharacteristics) Descriptor deprecated added in v1.21.0 

func (*FileCharacteristics) Descriptor() ([]byte, []int)

Deprecated: Use FileCharacteristics.ProtoReflect.Descriptor instead.

func (*FileCharacteristics) GetCharacteristics added in v1.21.0 

func (x *FileCharacteristics) GetCharacteristics() map[string]string

func (*FileCharacteristics) ProtoMessage added in v1.21.0 

func (*FileCharacteristics) ProtoMessage()

func (*FileCharacteristics) ProtoReflect added in v1.21.0 

func (x *FileCharacteristics) ProtoReflect() protoreflect.Message

func (*FileCharacteristics) Reset added in v1.21.0 

func (x *FileCharacteristics) Reset()

func (*FileCharacteristics) String added in v1.21.0 

func (x *FileCharacteristics) String() string

type FileMetadata added in v1.21.0 

type FileMetadata struct {

	// Output only. The ID of the file.
	FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
	// Output only. The name of the file uploaded.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The content type of the file, see
	// https://www.iana.org/assignments/media-types/media-types.xhtml.
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Output only. The size of the context file in bytes.
	ByteSize int64 `protobuf:"varint,4,opt,name=byte_size,json=byteSize,proto3" json:"byte_size,omitempty"`
	// Optional. The original location of the file. It may be a local file path,
	// or any other URI that allows accessing the file in an external system.
	// There are two scenarios in which this url may be empty:
	// 1. If the file was sent as inline data (e.g. pasted from the clipboard).
	// 2. If the original location is not available.
	//
	// Note that there's no guarantee that the URI will be pointing to a valid
	// or actually existing file. For example, a file might have been uploaded
	// to the session, and then deleted from the original source.
	OriginalUri string `protobuf:"bytes,9,opt,name=original_uri,json=originalUri,proto3" json:"original_uri,omitempty"`
	// Optional. The type of the original source of the file.
	OriginalSourceType FileSource `` /* 172-byte string literal not displayed */
	// Output only. The time the file was uploaded (If this is a file
	// generated by an internal process and then made available to the session,
	// this indicates the moment it happened).
	UploadTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=upload_time,json=uploadTime,proto3" json:"upload_time,omitempty"`
	// Output only. The time the file was added to the session. Note that if a
	// file was added, then modified externally, then added again, the add time
	// will be updated.
	LastAddTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=last_add_time,json=lastAddTime,proto3" json:"last_add_time,omitempty"`
	// Optional. Represents metadata related to the file that can suit particular
	// use cases. The prefix "google." is reserved for the key for use by
	// Google, but other prefixes can be freely used.
	Metadata map[string]string `` /* 158-byte string literal not displayed */
	// Output only. The
	// [AssistantService.DownloadSessionFile][google.cloud.discoveryengine.v1alpha.AssistantService.DownloadSessionFile]
	// URL to download the file. This URL will need the same credentials as
	// [AssistantService.ListSessionFileMetadata][google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata]
	// method and will provide the resource.
	DownloadUri string `protobuf:"bytes,20,opt,name=download_uri,json=downloadUri,proto3" json:"download_uri,omitempty"`
	// Optional. The origin of the file.
	FileOriginType FileOriginType `` /* 164-byte string literal not displayed */
	// Output only. Alternate views of this file object. Each file view is
	// attached to a specific role. Possible example keys:
	//   - "thumbnail"
	//   - "mobile_thumbnail"
	//   - "clip"
	//   - "summary"
	//   - "translation"
	Views map[string]*FileView `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a file attached to a session (context file)

func (*FileMetadata) Descriptor deprecated added in v1.21.0 

func (*FileMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FileMetadata.ProtoReflect.Descriptor instead.

func (*FileMetadata) GetByteSize added in v1.21.0 

func (x *FileMetadata) GetByteSize() int64

func (*FileMetadata) GetDownloadUri added in v1.21.0 

func (x *FileMetadata) GetDownloadUri() string

func (*FileMetadata) GetFileId added in v1.21.0 

func (x *FileMetadata) GetFileId() string

func (*FileMetadata) GetFileOriginType added in v1.21.0 

func (x *FileMetadata) GetFileOriginType() FileOriginType

func (*FileMetadata) GetLastAddTime added in v1.21.0 

func (x *FileMetadata) GetLastAddTime() *timestamppb.Timestamp

func (*FileMetadata) GetMetadata added in v1.21.0 

func (x *FileMetadata) GetMetadata() map[string]string

func (*FileMetadata) GetMimeType added in v1.21.0 

func (x *FileMetadata) GetMimeType() string

func (*FileMetadata) GetName added in v1.21.0 

func (x *FileMetadata) GetName() string

func (*FileMetadata) GetOriginalSourceType added in v1.21.0 

func (x *FileMetadata) GetOriginalSourceType() FileSource

func (*FileMetadata) GetOriginalUri added in v1.21.0 

func (x *FileMetadata) GetOriginalUri() string

func (*FileMetadata) GetUploadTime added in v1.21.0 

func (x *FileMetadata) GetUploadTime() *timestamppb.Timestamp

func (*FileMetadata) GetViews added in v1.21.0 

func (x *FileMetadata) GetViews() map[string]*FileView

func (*FileMetadata) ProtoMessage added in v1.21.0 

func (*FileMetadata) ProtoMessage()

func (*FileMetadata) ProtoReflect added in v1.21.0 

func (x *FileMetadata) ProtoReflect() protoreflect.Message

func (*FileMetadata) Reset added in v1.21.0 

func (x *FileMetadata) Reset()

func (*FileMetadata) String added in v1.21.0 

func (x *FileMetadata) String() string

type FileOriginType added in v1.21.0 

type FileOriginType int32

The origin of the file. 

const (
	// Default value.
	FileOriginType_FILE_ORIGIN_TYPE_UNSPECIFIED FileOriginType = 0
	// The file was provided by the user.
	FileOriginType_USER_PROVIDED FileOriginType = 1
	// The file was generated by an AI model.
	FileOriginType_AI_GENERATED FileOriginType = 2
	// The file was generated from other files by an internal process.
	FileOriginType_INTERNALLY_GENERATED FileOriginType = 3
)

func (FileOriginType) Descriptor added in v1.21.0 

func (FileOriginType) Descriptor() protoreflect.EnumDescriptor

func (FileOriginType) Enum added in v1.21.0 

func (x FileOriginType) Enum() *FileOriginType

func (FileOriginType) EnumDescriptor deprecated added in v1.21.0 

func (FileOriginType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FileOriginType.Descriptor instead.

func (FileOriginType) Number added in v1.21.0 

func (x FileOriginType) Number() protoreflect.EnumNumber

func (FileOriginType) String added in v1.21.0 

func (x FileOriginType) String() string

func (FileOriginType) Type added in v1.21.0 

func (FileOriginType) Type() protoreflect.EnumType

type FileSource added in v1.21.0 

type FileSource int32

Original source of the file. 

const (
	// Default value. Unknown source.
	FileSource_FILE_SOURCE_UNSPECIFIED FileSource = 0
	// The data of the file was provided inline (e.g. pasted from the clipboard).
	FileSource_FILE_SOURCE_INLINE FileSource = 1
	// The file was uploaded from a local file.
	FileSource_FILE_SOURCE_LOCAL FileSource = 2
	// The file was uploaded from Cloud Storage.
	FileSource_FILE_SOURCE_CLOUD_STORAGE FileSource = 3
	// The file was uploaded from Drive.
	FileSource_FILE_SOURCE_CLOUD_DRIVE FileSource = 4
	// The file was retrieved from a URL (e.g. public web).
	FileSource_FILE_SOURCE_URL FileSource = 5
)

func (FileSource) Descriptor added in v1.21.0 

func (FileSource) Descriptor() protoreflect.EnumDescriptor

func (FileSource) Enum added in v1.21.0 

func (x FileSource) Enum() *FileSource

func (FileSource) EnumDescriptor deprecated added in v1.21.0 

func (FileSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use FileSource.Descriptor instead.

func (FileSource) Number added in v1.21.0 

func (x FileSource) Number() protoreflect.EnumNumber

func (FileSource) String added in v1.21.0 

func (x FileSource) String() string

func (FileSource) Type added in v1.21.0 

func (FileSource) Type() protoreflect.EnumType

type FileView added in v1.21.0 

type FileView struct {

	// Characteristics of the media view, allowing for flexible extensions.
	// Metadata is always internally generated by the process creating
	// the view.
	//
	// Types that are assignable to Characteristics:
	//
	//	*FileView_ImageCharacteristics
	//	*FileView_VideoCharacteristics
	//	*FileView_FileCharacteristics
	Characteristics isFileView_Characteristics `protobuf_oneof:"characteristics"`
	// Output only. Globally Unique id for this specific view.
	ViewId string `protobuf:"bytes,1,opt,name=view_id,json=viewId,proto3" json:"view_id,omitempty"`
	// Output only. The URI to access this media view.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Output only. MIME type (e.g., "image/jpeg", "image/png", "text/plain",
	// "video/mp4")
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Output only. The size of the view in bytes.
	ByteSize int64 `protobuf:"varint,4,opt,name=byte_size,json=byteSize,proto3" json:"byte_size,omitempty"`
	// Output only. The time the view was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Represents a specific alternate version or "view" of a file object, such as a summary, a thumbnail, a translated version, etc.

func (*FileView) Descriptor deprecated added in v1.21.0 

func (*FileView) Descriptor() ([]byte, []int)

Deprecated: Use FileView.ProtoReflect.Descriptor instead.

func (*FileView) GetByteSize added in v1.21.0 

func (x *FileView) GetByteSize() int64

func (*FileView) GetCharacteristics added in v1.21.0 

func (m *FileView) GetCharacteristics() isFileView_Characteristics

func (*FileView) GetCreateTime added in v1.21.0 

func (x *FileView) GetCreateTime() *timestamppb.Timestamp

func (*FileView) GetFileCharacteristics added in v1.21.0 

func (x *FileView) GetFileCharacteristics() *FileCharacteristics

func (*FileView) GetImageCharacteristics added in v1.21.0 

func (x *FileView) GetImageCharacteristics() *ImageCharacteristics

func (*FileView) GetMimeType added in v1.21.0 

func (x *FileView) GetMimeType() string

func (*FileView) GetUri added in v1.21.0 

func (x *FileView) GetUri() string

func (*FileView) GetVideoCharacteristics added in v1.21.0 

func (x *FileView) GetVideoCharacteristics() *VideoCharacteristics

func (*FileView) GetViewId added in v1.21.0 

func (x *FileView) GetViewId() string

func (*FileView) ProtoMessage added in v1.21.0 

func (*FileView) ProtoMessage()

func (*FileView) ProtoReflect added in v1.21.0 

func (x *FileView) ProtoReflect() protoreflect.Message

func (*FileView) Reset added in v1.21.0 

func (x *FileView) Reset()

func (*FileView) String added in v1.21.0 

func (x *FileView) String() string

type FileView_FileCharacteristics added in v1.21.0 

type FileView_FileCharacteristics struct {
	// Output only. Characteristics of other file types.
	FileCharacteristics *FileCharacteristics `protobuf:"bytes,8,opt,name=file_characteristics,json=fileCharacteristics,proto3,oneof"`
}

type FileView_ImageCharacteristics added in v1.21.0 

type FileView_ImageCharacteristics struct {
	// Output only. Characteristics of an image media view.
	ImageCharacteristics *ImageCharacteristics `protobuf:"bytes,6,opt,name=image_characteristics,json=imageCharacteristics,proto3,oneof"`
}

type FileView_VideoCharacteristics added in v1.21.0 

type FileView_VideoCharacteristics struct {
	// Output only. Characteristics of a video media view.
	VideoCharacteristics *VideoCharacteristics `protobuf:"bytes,7,opt,name=video_characteristics,json=videoCharacteristics,proto3,oneof"`
}

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.v1alpha.Document] per line. Each
	// document must
	//
	//	have a valid
	//	[Document.id][google.cloud.discoveryengine.v1alpha.Document.id].
	//   - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
	//     `input_uris` becomes a document, with the ID set to the first 128
	//     bits of SHA256(URI) encoded as a hex string.
	//   - `custom`: One custom data JSON per row in arbitrary format that conforms
	//     to the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of
	//     the data store. This can only be used by the GENERIC Data Store vertical.
	//   - `csv`: A CSV file with header conforming to the defined
	//
	// [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
	//
	//	data store. Each entry after the header is imported as a Document.
	//	This can only be used by the GENERIC Data Store vertical.
	//
	// Supported values for user event imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] per line.
	DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

Cloud Storage location for input content.

func (*GcsSource) Descriptor deprecated 

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema 

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris 

func (x *GcsSource) GetInputUris() []string

func (*GcsSource) ProtoMessage 

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect 

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset 

func (x *GcsSource) Reset()

func (*GcsSource) String 

func (x *GcsSource) String() string

type GetAclConfigRequest added in v1.6.0 

type GetAclConfigRequest struct {

	// Required. Resource name of
	// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
	// `projects/*/locations/*/aclConfig`.
	//
	// If the caller does not have permission to access the
	// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetAclConfigRequest method.

func (*GetAclConfigRequest) Descriptor deprecated added in v1.6.0 

func (*GetAclConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAclConfigRequest.ProtoReflect.Descriptor instead.

func (*GetAclConfigRequest) GetName added in v1.6.0 

func (x *GetAclConfigRequest) GetName() string

func (*GetAclConfigRequest) ProtoMessage added in v1.6.0 

func (*GetAclConfigRequest) ProtoMessage()

func (*GetAclConfigRequest) ProtoReflect added in v1.6.0 

func (x *GetAclConfigRequest) ProtoReflect() protoreflect.Message

func (*GetAclConfigRequest) Reset added in v1.6.0 

func (x *GetAclConfigRequest) Reset()

func (*GetAclConfigRequest) String added in v1.6.0 

func (x *GetAclConfigRequest) String() string

type GetAnswerRequest added in v1.7.0 

type GetAnswerRequest struct {

	// Required. The resource name of the Answer to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetAnswer method.

func (*GetAnswerRequest) Descriptor deprecated added in v1.7.0 

func (*GetAnswerRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAnswerRequest.ProtoReflect.Descriptor instead.

func (*GetAnswerRequest) GetName added in v1.7.0 

func (x *GetAnswerRequest) GetName() string

func (*GetAnswerRequest) ProtoMessage added in v1.7.0 

func (*GetAnswerRequest) ProtoMessage()

func (*GetAnswerRequest) ProtoReflect added in v1.7.0 

func (x *GetAnswerRequest) ProtoReflect() protoreflect.Message

func (*GetAnswerRequest) Reset added in v1.7.0 

func (x *GetAnswerRequest) Reset()

func (*GetAnswerRequest) String added in v1.7.0 

func (x *GetAnswerRequest) String() string

type GetChunkRequest added in v1.6.0 

type GetChunkRequest struct {

	// Required. Full resource name of
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.
	//
	// If the caller does not have permission to access the
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether
	// or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does
	// not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] method.

func (*GetChunkRequest) Descriptor deprecated added in v1.6.0 

func (*GetChunkRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetChunkRequest.ProtoReflect.Descriptor instead.

func (*GetChunkRequest) GetName added in v1.6.0 

func (x *GetChunkRequest) GetName() string

func (*GetChunkRequest) ProtoMessage added in v1.6.0 

func (*GetChunkRequest) ProtoMessage()

func (*GetChunkRequest) ProtoReflect added in v1.6.0 

func (x *GetChunkRequest) ProtoReflect() protoreflect.Message

func (*GetChunkRequest) Reset added in v1.6.0 

func (x *GetChunkRequest) Reset()

func (*GetChunkRequest) String added in v1.6.0 

func (x *GetChunkRequest) String() string

type GetControlRequest added in v1.8.0 

type GetControlRequest struct {

	// Required. The resource name of the Control to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetControl method.

func (*GetControlRequest) Descriptor deprecated added in v1.8.0 

func (*GetControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetControlRequest.ProtoReflect.Descriptor instead.

func (*GetControlRequest) GetName added in v1.8.0 

func (x *GetControlRequest) GetName() string

func (*GetControlRequest) ProtoMessage added in v1.8.0 

func (*GetControlRequest) ProtoMessage()

func (*GetControlRequest) ProtoReflect added in v1.8.0 

func (x *GetControlRequest) ProtoReflect() protoreflect.Message

func (*GetControlRequest) Reset added in v1.8.0 

func (x *GetControlRequest) Reset()

func (*GetControlRequest) String added in v1.8.0 

func (x *GetControlRequest) String() string

type GetConversationRequest 

type GetConversationRequest struct {

	// Required. The resource name of the Conversation to get. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetConversation method.

func (*GetConversationRequest) Descriptor deprecated 

func (*GetConversationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.

func (*GetConversationRequest) GetName 

func (x *GetConversationRequest) GetName() string

func (*GetConversationRequest) ProtoMessage 

func (*GetConversationRequest) ProtoMessage()

func (*GetConversationRequest) ProtoReflect 

func (x *GetConversationRequest) ProtoReflect() protoreflect.Message

func (*GetConversationRequest) Reset 

func (x *GetConversationRequest) Reset()

func (*GetConversationRequest) String 

func (x *GetConversationRequest) String() string

type GetDataStoreRequest 

type GetDataStoreRequest struct {

	// Required. Full resource name of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	//
	// If the caller does not have permission to access the
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] does not exist,
	// a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] method.

func (*GetDataStoreRequest) Descriptor deprecated 

func (*GetDataStoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDataStoreRequest.ProtoReflect.Descriptor instead.

func (*GetDataStoreRequest) GetName 

func (x *GetDataStoreRequest) GetName() string

func (*GetDataStoreRequest) ProtoMessage 

func (*GetDataStoreRequest) ProtoMessage()

func (*GetDataStoreRequest) ProtoReflect 

func (x *GetDataStoreRequest) ProtoReflect() protoreflect.Message

func (*GetDataStoreRequest) Reset 

func (x *GetDataStoreRequest) Reset()

func (*GetDataStoreRequest) String 

func (x *GetDataStoreRequest) String() string

type GetDocumentProcessingConfigRequest added in v1.6.0 

type GetDocumentProcessingConfigRequest struct {

	// Required. Full DocumentProcessingConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] method.

func (*GetDocumentProcessingConfigRequest) Descriptor deprecated added in v1.6.0 

func (*GetDocumentProcessingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentProcessingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentProcessingConfigRequest) GetName added in v1.6.0 

func (x *GetDocumentProcessingConfigRequest) GetName() string

func (*GetDocumentProcessingConfigRequest) ProtoMessage added in v1.6.0 

func (*GetDocumentProcessingConfigRequest) ProtoMessage()

func (*GetDocumentProcessingConfigRequest) ProtoReflect added in v1.6.0 

func (x *GetDocumentProcessingConfigRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentProcessingConfigRequest) Reset added in v1.6.0 

func (x *GetDocumentProcessingConfigRequest) Reset()

func (*GetDocumentProcessingConfigRequest) String added in v1.6.0 

func (x *GetDocumentProcessingConfigRequest) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1alpha.Document], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to access the
	// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
	// does not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.

func (*GetDocumentRequest) Descriptor deprecated 

func (*GetDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetName 

func (x *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect 

func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentRequest) Reset 

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (x *GetDocumentRequest) String() string

type GetEngineRequest 

type GetEngineRequest struct {

	// Required. Full resource name of
	// [Engine][google.cloud.discoveryengine.v1alpha.Engine], such as
	// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] method.

func (*GetEngineRequest) Descriptor deprecated 

func (*GetEngineRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEngineRequest.ProtoReflect.Descriptor instead.

func (*GetEngineRequest) GetName 

func (x *GetEngineRequest) GetName() string

func (*GetEngineRequest) ProtoMessage 

func (*GetEngineRequest) ProtoMessage()

func (*GetEngineRequest) ProtoReflect 

func (x *GetEngineRequest) ProtoReflect() protoreflect.Message

func (*GetEngineRequest) Reset 

func (x *GetEngineRequest) Reset()

func (*GetEngineRequest) String 

func (x *GetEngineRequest) String() string

type GetEvaluationRequest added in v1.10.0 

type GetEvaluationRequest struct {

	// Required. Full resource name of
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], such as
	// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// If the caller does not have permission to access the
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] method.

func (*GetEvaluationRequest) Descriptor deprecated added in v1.10.0 

func (*GetEvaluationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEvaluationRequest.ProtoReflect.Descriptor instead.

func (*GetEvaluationRequest) GetName added in v1.10.0 

func (x *GetEvaluationRequest) GetName() string

func (*GetEvaluationRequest) ProtoMessage added in v1.10.0 

func (*GetEvaluationRequest) ProtoMessage()

func (*GetEvaluationRequest) ProtoReflect added in v1.10.0 

func (x *GetEvaluationRequest) ProtoReflect() protoreflect.Message

func (*GetEvaluationRequest) Reset added in v1.10.0 

func (x *GetEvaluationRequest) Reset()

func (*GetEvaluationRequest) String added in v1.10.0 

func (x *GetEvaluationRequest) String() string

type GetProcessedDocumentRequest added in v1.7.0 

type GetProcessedDocumentRequest struct {

	// Required. Full resource name of
	// [Document][google.cloud.discoveryengine.v1alpha.Document], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to access the
	// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
	// whether or not it exists, a `PERMISSION_DENIED` error is returned.
	//
	// If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
	// does not exist, a `NOT_FOUND` error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. What type of processing to return.
	ProcessedDocumentType GetProcessedDocumentRequest_ProcessedDocumentType `` /* 219-byte string literal not displayed */
	// What format output should be.  If unspecified, defaults to JSON.
	ProcessedDocumentFormat GetProcessedDocumentRequest_ProcessedDocumentFormat `` /* 227-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.

func (*GetProcessedDocumentRequest) Descriptor deprecated added in v1.7.0 

func (*GetProcessedDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetProcessedDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetProcessedDocumentRequest) GetName added in v1.7.0 

func (x *GetProcessedDocumentRequest) GetName() string

func (*GetProcessedDocumentRequest) GetProcessedDocumentFormat added in v1.7.0 

func (x *GetProcessedDocumentRequest) GetProcessedDocumentFormat() GetProcessedDocumentRequest_ProcessedDocumentFormat

func (*GetProcessedDocumentRequest) GetProcessedDocumentType added in v1.7.0 

func (x *GetProcessedDocumentRequest) GetProcessedDocumentType() GetProcessedDocumentRequest_ProcessedDocumentType

func (*GetProcessedDocumentRequest) ProtoMessage added in v1.7.0 

func (*GetProcessedDocumentRequest) ProtoMessage()

func (*GetProcessedDocumentRequest) ProtoReflect added in v1.7.0 

func (x *GetProcessedDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetProcessedDocumentRequest) Reset added in v1.7.0 

func (x *GetProcessedDocumentRequest) Reset()

func (*GetProcessedDocumentRequest) String added in v1.7.0 

func (x *GetProcessedDocumentRequest) String() string

type GetProcessedDocumentRequest_ProcessedDocumentFormat added in v1.7.0 

type GetProcessedDocumentRequest_ProcessedDocumentFormat int32

The format of the returned processed document. If unspecified, defaults to JSON. 

const (
	// Default value.
	GetProcessedDocumentRequest_PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED GetProcessedDocumentRequest_ProcessedDocumentFormat = 0
	// Output format is a JSON string representation of processed document.
	GetProcessedDocumentRequest_JSON GetProcessedDocumentRequest_ProcessedDocumentFormat = 1
)

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Descriptor added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Descriptor() protoreflect.EnumDescriptor

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Enum added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) Enum() *GetProcessedDocumentRequest_ProcessedDocumentFormat

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) EnumDescriptor deprecated added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use GetProcessedDocumentRequest_ProcessedDocumentFormat.Descriptor instead.

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Number added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) Number() protoreflect.EnumNumber

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) String added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) String() string

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Type added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Type() protoreflect.EnumType

type GetProcessedDocumentRequest_ProcessedDocumentType added in v1.7.0 

type GetProcessedDocumentRequest_ProcessedDocumentType int32

The type of processing to return in the response. 

const (
	// Default value.
	GetProcessedDocumentRequest_PROCESSED_DOCUMENT_TYPE_UNSPECIFIED GetProcessedDocumentRequest_ProcessedDocumentType = 0
	// Available for all data store parsing configs.
	GetProcessedDocumentRequest_PARSED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 1
	// Only available if ChunkingConfig is enabled on the data store.
	GetProcessedDocumentRequest_CHUNKED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 2
	// Returns the converted Image bytes (as JPEG or PNG) if available.
	GetProcessedDocumentRequest_PNG_CONVERTED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 3
)

func (GetProcessedDocumentRequest_ProcessedDocumentType) Descriptor added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentType) Descriptor() protoreflect.EnumDescriptor

func (GetProcessedDocumentRequest_ProcessedDocumentType) Enum added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentType) Enum() *GetProcessedDocumentRequest_ProcessedDocumentType

func (GetProcessedDocumentRequest_ProcessedDocumentType) EnumDescriptor deprecated added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentType) EnumDescriptor() ([]byte, []int)

Deprecated: Use GetProcessedDocumentRequest_ProcessedDocumentType.Descriptor instead.

func (GetProcessedDocumentRequest_ProcessedDocumentType) Number added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentType) Number() protoreflect.EnumNumber

func (GetProcessedDocumentRequest_ProcessedDocumentType) String added in v1.7.0 

func (x GetProcessedDocumentRequest_ProcessedDocumentType) String() string

func (GetProcessedDocumentRequest_ProcessedDocumentType) Type added in v1.7.0 

func (GetProcessedDocumentRequest_ProcessedDocumentType) Type() protoreflect.EnumType

type GetProjectRequest added in v1.7.0 

type GetProjectRequest struct {

	// Required. Full resource name of a
	// [Project][google.cloud.discoveryengine.v1alpha.Project], such as
	// `projects/{project_id_or_number}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] method.

func (*GetProjectRequest) Descriptor deprecated added in v1.7.0 

func (*GetProjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.

func (*GetProjectRequest) GetName added in v1.7.0 

func (x *GetProjectRequest) GetName() string

func (*GetProjectRequest) ProtoMessage added in v1.7.0 

func (*GetProjectRequest) ProtoMessage()

func (*GetProjectRequest) ProtoReflect added in v1.7.0 

func (x *GetProjectRequest) ProtoReflect() protoreflect.Message

func (*GetProjectRequest) Reset added in v1.7.0 

func (x *GetProjectRequest) Reset()

func (*GetProjectRequest) String added in v1.7.0 

func (x *GetProjectRequest) String() string

type GetSampleQueryRequest added in v1.10.0 

type GetSampleQueryRequest struct {

	// Required. Full resource name of
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
	//
	// If the caller does not have permission to access the
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] method.

func (*GetSampleQueryRequest) Descriptor deprecated added in v1.10.0 

func (*GetSampleQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSampleQueryRequest.ProtoReflect.Descriptor instead.

func (*GetSampleQueryRequest) GetName added in v1.10.0 

func (x *GetSampleQueryRequest) GetName() string

func (*GetSampleQueryRequest) ProtoMessage added in v1.10.0 

func (*GetSampleQueryRequest) ProtoMessage()

func (*GetSampleQueryRequest) ProtoReflect added in v1.10.0 

func (x *GetSampleQueryRequest) ProtoReflect() protoreflect.Message

func (*GetSampleQueryRequest) Reset added in v1.10.0 

func (x *GetSampleQueryRequest) Reset()

func (*GetSampleQueryRequest) String added in v1.10.0 

func (x *GetSampleQueryRequest) String() string

type GetSampleQuerySetRequest added in v1.10.0 

type GetSampleQuerySetRequest struct {

	// Required. Full resource name of
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
	// as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
	//
	// If the caller does not have permission to access the
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
	// regardless of whether or not it exists, a PERMISSION_DENIED error is
	// returned.
	//
	// If the requested
	// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] does
	// not exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] method.

func (*GetSampleQuerySetRequest) Descriptor deprecated added in v1.10.0 

func (*GetSampleQuerySetRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSampleQuerySetRequest.ProtoReflect.Descriptor instead.

func (*GetSampleQuerySetRequest) GetName added in v1.10.0 

func (x *GetSampleQuerySetRequest) GetName() string

func (*GetSampleQuerySetRequest) ProtoMessage added in v1.10.0 

func (*GetSampleQuerySetRequest) ProtoMessage()

func (*GetSampleQuerySetRequest) ProtoReflect added in v1.10.0 

func (x *GetSampleQuerySetRequest) ProtoReflect() protoreflect.Message

func (*GetSampleQuerySetRequest) Reset added in v1.10.0 

func (x *GetSampleQuerySetRequest) Reset()

func (*GetSampleQuerySetRequest) String added in v1.10.0 

func (x *GetSampleQuerySetRequest) String() string

type GetSchemaRequest 

type GetSchemaRequest struct {

	// Required. The full resource name of the schema, in the format of
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] method.

func (*GetSchemaRequest) Descriptor deprecated 

func (*GetSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName 

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) ProtoMessage 

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect 

func (x *GetSchemaRequest) ProtoReflect() protoreflect.Message

func (*GetSchemaRequest) Reset 

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String 

func (x *GetSchemaRequest) String() string

type GetServingConfigRequest added in v1.6.0 

type GetServingConfigRequest struct {

	// Required. The resource name of the ServingConfig to get. Format:
	// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetServingConfig method.

func (*GetServingConfigRequest) Descriptor deprecated added in v1.6.0 

func (*GetServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetServingConfigRequest) GetName added in v1.6.0 

func (x *GetServingConfigRequest) GetName() string

func (*GetServingConfigRequest) ProtoMessage added in v1.6.0 

func (*GetServingConfigRequest) ProtoMessage()

func (*GetServingConfigRequest) ProtoReflect added in v1.6.0 

func (x *GetServingConfigRequest) ProtoReflect() protoreflect.Message

func (*GetServingConfigRequest) Reset added in v1.6.0 

func (x *GetServingConfigRequest) Reset()

func (*GetServingConfigRequest) String added in v1.6.0 

func (x *GetServingConfigRequest) String() string

type GetSessionRequest added in v1.7.0 

type GetSessionRequest struct {

	// Required. The resource name of the Session to get. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, the full session including all answer details
	// will be returned.
	IncludeAnswerDetails bool `protobuf:"varint,2,opt,name=include_answer_details,json=includeAnswerDetails,proto3" json:"include_answer_details,omitempty"`
	// contains filtered or unexported fields
}

Request for GetSession method.

func (*GetSessionRequest) Descriptor deprecated added in v1.7.0 

func (*GetSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.

func (*GetSessionRequest) GetIncludeAnswerDetails added in v1.21.0 

func (x *GetSessionRequest) GetIncludeAnswerDetails() bool

func (*GetSessionRequest) GetName added in v1.7.0 

func (x *GetSessionRequest) GetName() string

func (*GetSessionRequest) ProtoMessage added in v1.7.0 

func (*GetSessionRequest) ProtoMessage()

func (*GetSessionRequest) ProtoReflect added in v1.7.0 

func (x *GetSessionRequest) ProtoReflect() protoreflect.Message

func (*GetSessionRequest) Reset added in v1.7.0 

func (x *GetSessionRequest) Reset()

func (*GetSessionRequest) String added in v1.7.0 

func (x *GetSessionRequest) String() string

type GetSiteSearchEngineRequest added in v1.4.0 

type GetSiteSearchEngineRequest struct {

	// Required. Resource name of
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
	//
	// If the caller does not have permission to access the [SiteSearchEngine],
	// regardless of whether or not it exists, a PERMISSION_DENIED error is
	// returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] method.

func (*GetSiteSearchEngineRequest) Descriptor deprecated added in v1.4.0 

func (*GetSiteSearchEngineRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSiteSearchEngineRequest.ProtoReflect.Descriptor instead.

func (*GetSiteSearchEngineRequest) GetName added in v1.4.0 

func (x *GetSiteSearchEngineRequest) GetName() string

func (*GetSiteSearchEngineRequest) ProtoMessage added in v1.4.0 

func (*GetSiteSearchEngineRequest) ProtoMessage()

func (*GetSiteSearchEngineRequest) ProtoReflect added in v1.4.0 

func (x *GetSiteSearchEngineRequest) ProtoReflect() protoreflect.Message

func (*GetSiteSearchEngineRequest) Reset added in v1.4.0 

func (x *GetSiteSearchEngineRequest) Reset()

func (*GetSiteSearchEngineRequest) String added in v1.4.0 

func (x *GetSiteSearchEngineRequest) String() string

type GetTargetSiteRequest added in v1.4.0 

type GetTargetSiteRequest struct {

	// Required. Full resource name of
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
	//
	// If the caller does not have permission to access the
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
	// of whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested
	// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] method.

func (*GetTargetSiteRequest) Descriptor deprecated added in v1.4.0 

func (*GetTargetSiteRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTargetSiteRequest.ProtoReflect.Descriptor instead.

func (*GetTargetSiteRequest) GetName added in v1.4.0 

func (x *GetTargetSiteRequest) GetName() string

func (*GetTargetSiteRequest) ProtoMessage added in v1.4.0 

func (*GetTargetSiteRequest) ProtoMessage()

func (*GetTargetSiteRequest) ProtoReflect added in v1.4.0 

func (x *GetTargetSiteRequest) ProtoReflect() protoreflect.Message

func (*GetTargetSiteRequest) Reset added in v1.4.0 

func (x *GetTargetSiteRequest) Reset()

func (*GetTargetSiteRequest) String added in v1.4.0 

func (x *GetTargetSiteRequest) String() string

type GetUriPatternDocumentDataRequest added in v1.12.0 

type GetUriPatternDocumentDataRequest struct {

	// Required. Full resource name of the
	// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
	// such as
	// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
	SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] method.

func (*GetUriPatternDocumentDataRequest) Descriptor deprecated added in v1.12.0 

func (*GetUriPatternDocumentDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetUriPatternDocumentDataRequest.ProtoReflect.Descriptor instead.

func (*GetUriPatternDocumentDataRequest) GetSiteSearchEngine added in v1.12.0 

func (x *GetUriPatternDocumentDataRequest) GetSiteSearchEngine() string

func (*GetUriPatternDocumentDataRequest) ProtoMessage added in v1.12.0 

func (*GetUriPatternDocumentDataRequest) ProtoMessage()

func (*GetUriPatternDocumentDataRequest) ProtoReflect added in v1.12.0 

func (x *GetUriPatternDocumentDataRequest) ProtoReflect() protoreflect.Message

func (*GetUriPatternDocumentDataRequest) Reset added in v1.12.0 

func (x *GetUriPatternDocumentDataRequest) Reset()

func (*GetUriPatternDocumentDataRequest) String added in v1.12.0 

func (x *GetUriPatternDocumentDataRequest) String() string

type GetUriPatternDocumentDataResponse added in v1.12.0 

type GetUriPatternDocumentDataResponse struct {

	// Document data keyed by URI pattern. For example:
	//
	//	document_data_map = {
	//	  "www.url1.com/*": {
	//	    "Categories": ["category1", "category2"]
	//	  },
	//	  "www.url2.com/*": {
	//	    "Categories": ["category3"]
	//	  }
	//	}
	DocumentDataMap map[string]*structpb.Struct `` /* 196-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] method.

func (*GetUriPatternDocumentDataResponse) Descriptor deprecated added in v1.12.0 

func (*GetUriPatternDocumentDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetUriPatternDocumentDataResponse.ProtoReflect.Descriptor instead.

func (*GetUriPatternDocumentDataResponse) GetDocumentDataMap added in v1.12.0 

func (x *GetUriPatternDocumentDataResponse) GetDocumentDataMap() map[string]*structpb.Struct

func (*GetUriPatternDocumentDataResponse) ProtoMessage added in v1.12.0 

func (*GetUriPatternDocumentDataResponse) ProtoMessage()

func (*GetUriPatternDocumentDataResponse) ProtoReflect added in v1.12.0 

func (x *GetUriPatternDocumentDataResponse) ProtoReflect() protoreflect.Message

func (*GetUriPatternDocumentDataResponse) Reset added in v1.12.0 

func (x *GetUriPatternDocumentDataResponse) Reset()

func (*GetUriPatternDocumentDataResponse) String added in v1.12.0 

func (x *GetUriPatternDocumentDataResponse) String() string

type GroundedGenerationServiceClient added in v1.7.0 

type GroundedGenerationServiceClient interface {
	// Performs a grounding check.
	CheckGrounding(ctx context.Context, in *CheckGroundingRequest, opts ...grpc.CallOption) (*CheckGroundingResponse, error)
}

GroundedGenerationServiceClient is the client API for GroundedGenerationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewGroundedGenerationServiceClient added in v1.7.0 

func NewGroundedGenerationServiceClient(cc grpc.ClientConnInterface) GroundedGenerationServiceClient

type GroundedGenerationServiceServer added in v1.7.0 

type GroundedGenerationServiceServer interface {
	// Performs a grounding check.
	CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
}

GroundedGenerationServiceServer is the server API for GroundedGenerationService service. All implementations should embed UnimplementedGroundedGenerationServiceServer for forward compatibility

type GroundingFact added in v1.7.0 

type GroundingFact struct {

	// Text content of the fact. Can be at most 10K characters long.
	FactText string `protobuf:"bytes,1,opt,name=fact_text,json=factText,proto3" json:"fact_text,omitempty"`
	// Attributes associated with the fact.
	// Common attributes include `source` (indicating where the fact was sourced
	// from), `author` (indicating the author of the fact), and so on.
	Attributes map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Grounding Fact.

func (*GroundingFact) Descriptor deprecated added in v1.7.0 

func (*GroundingFact) Descriptor() ([]byte, []int)

Deprecated: Use GroundingFact.ProtoReflect.Descriptor instead.

func (*GroundingFact) GetAttributes added in v1.7.0 

func (x *GroundingFact) GetAttributes() map[string]string

func (*GroundingFact) GetFactText added in v1.7.0 

func (x *GroundingFact) GetFactText() string

func (*GroundingFact) ProtoMessage added in v1.7.0 

func (*GroundingFact) ProtoMessage()

func (*GroundingFact) ProtoReflect added in v1.7.0 

func (x *GroundingFact) ProtoReflect() protoreflect.Message

func (*GroundingFact) Reset added in v1.7.0 

func (x *GroundingFact) Reset()

func (*GroundingFact) String added in v1.7.0 

func (x *GroundingFact) String() string

type GuidedSearchSpec added in v1.6.0 

type GuidedSearchSpec struct {

	// Whether or not to enable and include refinement attributes in gudied search
	// result.
	EnableRefinementAttributes bool `` /* 142-byte string literal not displayed */
	// Whether or not to enable and include related questions in search response.
	EnableRelatedQuestions bool `` /* 130-byte string literal not displayed */
	// Max number of related questions to be returned. The valid range is [1, 5].
	// If enable_related_questions is true, the default value is 3.
	MaxRelatedQuestions int32 `protobuf:"varint,3,opt,name=max_related_questions,json=maxRelatedQuestions,proto3" json:"max_related_questions,omitempty"`
	// contains filtered or unexported fields
}

Defines guided search spec.

func (*GuidedSearchSpec) Descriptor deprecated added in v1.6.0 

func (*GuidedSearchSpec) Descriptor() ([]byte, []int)

Deprecated: Use GuidedSearchSpec.ProtoReflect.Descriptor instead.

func (*GuidedSearchSpec) GetEnableRefinementAttributes added in v1.6.0 

func (x *GuidedSearchSpec) GetEnableRefinementAttributes() bool

func (*GuidedSearchSpec) GetEnableRelatedQuestions added in v1.6.0 

func (x *GuidedSearchSpec) GetEnableRelatedQuestions() bool

func (*GuidedSearchSpec) GetMaxRelatedQuestions added in v1.6.0 

func (x *GuidedSearchSpec) GetMaxRelatedQuestions() int32

func (*GuidedSearchSpec) ProtoMessage added in v1.6.0 

func (*GuidedSearchSpec) ProtoMessage()

func (*GuidedSearchSpec) ProtoReflect added in v1.6.0 

func (x *GuidedSearchSpec) ProtoReflect() protoreflect.Message

func (*GuidedSearchSpec) Reset added in v1.6.0 

func (x *GuidedSearchSpec) Reset()

func (*GuidedSearchSpec) String added in v1.6.0 

func (x *GuidedSearchSpec) String() string

type IdpConfig added in v1.6.0 

type IdpConfig struct {

	// Identity provider type configured.
	IdpType IdpConfig_IdpType `` /* 143-byte string literal not displayed */
	// External Identity provider config.
	ExternalIdpConfig *IdpConfig_ExternalIdpConfig `protobuf:"bytes,2,opt,name=external_idp_config,json=externalIdpConfig,proto3" json:"external_idp_config,omitempty"`
	// contains filtered or unexported fields
}

Identity Provider Config.

func (*IdpConfig) Descriptor deprecated added in v1.6.0 

func (*IdpConfig) Descriptor() ([]byte, []int)

Deprecated: Use IdpConfig.ProtoReflect.Descriptor instead.

func (*IdpConfig) GetExternalIdpConfig added in v1.6.0 

func (x *IdpConfig) GetExternalIdpConfig() *IdpConfig_ExternalIdpConfig

func (*IdpConfig) GetIdpType added in v1.6.0 

func (x *IdpConfig) GetIdpType() IdpConfig_IdpType

func (*IdpConfig) ProtoMessage added in v1.6.0 

func (*IdpConfig) ProtoMessage()

func (*IdpConfig) ProtoReflect added in v1.6.0 

func (x *IdpConfig) ProtoReflect() protoreflect.Message

func (*IdpConfig) Reset added in v1.6.0 

func (x *IdpConfig) Reset()

func (*IdpConfig) String added in v1.6.0 

func (x *IdpConfig) String() string

type IdpConfig_ExternalIdpConfig added in v1.6.0 

type IdpConfig_ExternalIdpConfig struct {

	// Workforce pool name.
	// Example: "locations/global/workforcePools/pool_id"
	WorkforcePoolName string `protobuf:"bytes,1,opt,name=workforce_pool_name,json=workforcePoolName,proto3" json:"workforce_pool_name,omitempty"`
	// contains filtered or unexported fields
}

Third party IDP Config.

func (*IdpConfig_ExternalIdpConfig) Descriptor deprecated added in v1.6.0 

func (*IdpConfig_ExternalIdpConfig) Descriptor() ([]byte, []int)

Deprecated: Use IdpConfig_ExternalIdpConfig.ProtoReflect.Descriptor instead.

func (*IdpConfig_ExternalIdpConfig) GetWorkforcePoolName added in v1.6.0 

func (x *IdpConfig_ExternalIdpConfig) GetWorkforcePoolName() string

func (*IdpConfig_ExternalIdpConfig) ProtoMessage added in v1.6.0 

func (*IdpConfig_ExternalIdpConfig) ProtoMessage()

func (*IdpConfig_ExternalIdpConfig) ProtoReflect added in v1.6.0 

func (x *IdpConfig_ExternalIdpConfig) ProtoReflect() protoreflect.Message

func (*IdpConfig_ExternalIdpConfig) Reset added in v1.6.0 

func (x *IdpConfig_ExternalIdpConfig) Reset()

func (*IdpConfig_ExternalIdpConfig) String added in v1.6.0 

func (x *IdpConfig_ExternalIdpConfig) String() string

type IdpConfig_IdpType added in v1.6.0 

type IdpConfig_IdpType int32

Identity Provider Type. 

const (
	// Default value. ACL search not enabled.
	IdpConfig_IDP_TYPE_UNSPECIFIED IdpConfig_IdpType = 0
	// Google 1P provider.
	IdpConfig_GSUITE IdpConfig_IdpType = 1
	// Third party provider.
	IdpConfig_THIRD_PARTY IdpConfig_IdpType = 2
)

func (IdpConfig_IdpType) Descriptor added in v1.6.0 

func (IdpConfig_IdpType) Descriptor() protoreflect.EnumDescriptor

func (IdpConfig_IdpType) Enum added in v1.6.0 

func (x IdpConfig_IdpType) Enum() *IdpConfig_IdpType

func (IdpConfig_IdpType) EnumDescriptor deprecated added in v1.6.0 

func (IdpConfig_IdpType) EnumDescriptor() ([]byte, []int)

Deprecated: Use IdpConfig_IdpType.Descriptor instead.

func (IdpConfig_IdpType) Number added in v1.6.0 

func (x IdpConfig_IdpType) Number() protoreflect.EnumNumber

func (IdpConfig_IdpType) String added in v1.6.0 

func (x IdpConfig_IdpType) String() string

func (IdpConfig_IdpType) Type added in v1.6.0 

func (IdpConfig_IdpType) Type() protoreflect.EnumType

type ImageCharacteristics added in v1.21.0 

type ImageCharacteristics struct {

	// Output only. Image width in pixels.
	Width int32 `protobuf:"varint,1,opt,name=width,proto3" json:"width,omitempty"`
	// Output only. Image height in pixels.
	Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
	// Output only. Color space of the image (e.g., "RGB", "CMYK", "Grayscale").
	ColorSpace ImageCharacteristics_ColorSpace `` /* 166-byte string literal not displayed */
	// Output only. Bit depth of the image (e.g., 8-bit, 16-bit).
	BitDepth int32 `protobuf:"varint,4,opt,name=bit_depth,json=bitDepth,proto3" json:"bit_depth,omitempty"`
	// contains filtered or unexported fields
}

Standard characteristics of an image media view.

func (*ImageCharacteristics) Descriptor deprecated added in v1.21.0 

func (*ImageCharacteristics) Descriptor() ([]byte, []int)

Deprecated: Use ImageCharacteristics.ProtoReflect.Descriptor instead.

func (*ImageCharacteristics) GetBitDepth added in v1.21.0 

func (x *ImageCharacteristics) GetBitDepth() int32

func (*ImageCharacteristics) GetColorSpace added in v1.21.0 

func (x *ImageCharacteristics) GetColorSpace() ImageCharacteristics_ColorSpace

func (*ImageCharacteristics) GetHeight added in v1.21.0 

func (x *ImageCharacteristics) GetHeight() int32

func (*ImageCharacteristics) GetWidth added in v1.21.0 

func (x *ImageCharacteristics) GetWidth() int32

func (*ImageCharacteristics) ProtoMessage added in v1.21.0 

func (*ImageCharacteristics) ProtoMessage()

func (*ImageCharacteristics) ProtoReflect added in v1.21.0 

func (x *ImageCharacteristics) ProtoReflect() protoreflect.Message

func (*ImageCharacteristics) Reset added in v1.21.0 

func (x *ImageCharacteristics) Reset()

func (*ImageCharacteristics) String added in v1.21.0 

func (x *ImageCharacteristics) String() string

type ImageCharacteristics_ColorSpace added in v1.21.0 

type ImageCharacteristics_ColorSpace int32

Possible color spaces of an image (e.g., "RGB", "CMYK", "Grayscale"). 

const (
	// Default value. Unknown color space.
	ImageCharacteristics_COLOR_SPACE_UNSPECIFIED ImageCharacteristics_ColorSpace = 0
	// Red, green, blue colorspace.
	ImageCharacteristics_RGB ImageCharacteristics_ColorSpace = 1
	// Cyan, magenta, yellow, and black colorspace.
	ImageCharacteristics_CMYK ImageCharacteristics_ColorSpace = 2
	// Grayscale colorspace.
	ImageCharacteristics_GRAYSCALE ImageCharacteristics_ColorSpace = 3
	// YUV colorspace.
	ImageCharacteristics_YUV ImageCharacteristics_ColorSpace = 4
	// Other colorspace.
	ImageCharacteristics_OTHER_COLOR_SPACE ImageCharacteristics_ColorSpace = 5
)

func (ImageCharacteristics_ColorSpace) Descriptor added in v1.21.0 

func (ImageCharacteristics_ColorSpace) Descriptor() protoreflect.EnumDescriptor

func (ImageCharacteristics_ColorSpace) Enum added in v1.21.0 

func (x ImageCharacteristics_ColorSpace) Enum() *ImageCharacteristics_ColorSpace

func (ImageCharacteristics_ColorSpace) EnumDescriptor deprecated added in v1.21.0 

func (ImageCharacteristics_ColorSpace) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageCharacteristics_ColorSpace.Descriptor instead.

func (ImageCharacteristics_ColorSpace) Number added in v1.21.0 

func (x ImageCharacteristics_ColorSpace) Number() protoreflect.EnumNumber

func (ImageCharacteristics_ColorSpace) String added in v1.21.0 

func (x ImageCharacteristics_ColorSpace) String() string

func (ImageCharacteristics_ColorSpace) Type added in v1.21.0 

func (ImageCharacteristics_ColorSpace) Type() protoreflect.EnumType

type ImportCompletionSuggestionsMetadata added in v1.12.0 

type ImportCompletionSuggestionsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of
	// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
	// successfully imported.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of
	// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
	// that failed to be imported.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportCompletionSuggestionsMetadata) Descriptor deprecated added in v1.12.0 

func (*ImportCompletionSuggestionsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsMetadata) GetCreateTime added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportCompletionSuggestionsMetadata) GetFailureCount added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) GetFailureCount() int64

func (*ImportCompletionSuggestionsMetadata) GetSuccessCount added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) GetSuccessCount() int64

func (*ImportCompletionSuggestionsMetadata) GetUpdateTime added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportCompletionSuggestionsMetadata) ProtoMessage added in v1.12.0 

func (*ImportCompletionSuggestionsMetadata) ProtoMessage()

func (*ImportCompletionSuggestionsMetadata) ProtoReflect added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) ProtoReflect() protoreflect.Message

func (*ImportCompletionSuggestionsMetadata) Reset added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) Reset()

func (*ImportCompletionSuggestionsMetadata) String added in v1.12.0 

func (x *ImportCompletionSuggestionsMetadata) String() string

type ImportCompletionSuggestionsRequest added in v1.12.0 

type ImportCompletionSuggestionsRequest struct {

	// The source of the autocomplete suggestions.
	//
	// Types that are assignable to Source:
	//
	//	*ImportCompletionSuggestionsRequest_InlineSource_
	//	*ImportCompletionSuggestionsRequest_GcsSource
	//	*ImportCompletionSuggestionsRequest_BigquerySource
	Source isImportCompletionSuggestionsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent data store resource name for which to import customer
	// autocomplete suggestions.
	//
	// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] method.

func (*ImportCompletionSuggestionsRequest) Descriptor deprecated added in v1.12.0 

func (*ImportCompletionSuggestionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest) GetBigquerySource added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) GetBigquerySource() *BigQuerySource

func (*ImportCompletionSuggestionsRequest) GetErrorConfig added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportCompletionSuggestionsRequest) GetGcsSource added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) GetGcsSource() *GcsSource

func (*ImportCompletionSuggestionsRequest) GetInlineSource added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) GetInlineSource() *ImportCompletionSuggestionsRequest_InlineSource

func (*ImportCompletionSuggestionsRequest) GetParent added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) GetParent() string

func (*ImportCompletionSuggestionsRequest) GetSource added in v1.12.0 

func (m *ImportCompletionSuggestionsRequest) GetSource() isImportCompletionSuggestionsRequest_Source

func (*ImportCompletionSuggestionsRequest) ProtoMessage added in v1.12.0 

func (*ImportCompletionSuggestionsRequest) ProtoMessage()

func (*ImportCompletionSuggestionsRequest) ProtoReflect added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) ProtoReflect() protoreflect.Message

func (*ImportCompletionSuggestionsRequest) Reset added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) Reset()

func (*ImportCompletionSuggestionsRequest) String added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest) String() string

type ImportCompletionSuggestionsRequest_BigquerySource added in v1.12.0 

type ImportCompletionSuggestionsRequest_BigquerySource struct {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportCompletionSuggestionsRequest_GcsSource added in v1.12.0 

type ImportCompletionSuggestionsRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportCompletionSuggestionsRequest_InlineSource added in v1.12.0 

type ImportCompletionSuggestionsRequest_InlineSource struct {

	// Required. A list of all denylist entries to import. Max of 1000 items.
	Suggestions []*CompletionSuggestion `protobuf:"bytes,1,rep,name=suggestions,proto3" json:"suggestions,omitempty"`
	// contains filtered or unexported fields
}

The inline source for CompletionSuggestions.

func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor deprecated added in v1.12.0 

func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionSuggestionsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions() []*CompletionSuggestion

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage added in v1.12.0 

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage()

func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportCompletionSuggestionsRequest_InlineSource) Reset added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) Reset()

func (*ImportCompletionSuggestionsRequest_InlineSource) String added in v1.12.0 

func (x *ImportCompletionSuggestionsRequest_InlineSource) String() string

type ImportCompletionSuggestionsRequest_InlineSource_ added in v1.12.0 

type ImportCompletionSuggestionsRequest_InlineSource_ struct {
	// The Inline source for suggestion entries.
	InlineSource *ImportCompletionSuggestionsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportCompletionSuggestionsResponse added in v1.12.0 

type ImportCompletionSuggestionsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

func (*ImportCompletionSuggestionsResponse) Descriptor deprecated added in v1.12.0 

func (*ImportCompletionSuggestionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.

func (*ImportCompletionSuggestionsResponse) GetErrorConfig added in v1.12.0 

func (x *ImportCompletionSuggestionsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportCompletionSuggestionsResponse) GetErrorSamples added in v1.12.0 

func (x *ImportCompletionSuggestionsResponse) GetErrorSamples() []*status.Status

func (*ImportCompletionSuggestionsResponse) ProtoMessage added in v1.12.0 

func (*ImportCompletionSuggestionsResponse) ProtoMessage()

func (*ImportCompletionSuggestionsResponse) ProtoReflect added in v1.12.0 

func (x *ImportCompletionSuggestionsResponse) ProtoReflect() protoreflect.Message

func (*ImportCompletionSuggestionsResponse) Reset added in v1.12.0 

func (x *ImportCompletionSuggestionsResponse) Reset()

func (*ImportCompletionSuggestionsResponse) String added in v1.12.0 

func (x *ImportCompletionSuggestionsResponse) String() string

type ImportDocumentsMetadata 

type ImportDocumentsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Total count of entries that were processed.
	TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ImportDocumentsMetadata) Descriptor deprecated 

func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata) GetCreateTime 

func (x *ImportDocumentsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) GetFailureCount 

func (x *ImportDocumentsMetadata) GetFailureCount() int64

func (*ImportDocumentsMetadata) GetSuccessCount 

func (x *ImportDocumentsMetadata) GetSuccessCount() int64

func (*ImportDocumentsMetadata) GetTotalCount added in v1.7.0 

func (x *ImportDocumentsMetadata) GetTotalCount() int64

func (*ImportDocumentsMetadata) GetUpdateTime 

func (x *ImportDocumentsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) ProtoMessage 

func (*ImportDocumentsMetadata) ProtoMessage()

func (*ImportDocumentsMetadata) ProtoReflect 

func (x *ImportDocumentsMetadata) ProtoReflect() protoreflect.Message

func (*ImportDocumentsMetadata) Reset 

func (x *ImportDocumentsMetadata) Reset()

func (*ImportDocumentsMetadata) String 

func (x *ImportDocumentsMetadata) String() string

type ImportDocumentsRequest 

type ImportDocumentsRequest struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*ImportDocumentsRequest_InlineSource_
	//	*ImportDocumentsRequest_GcsSource
	//	*ImportDocumentsRequest_BigquerySource
	//	*ImportDocumentsRequest_FhirStoreSource
	//	*ImportDocumentsRequest_SpannerSource
	//	*ImportDocumentsRequest_CloudSqlSource
	//	*ImportDocumentsRequest_FirestoreSource
	//	*ImportDocumentsRequest_AlloyDbSource
	//	*ImportDocumentsRequest_BigtableSource
	Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Requires create/update permission.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// The mode of reconciliation between existing documents and the documents to
	// be imported. Defaults to
	// [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
	ReconciliationMode ImportDocumentsRequest_ReconciliationMode `` /* 200-byte string literal not displayed */
	// Indicates which fields in the provided imported documents to update. If
	// not set, the default is to update all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Whether to automatically generate IDs for the documents if absent.
	//
	// If set to `true`,
	// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s are
	// automatically generated based on the hash of the payload, where IDs may not
	// be consistent during multiple imports. In which case
	// [ReconciliationMode.FULL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL]
	// is highly recommended to avoid duplicate contents. If unset or set to
	// `false`, [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s
	// have to be specified using
	// [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field],
	// otherwise, documents without IDs fail to be imported.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
	AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
	// The field indicates the ID field or column to be used as unique IDs of
	// the documents.
	//
	// For [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] it is the
	// key of the JSON field. For instance, `my_id` for JSON `{"my_id":
	// "some_uuid"}`. For others, it may be the column name of the table where the
	// unique ids are stored.
	//
	// The values of the JSON field or the table column are used as the
	// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s. The JSON
	// field or the table column must be of string type, and the values must be
	// set as valid strings conform to
	// [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
	// Otherwise, documents without valid IDs fail to be imported.
	//
	// Only set this field when
	// [auto_generate_ids][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids]
	// is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
	//
	// If it is unset, a default value `_id` is used when importing from the
	// allowed data sources.
	//
	// Supported data sources:
	//
	// * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
	// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
	// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
	// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
	// * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
	// * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
	// * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
	// * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
	IdField string `protobuf:"bytes,9,opt,name=id_field,json=idField,proto3" json:"id_field,omitempty"`
	// contains filtered or unexported fields
}

Request message for Import methods.

func (*ImportDocumentsRequest) Descriptor deprecated 

func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetAlloyDbSource added in v1.12.0 

func (x *ImportDocumentsRequest) GetAlloyDbSource() *AlloyDbSource

func (*ImportDocumentsRequest) GetAutoGenerateIds 

func (x *ImportDocumentsRequest) GetAutoGenerateIds() bool

func (*ImportDocumentsRequest) GetBigquerySource 

func (x *ImportDocumentsRequest) GetBigquerySource() *BigQuerySource

func (*ImportDocumentsRequest) GetBigtableSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetBigtableSource() *BigtableSource

func (*ImportDocumentsRequest) GetCloudSqlSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetCloudSqlSource() *CloudSqlSource

func (*ImportDocumentsRequest) GetErrorConfig 

func (x *ImportDocumentsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsRequest) GetFhirStoreSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetFhirStoreSource() *FhirStoreSource

func (*ImportDocumentsRequest) GetFirestoreSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetFirestoreSource() *FirestoreSource

func (*ImportDocumentsRequest) GetGcsSource 

func (x *ImportDocumentsRequest) GetGcsSource() *GcsSource

func (*ImportDocumentsRequest) GetIdField 

func (x *ImportDocumentsRequest) GetIdField() string

func (*ImportDocumentsRequest) GetInlineSource 

func (x *ImportDocumentsRequest) GetInlineSource() *ImportDocumentsRequest_InlineSource

func (*ImportDocumentsRequest) GetParent 

func (x *ImportDocumentsRequest) GetParent() string

func (*ImportDocumentsRequest) GetReconciliationMode 

func (x *ImportDocumentsRequest) GetReconciliationMode() ImportDocumentsRequest_ReconciliationMode

func (*ImportDocumentsRequest) GetSource 

func (m *ImportDocumentsRequest) GetSource() isImportDocumentsRequest_Source

func (*ImportDocumentsRequest) GetSpannerSource added in v1.7.0 

func (x *ImportDocumentsRequest) GetSpannerSource() *SpannerSource

func (*ImportDocumentsRequest) GetUpdateMask added in v1.7.0 

func (x *ImportDocumentsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*ImportDocumentsRequest) ProtoMessage 

func (*ImportDocumentsRequest) ProtoMessage()

func (*ImportDocumentsRequest) ProtoReflect 

func (x *ImportDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ImportDocumentsRequest) Reset 

func (x *ImportDocumentsRequest) Reset()

func (*ImportDocumentsRequest) String 

func (x *ImportDocumentsRequest) String() string

type ImportDocumentsRequest_AlloyDbSource added in v1.12.0 

type ImportDocumentsRequest_AlloyDbSource struct {
	// AlloyDB input source.
	AlloyDbSource *AlloyDbSource `protobuf:"bytes,14,opt,name=alloy_db_source,json=alloyDbSource,proto3,oneof"`
}

type ImportDocumentsRequest_BigquerySource 

type ImportDocumentsRequest_BigquerySource struct {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportDocumentsRequest_BigtableSource added in v1.7.0 

type ImportDocumentsRequest_BigtableSource struct {
	// Cloud Bigtable input source.
	BigtableSource *BigtableSource `protobuf:"bytes,15,opt,name=bigtable_source,json=bigtableSource,proto3,oneof"`
}

type ImportDocumentsRequest_CloudSqlSource added in v1.7.0 

type ImportDocumentsRequest_CloudSqlSource struct {
	// Cloud SQL input source.
	CloudSqlSource *CloudSqlSource `protobuf:"bytes,12,opt,name=cloud_sql_source,json=cloudSqlSource,proto3,oneof"`
}

type ImportDocumentsRequest_FhirStoreSource added in v1.7.0 

type ImportDocumentsRequest_FhirStoreSource struct {
	// FhirStore input source.
	FhirStoreSource *FhirStoreSource `protobuf:"bytes,10,opt,name=fhir_store_source,json=fhirStoreSource,proto3,oneof"`
}

type ImportDocumentsRequest_FirestoreSource added in v1.7.0 

type ImportDocumentsRequest_FirestoreSource struct {
	// Firestore input source.
	FirestoreSource *FirestoreSource `protobuf:"bytes,13,opt,name=firestore_source,json=firestoreSource,proto3,oneof"`
}

type ImportDocumentsRequest_GcsSource 

type ImportDocumentsRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportDocumentsRequest_InlineSource 

type ImportDocumentsRequest_InlineSource struct {

	// Required. A list of documents to update/create. Each document must have a
	// valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id].
	// Recommended max of 100 items.
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportDocuments method.

func (*ImportDocumentsRequest_InlineSource) Descriptor deprecated 

func (*ImportDocumentsRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest_InlineSource) GetDocuments 

func (x *ImportDocumentsRequest_InlineSource) GetDocuments() []*Document

func (*ImportDocumentsRequest_InlineSource) ProtoMessage 

func (*ImportDocumentsRequest_InlineSource) ProtoMessage()

func (*ImportDocumentsRequest_InlineSource) ProtoReflect 

func (x *ImportDocumentsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportDocumentsRequest_InlineSource) Reset 

func (x *ImportDocumentsRequest_InlineSource) Reset()

func (*ImportDocumentsRequest_InlineSource) String 

func (x *ImportDocumentsRequest_InlineSource) String() string

type ImportDocumentsRequest_InlineSource_ 

type ImportDocumentsRequest_InlineSource_ struct {
	// The Inline source for the input content for documents.
	InlineSource *ImportDocumentsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportDocumentsRequest_ReconciliationMode 

type ImportDocumentsRequest_ReconciliationMode int32

Indicates how imported documents are reconciled with the existing documents created or imported before. 

const (
	// Defaults to `INCREMENTAL`.
	ImportDocumentsRequest_RECONCILIATION_MODE_UNSPECIFIED ImportDocumentsRequest_ReconciliationMode = 0
	// Inserts new documents or updates existing documents.
	ImportDocumentsRequest_INCREMENTAL ImportDocumentsRequest_ReconciliationMode = 1
	// Calculates diff and replaces the entire document dataset. Existing
	// documents may be deleted if they are not present in the source location.
	ImportDocumentsRequest_FULL ImportDocumentsRequest_ReconciliationMode = 2
)

func (ImportDocumentsRequest_ReconciliationMode) Descriptor 

func (ImportDocumentsRequest_ReconciliationMode) Descriptor() protoreflect.EnumDescriptor

func (ImportDocumentsRequest_ReconciliationMode) Enum 

func (x ImportDocumentsRequest_ReconciliationMode) Enum() *ImportDocumentsRequest_ReconciliationMode

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor deprecated 

func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.

func (ImportDocumentsRequest_ReconciliationMode) Number 

func (x ImportDocumentsRequest_ReconciliationMode) Number() protoreflect.EnumNumber

func (ImportDocumentsRequest_ReconciliationMode) String 

func (x ImportDocumentsRequest_ReconciliationMode) String() string

func (ImportDocumentsRequest_ReconciliationMode) Type 

func (ImportDocumentsRequest_ReconciliationMode) Type() protoreflect.EnumType

type ImportDocumentsRequest_SpannerSource added in v1.7.0 

type ImportDocumentsRequest_SpannerSource struct {
	// Spanner input source.
	SpannerSource *SpannerSource `protobuf:"bytes,11,opt,name=spanner_source,json=spannerSource,proto3,oneof"`
}

type ImportDocumentsResponse 

type ImportDocumentsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors in the request if set.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportDocumentsRequest[google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportDocumentsResponse) Descriptor deprecated 

func (*ImportDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ImportDocumentsResponse) GetErrorConfig 

func (x *ImportDocumentsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportDocumentsResponse) GetErrorSamples 

func (x *ImportDocumentsResponse) GetErrorSamples() []*status.Status

func (*ImportDocumentsResponse) ProtoMessage 

func (*ImportDocumentsResponse) ProtoMessage()

func (*ImportDocumentsResponse) ProtoReflect 

func (x *ImportDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ImportDocumentsResponse) Reset 

func (x *ImportDocumentsResponse) Reset()

func (*ImportDocumentsResponse) String 

func (x *ImportDocumentsResponse) String() string

type ImportErrorConfig 

type ImportErrorConfig struct {

	// Required. Errors destination.
	//
	// Types that are assignable to Destination:
	//
	//	*ImportErrorConfig_GcsPrefix
	Destination isImportErrorConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Import related errors.

func (*ImportErrorConfig) Descriptor deprecated 

func (*ImportErrorConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportErrorConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorConfig) GetDestination 

func (m *ImportErrorConfig) GetDestination() isImportErrorConfig_Destination

func (*ImportErrorConfig) GetGcsPrefix 

func (x *ImportErrorConfig) GetGcsPrefix() string

func (*ImportErrorConfig) ProtoMessage 

func (*ImportErrorConfig) ProtoMessage()

func (*ImportErrorConfig) ProtoReflect 

func (x *ImportErrorConfig) ProtoReflect() protoreflect.Message

func (*ImportErrorConfig) Reset 

func (x *ImportErrorConfig) Reset()

func (*ImportErrorConfig) String 

func (x *ImportErrorConfig) String() string

type ImportErrorConfig_GcsPrefix 

type ImportErrorConfig_GcsPrefix struct {
	// Cloud Storage prefix for import errors. This must be an empty,
	// existing Cloud Storage directory. Import errors are written to
	// sharded files in this directory, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

type ImportSampleQueriesMetadata added in v1.10.0 

type ImportSampleQueriesMetadata struct {

	// ImportSampleQueries operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// ImportSampleQueries operation last update time. If the operation is done,
	// this is also the finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s
	// successfully imported.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s
	// that failed to be imported.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Total count of
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s that were
	// processed.
	TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportSampleQueriesMetadata) Descriptor deprecated added in v1.10.0 

func (*ImportSampleQueriesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportSampleQueriesMetadata.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesMetadata) GetCreateTime added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportSampleQueriesMetadata) GetFailureCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetFailureCount() int64

func (*ImportSampleQueriesMetadata) GetSuccessCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetSuccessCount() int64

func (*ImportSampleQueriesMetadata) GetTotalCount added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetTotalCount() int64

func (*ImportSampleQueriesMetadata) GetUpdateTime added in v1.10.0 

func (x *ImportSampleQueriesMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportSampleQueriesMetadata) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesMetadata) ProtoMessage()

func (*ImportSampleQueriesMetadata) ProtoReflect added in v1.10.0 

func (x *ImportSampleQueriesMetadata) ProtoReflect() protoreflect.Message

func (*ImportSampleQueriesMetadata) Reset added in v1.10.0 

func (x *ImportSampleQueriesMetadata) Reset()

func (*ImportSampleQueriesMetadata) String added in v1.10.0 

func (x *ImportSampleQueriesMetadata) String() string

type ImportSampleQueriesRequest added in v1.10.0 

type ImportSampleQueriesRequest struct {

	// The source of the sample queries.
	//
	// Types that are assignable to Source:
	//
	//	*ImportSampleQueriesRequest_InlineSource_
	//	*ImportSampleQueriesRequest_GcsSource
	//	*ImportSampleQueriesRequest_BigquerySource
	Source isImportSampleQueriesRequest_Source `protobuf_oneof:"source"`
	// Required. The parent sample query set resource name, such as
	// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
	//
	// If the caller does not have permission to list
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s under this
	// sample query set, regardless of whether or not this sample query set
	// exists, a `PERMISSION_DENIED` error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] method.

func (*ImportSampleQueriesRequest) Descriptor deprecated added in v1.10.0 

func (*ImportSampleQueriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportSampleQueriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesRequest) GetBigquerySource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetBigquerySource() *BigQuerySource

func (*ImportSampleQueriesRequest) GetErrorConfig added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportSampleQueriesRequest) GetGcsSource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetGcsSource() *GcsSource

func (*ImportSampleQueriesRequest) GetInlineSource added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetInlineSource() *ImportSampleQueriesRequest_InlineSource

func (*ImportSampleQueriesRequest) GetParent added in v1.10.0 

func (x *ImportSampleQueriesRequest) GetParent() string

func (*ImportSampleQueriesRequest) GetSource added in v1.10.0 

func (m *ImportSampleQueriesRequest) GetSource() isImportSampleQueriesRequest_Source

func (*ImportSampleQueriesRequest) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesRequest) ProtoMessage()

func (*ImportSampleQueriesRequest) ProtoReflect added in v1.10.0 

func (x *ImportSampleQueriesRequest) ProtoReflect() protoreflect.Message

func (*ImportSampleQueriesRequest) Reset added in v1.10.0 

func (x *ImportSampleQueriesRequest) Reset()

func (*ImportSampleQueriesRequest) String added in v1.10.0 

func (x *ImportSampleQueriesRequest) String() string

type ImportSampleQueriesRequest_BigquerySource added in v1.10.0 

type ImportSampleQueriesRequest_BigquerySource struct {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportSampleQueriesRequest_GcsSource added in v1.10.0 

type ImportSampleQueriesRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportSampleQueriesRequest_InlineSource added in v1.10.0 

type ImportSampleQueriesRequest_InlineSource struct {

	// Required. A list of
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to
	// import. Max of 1000 items.
	SampleQueries []*SampleQuery `protobuf:"bytes,1,rep,name=sample_queries,json=sampleQueries,proto3" json:"sample_queries,omitempty"`
	// contains filtered or unexported fields
}

The inline source for SampleQuery[google.cloud.discoveryengine.v1alpha.SampleQuery]s.

func (*ImportSampleQueriesRequest_InlineSource) Descriptor deprecated added in v1.10.0 

func (*ImportSampleQueriesRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportSampleQueriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesRequest_InlineSource) GetSampleQueries added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) GetSampleQueries() []*SampleQuery

func (*ImportSampleQueriesRequest_InlineSource) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesRequest_InlineSource) ProtoMessage()

func (*ImportSampleQueriesRequest_InlineSource) ProtoReflect added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportSampleQueriesRequest_InlineSource) Reset added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) Reset()

func (*ImportSampleQueriesRequest_InlineSource) String added in v1.10.0 

func (x *ImportSampleQueriesRequest_InlineSource) String() string

type ImportSampleQueriesRequest_InlineSource_ added in v1.10.0 

type ImportSampleQueriesRequest_InlineSource_ struct {
	// The Inline source for sample query entries.
	InlineSource *ImportSampleQueriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportSampleQueriesResponse added in v1.10.0 

type ImportSampleQueriesResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

func (*ImportSampleQueriesResponse) Descriptor deprecated added in v1.10.0 

func (*ImportSampleQueriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportSampleQueriesResponse.ProtoReflect.Descriptor instead.

func (*ImportSampleQueriesResponse) GetErrorConfig added in v1.10.0 

func (x *ImportSampleQueriesResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportSampleQueriesResponse) GetErrorSamples added in v1.10.0 

func (x *ImportSampleQueriesResponse) GetErrorSamples() []*status.Status

func (*ImportSampleQueriesResponse) ProtoMessage added in v1.10.0 

func (*ImportSampleQueriesResponse) ProtoMessage()

func (*ImportSampleQueriesResponse) ProtoReflect added in v1.10.0 

func (x *ImportSampleQueriesResponse) ProtoReflect() protoreflect.Message

func (*ImportSampleQueriesResponse) Reset added in v1.10.0 

func (x *ImportSampleQueriesResponse) Reset()

func (*ImportSampleQueriesResponse) String added in v1.10.0 

func (x *ImportSampleQueriesResponse) String() string

type ImportSuggestionDenyListEntriesMetadata added in v1.6.0 

type ImportSuggestionDenyListEntriesMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ImportSuggestionDenyListEntriesMetadata) Descriptor deprecated added in v1.6.0 

func (*ImportSuggestionDenyListEntriesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesMetadata) GetCreateTime added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage added in v1.6.0 

func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage()

func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesMetadata) ProtoReflect() protoreflect.Message

func (*ImportSuggestionDenyListEntriesMetadata) Reset added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesMetadata) Reset()

func (*ImportSuggestionDenyListEntriesMetadata) String added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesMetadata) String() string

type ImportSuggestionDenyListEntriesRequest added in v1.6.0 

type ImportSuggestionDenyListEntriesRequest struct {

	// The source of the updated SuggestionDenyList.
	//
	// Types that are assignable to Source:
	//
	//	*ImportSuggestionDenyListEntriesRequest_InlineSource_
	//	*ImportSuggestionDenyListEntriesRequest_GcsSource
	Source isImportSuggestionDenyListEntriesRequest_Source `protobuf_oneof:"source"`
	// Required. The parent data store resource name for which to import denylist
	// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.

func (*ImportSuggestionDenyListEntriesRequest) Descriptor deprecated added in v1.6.0 

func (*ImportSuggestionDenyListEntriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetGcsSource() *GcsSource

func (*ImportSuggestionDenyListEntriesRequest) GetInlineSource added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetInlineSource() *ImportSuggestionDenyListEntriesRequest_InlineSource

func (*ImportSuggestionDenyListEntriesRequest) GetParent added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) GetParent() string

func (*ImportSuggestionDenyListEntriesRequest) GetSource added in v1.6.0 

func (m *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Source

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage added in v1.6.0 

func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage()

func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) ProtoReflect() protoreflect.Message

func (*ImportSuggestionDenyListEntriesRequest) Reset added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) Reset()

func (*ImportSuggestionDenyListEntriesRequest) String added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest) String() string

type ImportSuggestionDenyListEntriesRequest_GcsSource added in v1.6.0 

type ImportSuggestionDenyListEntriesRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	//
	// Only 1 file can be specified that contains all entries to import.
	// Supported values `gcs_source.schema` for autocomplete suggestion deny
	// list entry imports:
	//
	// * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
	// per line.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportSuggestionDenyListEntriesRequest_InlineSource added in v1.6.0 

type ImportSuggestionDenyListEntriesRequest_InlineSource struct {

	// Required. A list of all denylist entries to import. Max of 1000 items.
	Entries []*SuggestionDenyListEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

The inline source for SuggestionDenyListEntry.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor deprecated added in v1.6.0 

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries() []*SuggestionDenyListEntry

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage added in v1.6.0 

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage()

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) Reset()

func (*ImportSuggestionDenyListEntriesRequest_InlineSource) String added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) String() string

type ImportSuggestionDenyListEntriesRequest_InlineSource_ added in v1.6.0 

type ImportSuggestionDenyListEntriesRequest_InlineSource_ struct {
	// The Inline source for the input content for suggestion deny list entries.
	InlineSource *ImportSuggestionDenyListEntriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportSuggestionDenyListEntriesResponse added in v1.6.0 

type ImportSuggestionDenyListEntriesResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Count of deny list entries successfully imported.
	ImportedEntriesCount int64 `protobuf:"varint,2,opt,name=imported_entries_count,json=importedEntriesCount,proto3" json:"imported_entries_count,omitempty"`
	// Count of deny list entries that failed to be imported.
	FailedEntriesCount int64 `protobuf:"varint,3,opt,name=failed_entries_count,json=failedEntriesCount,proto3" json:"failed_entries_count,omitempty"`
	// contains filtered or unexported fields
}

Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.

func (*ImportSuggestionDenyListEntriesResponse) Descriptor deprecated added in v1.6.0 

func (*ImportSuggestionDenyListEntriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.

func (*ImportSuggestionDenyListEntriesResponse) GetErrorSamples added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) GetErrorSamples() []*status.Status

func (*ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount() int64

func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage added in v1.6.0 

func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage()

func (*ImportSuggestionDenyListEntriesResponse) ProtoReflect added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) ProtoReflect() protoreflect.Message

func (*ImportSuggestionDenyListEntriesResponse) Reset added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) Reset()

func (*ImportSuggestionDenyListEntriesResponse) String added in v1.6.0 

func (x *ImportSuggestionDenyListEntriesResponse) String() string

type ImportUserEventsMetadata 

type ImportUserEventsMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ImportUserEventsMetadata) Descriptor deprecated 

func (*ImportUserEventsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*ImportUserEventsMetadata) GetCreateTime 

func (x *ImportUserEventsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportUserEventsMetadata) GetFailureCount 

func (x *ImportUserEventsMetadata) GetFailureCount() int64

func (*ImportUserEventsMetadata) GetSuccessCount 

func (x *ImportUserEventsMetadata) GetSuccessCount() int64

func (*ImportUserEventsMetadata) GetUpdateTime 

func (x *ImportUserEventsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportUserEventsMetadata) ProtoMessage 

func (*ImportUserEventsMetadata) ProtoMessage()

func (*ImportUserEventsMetadata) ProtoReflect 

func (x *ImportUserEventsMetadata) ProtoReflect() protoreflect.Message

func (*ImportUserEventsMetadata) Reset 

func (x *ImportUserEventsMetadata) Reset()

func (*ImportUserEventsMetadata) String 

func (x *ImportUserEventsMetadata) String() string

type ImportUserEventsRequest 

type ImportUserEventsRequest struct {

	// Required - The desired input source of the user event data.
	//
	// Types that are assignable to Source:
	//
	//	*ImportUserEventsRequest_InlineSource_
	//	*ImportUserEventsRequest_GcsSource
	//	*ImportUserEventsRequest_BigquerySource
	Source isImportUserEventsRequest_Source `protobuf_oneof:"source"`
	// Required. Parent DataStore resource name, of the form
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The desired location of errors incurred during the Import. Cannot be set
	// for inline user event imports.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor deprecated 

func (*ImportUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetBigquerySource 

func (x *ImportUserEventsRequest) GetBigquerySource() *BigQuerySource

func (*ImportUserEventsRequest) GetErrorConfig 

func (x *ImportUserEventsRequest) GetErrorConfig() *ImportErrorConfig

func (*ImportUserEventsRequest) GetGcsSource 

func (x *ImportUserEventsRequest) GetGcsSource() *GcsSource

func (*ImportUserEventsRequest) GetInlineSource 

func (x *ImportUserEventsRequest) GetInlineSource() *ImportUserEventsRequest_InlineSource

func (*ImportUserEventsRequest) GetParent 

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) GetSource 

func (m *ImportUserEventsRequest) GetSource() isImportUserEventsRequest_Source

func (*ImportUserEventsRequest) ProtoMessage 

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect 

func (x *ImportUserEventsRequest) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest) Reset 

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String 

func (x *ImportUserEventsRequest) String() string

type ImportUserEventsRequest_BigquerySource 

type ImportUserEventsRequest_BigquerySource struct {
	// BigQuery input source.
	BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}

type ImportUserEventsRequest_GcsSource 

type ImportUserEventsRequest_GcsSource struct {
	// Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type ImportUserEventsRequest_InlineSource 

type ImportUserEventsRequest_InlineSource struct {

	// Required. A list of user events to import. Recommended max of 10k items.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportUserEvents method.

func (*ImportUserEventsRequest_InlineSource) Descriptor deprecated 

func (*ImportUserEventsRequest_InlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest_InlineSource.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest_InlineSource) GetUserEvents 

func (x *ImportUserEventsRequest_InlineSource) GetUserEvents() []*UserEvent

func (*ImportUserEventsRequest_InlineSource) ProtoMessage 

func (*ImportUserEventsRequest_InlineSource) ProtoMessage()

func (*ImportUserEventsRequest_InlineSource) ProtoReflect 

func (x *ImportUserEventsRequest_InlineSource) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest_InlineSource) Reset 

func (x *ImportUserEventsRequest_InlineSource) Reset()

func (*ImportUserEventsRequest_InlineSource) String 

func (x *ImportUserEventsRequest_InlineSource) String() string

type ImportUserEventsRequest_InlineSource_ 

type ImportUserEventsRequest_InlineSource_ struct {
	// The Inline source for the input content for UserEvents.
	InlineSource *ImportUserEventsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}

type ImportUserEventsResponse 

type ImportUserEventsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors if this field was set in
	// the request.
	ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
	// Count of user events imported with complete existing Documents.
	JoinedEventsCount int64 `protobuf:"varint,3,opt,name=joined_events_count,json=joinedEventsCount,proto3" json:"joined_events_count,omitempty"`
	// Count of user events imported, but with Document information not found
	// in the existing Branch.
	UnjoinedEventsCount int64 `protobuf:"varint,4,opt,name=unjoined_events_count,json=unjoinedEventsCount,proto3" json:"unjoined_events_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportUserEventsResponse) Descriptor deprecated 

func (*ImportUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorConfig 

func (x *ImportUserEventsResponse) GetErrorConfig() *ImportErrorConfig

func (*ImportUserEventsResponse) GetErrorSamples 

func (x *ImportUserEventsResponse) GetErrorSamples() []*status.Status

func (*ImportUserEventsResponse) GetJoinedEventsCount 

func (x *ImportUserEventsResponse) GetJoinedEventsCount() int64

func (*ImportUserEventsResponse) GetUnjoinedEventsCount 

func (x *ImportUserEventsResponse) GetUnjoinedEventsCount() int64

func (*ImportUserEventsResponse) ProtoMessage 

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) ProtoReflect 

func (x *ImportUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ImportUserEventsResponse) Reset 

func (x *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String 

func (x *ImportUserEventsResponse) String() string

type IndustryVertical 

type IndustryVertical int32

The industry vertical associated with the DataStore[google.cloud.discoveryengine.v1alpha.DataStore]. 

const (
	// Value used when unset.
	IndustryVertical_INDUSTRY_VERTICAL_UNSPECIFIED IndustryVertical = 0
	// The generic vertical for documents that are not specific to any industry
	// vertical.
	IndustryVertical_GENERIC IndustryVertical = 1
	// The media industry vertical.
	IndustryVertical_MEDIA IndustryVertical = 2
	// The healthcare FHIR vertical.
	IndustryVertical_HEALTHCARE_FHIR IndustryVertical = 7
)

func (IndustryVertical) Descriptor 

func (IndustryVertical) Descriptor() protoreflect.EnumDescriptor

func (IndustryVertical) Enum 

func (x IndustryVertical) Enum() *IndustryVertical

func (IndustryVertical) EnumDescriptor deprecated 

func (IndustryVertical) EnumDescriptor() ([]byte, []int)

Deprecated: Use IndustryVertical.Descriptor instead.

func (IndustryVertical) Number 

func (x IndustryVertical) Number() protoreflect.EnumNumber

func (IndustryVertical) String 

func (x IndustryVertical) String() string

func (IndustryVertical) Type 

func (IndustryVertical) Type() protoreflect.EnumType

type Interval 

type Interval struct {

	// The lower bound of the interval. If neither of the min fields are
	// set, then the lower bound is negative infinity.
	//
	// This field must be not larger than max.
	// Otherwise, an `INVALID_ARGUMENT` error is returned.
	//
	// Types that are assignable to Min:
	//
	//	*Interval_Minimum
	//	*Interval_ExclusiveMinimum
	Min isInterval_Min `protobuf_oneof:"min"`
	// The upper bound of the interval. If neither of the max fields are
	// set, then the upper bound is positive infinity.
	//
	// This field must be not smaller than min.
	// Otherwise, an `INVALID_ARGUMENT` error is returned.
	//
	// Types that are assignable to Max:
	//
	//	*Interval_Maximum
	//	*Interval_ExclusiveMaximum
	Max isInterval_Max `protobuf_oneof:"max"`
	// contains filtered or unexported fields
}

A floating point interval.

func (*Interval) Descriptor deprecated 

func (*Interval) Descriptor() ([]byte, []int)

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum 

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum 

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax 

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum 

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin 

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum 

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage 

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect 

func (x *Interval) ProtoReflect() protoreflect.Message

func (*Interval) Reset 

func (x *Interval) Reset()

func (*Interval) String 

func (x *Interval) String() string

type Interval_ExclusiveMaximum 

type Interval_ExclusiveMaximum struct {
	// Exclusive upper bound.
	ExclusiveMaximum float64 `protobuf:"fixed64,4,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3,oneof"`
}

type Interval_ExclusiveMinimum 

type Interval_ExclusiveMinimum struct {
	// Exclusive lower bound.
	ExclusiveMinimum float64 `protobuf:"fixed64,2,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3,oneof"`
}

type Interval_Maximum 

type Interval_Maximum struct {
	// Inclusive upper bound.
	Maximum float64 `protobuf:"fixed64,3,opt,name=maximum,proto3,oneof"`
}

type Interval_Minimum 

type Interval_Minimum struct {
	// Inclusive lower bound.
	Minimum float64 `protobuf:"fixed64,1,opt,name=minimum,proto3,oneof"`
}

type LanguageInfo added in v1.12.0 

type LanguageInfo struct {

	// The language code for the DataStore.
	LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Output only. This is the normalized form of language_code.
	// E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb`
	// will have normalized_language_code of `en-GB`.
	NormalizedLanguageCode string `` /* 129-byte string literal not displayed */
	// Output only. Language part of normalized_language_code.
	// E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
	Language string `protobuf:"bytes,3,opt,name=language,proto3" json:"language,omitempty"`
	// Output only. Region part of normalized_language_code, if present.
	// E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> “.
	Region string `protobuf:"bytes,4,opt,name=region,proto3" json:"region,omitempty"`
	// contains filtered or unexported fields
}

Language info for DataStore.

func (*LanguageInfo) Descriptor deprecated added in v1.12.0 

func (*LanguageInfo) Descriptor() ([]byte, []int)

Deprecated: Use LanguageInfo.ProtoReflect.Descriptor instead.

func (*LanguageInfo) GetLanguage added in v1.12.0 

func (x *LanguageInfo) GetLanguage() string

func (*LanguageInfo) GetLanguageCode added in v1.12.0 

func (x *LanguageInfo) GetLanguageCode() string

func (*LanguageInfo) GetNormalizedLanguageCode added in v1.12.0 

func (x *LanguageInfo) GetNormalizedLanguageCode() string

func (*LanguageInfo) GetRegion added in v1.12.0 

func (x *LanguageInfo) GetRegion() string

func (*LanguageInfo) ProtoMessage added in v1.12.0 

func (*LanguageInfo) ProtoMessage()

func (*LanguageInfo) ProtoReflect added in v1.12.0 

func (x *LanguageInfo) ProtoReflect() protoreflect.Message

func (*LanguageInfo) Reset added in v1.12.0 

func (x *LanguageInfo) Reset()

func (*LanguageInfo) String added in v1.12.0 

func (x *LanguageInfo) String() string

type ListChunksRequest added in v1.6.0 

type ListChunksRequest struct {

	// Required. The parent document resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
	//
	// If the caller does not have permission to list
	// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document,
	// regardless of whether or not this document exists, a `PERMISSION_DENIED`
	// error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s to
	// return. If unspecified, defaults to 100. The maximum allowed value is 1000.
	// Values above 1000 will be coerced to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token],
	// received from a previous
	// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.

func (*ListChunksRequest) Descriptor deprecated added in v1.6.0 

func (*ListChunksRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListChunksRequest.ProtoReflect.Descriptor instead.

func (*ListChunksRequest) GetPageSize added in v1.6.0 

func (x *ListChunksRequest) GetPageSize() int32

func (*ListChunksRequest) GetPageToken added in v1.6.0 

func (x *ListChunksRequest) GetPageToken() string

func (*ListChunksRequest) GetParent added in v1.6.0 

func (x *ListChunksRequest) GetParent() string

func (*ListChunksRequest) ProtoMessage added in v1.6.0 

func (*ListChunksRequest) ProtoMessage()

func (*ListChunksRequest) ProtoReflect added in v1.6.0 

func (x *ListChunksRequest) ProtoReflect() protoreflect.Message

func (*ListChunksRequest) Reset added in v1.6.0 

func (x *ListChunksRequest) Reset()

func (*ListChunksRequest) String added in v1.6.0 

func (x *ListChunksRequest) String() string

type ListChunksResponse added in v1.6.0 

type ListChunksResponse struct {

	// The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
	Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// A token that can be sent as
	// [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.

func (*ListChunksResponse) Descriptor deprecated added in v1.6.0 

func (*ListChunksResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListChunksResponse.ProtoReflect.Descriptor instead.

func (*ListChunksResponse) GetChunks added in v1.6.0 

func (x *ListChunksResponse) GetChunks() []*Chunk

func (*ListChunksResponse) GetNextPageToken added in v1.6.0 

func (x *ListChunksResponse) GetNextPageToken() string

func (*ListChunksResponse) ProtoMessage added in v1.6.0 

func (*ListChunksResponse) ProtoMessage()

func (*ListChunksResponse) ProtoReflect added in v1.6.0 

func (x *ListChunksResponse) ProtoReflect() protoreflect.Message

func (*ListChunksResponse) Reset added in v1.6.0 

func (x *ListChunksResponse) Reset()

func (*ListChunksResponse) String added in v1.6.0 

func (x *ListChunksResponse) String() string

type ListControlsRequest added in v1.8.0 

type ListControlsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
	// or
	// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListControls` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter to apply on the list results. Supported features:
	//
	// * List all the products under the parent branch if
	// [filter][google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter]
	// is unset. Currently this field is unsupported.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request for ListControls method.

func (*ListControlsRequest) Descriptor deprecated added in v1.8.0 

func (*ListControlsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListControlsRequest.ProtoReflect.Descriptor instead.

func (*ListControlsRequest) GetFilter added in v1.8.0 

func (x *ListControlsRequest) GetFilter() string

func (*ListControlsRequest) GetPageSize added in v1.8.0 

func (x *ListControlsRequest) GetPageSize() int32

func (*ListControlsRequest) GetPageToken added in v1.8.0 

func (x *ListControlsRequest) GetPageToken() string

func (*ListControlsRequest) GetParent added in v1.8.0 

func (x *ListControlsRequest) GetParent() string

func (*ListControlsRequest) ProtoMessage added in v1.8.0 

func (*ListControlsRequest) ProtoMessage()

func (*ListControlsRequest) ProtoReflect added in v1.8.0 

func (x *ListControlsRequest) ProtoReflect() protoreflect.Message

func (*ListControlsRequest) Reset added in v1.8.0 

func (x *ListControlsRequest) Reset()

func (*ListControlsRequest) String added in v1.8.0 

func (x *ListControlsRequest) String() string

type ListControlsResponse added in v1.8.0 

type ListControlsResponse struct {

	// All the Controls for a given data store.
	Controls []*Control `protobuf:"bytes,1,rep,name=controls,proto3" json:"controls,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListControls method.

func (*ListControlsResponse) Descriptor deprecated added in v1.8.0 

func (*ListControlsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListControlsResponse.ProtoReflect.Descriptor instead.

func (*ListControlsResponse) GetControls added in v1.8.0 

func (x *ListControlsResponse) GetControls() []*Control

func (*ListControlsResponse) GetNextPageToken added in v1.8.0 

func (x *ListControlsResponse) GetNextPageToken() string

func (*ListControlsResponse) ProtoMessage added in v1.8.0 

func (*ListControlsResponse) ProtoMessage()

func (*ListControlsResponse) ProtoReflect added in v1.8.0 

func (x *ListControlsResponse) ProtoReflect() protoreflect.Message

func (*ListControlsResponse) Reset added in v1.8.0 

func (x *ListControlsResponse) Reset()

func (*ListControlsResponse) String added in v1.8.0 

func (x *ListControlsResponse) String() string

type ListConversationsRequest 

type ListConversationsRequest struct {

	// Required. The data store resource name. Format:
	// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListConversations` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter to apply on the list results. The supported features are:
	// user_pseudo_id, state.
	//
	// Example:
	// "user_pseudo_id = some_id"
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// A comma-separated list of fields to order by, sorted in ascending order.
	// Use "desc" after a field name for descending.
	// Supported fields:
	//   - `update_time`
	//   - `create_time`
	//   - `conversation_name`
	//
	// Example:
	// "update_time desc"
	// "create_time"
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request for ListConversations method.

func (*ListConversationsRequest) Descriptor deprecated 

func (*ListConversationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.

func (*ListConversationsRequest) GetFilter 

func (x *ListConversationsRequest) GetFilter() string

func (*ListConversationsRequest) GetOrderBy 

func (x *ListConversationsRequest) GetOrderBy() string

func (*ListConversationsRequest) GetPageSize 

func (x *ListConversationsRequest) GetPageSize() int32

func (*ListConversationsRequest) GetPageToken 

func (x *ListConversationsRequest) GetPageToken() string

func (*ListConversationsRequest) GetParent 

func (x *ListConversationsRequest) GetParent() string

func (*ListConversationsRequest) ProtoMessage 

func (*ListConversationsRequest) ProtoMessage()

func (*ListConversationsRequest) ProtoReflect 

func (x *ListConversationsRequest) ProtoReflect() protoreflect.Message

func (*ListConversationsRequest) Reset 

func (x *ListConversationsRequest) Reset()

func (*ListConversationsRequest) String 

func (x *ListConversationsRequest) String() string

type ListConversationsResponse 

type ListConversationsResponse struct {

	// All the Conversations for a given data store.
	Conversations []*Conversation `protobuf:"bytes,1,rep,name=conversations,proto3" json:"conversations,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListConversations method.

func (*ListConversationsResponse) Descriptor deprecated 

func (*ListConversationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.

func (*ListConversationsResponse) GetConversations 

func (x *ListConversationsResponse) GetConversations() []*Conversation

func (*ListConversationsResponse) GetNextPageToken 

func (x *ListConversationsResponse) GetNextPageToken() string

func (*ListConversationsResponse) ProtoMessage 

func (*ListConversationsResponse) ProtoMessage()

func (*ListConversationsResponse) ProtoReflect 

func (x *ListConversationsResponse) ProtoReflect() protoreflect.Message

func (*ListConversationsResponse) Reset 

func (x *ListConversationsResponse) Reset()

func (*ListConversationsResponse) String 

func (x *ListConversationsResponse) String() string

type ListCustomModelsRequest added in v1.8.0 

type ListCustomModelsRequest struct {

	// Required. The resource name of the parent Data Store, such as
	// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
	// This field is used to identify the data store where to fetch the models
	// from.
	DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsRequest) Descriptor deprecated added in v1.8.0 

func (*ListCustomModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCustomModelsRequest.ProtoReflect.Descriptor instead.

func (*ListCustomModelsRequest) GetDataStore added in v1.8.0 

func (x *ListCustomModelsRequest) GetDataStore() string

func (*ListCustomModelsRequest) ProtoMessage added in v1.8.0 

func (*ListCustomModelsRequest) ProtoMessage()

func (*ListCustomModelsRequest) ProtoReflect added in v1.8.0 

func (x *ListCustomModelsRequest) ProtoReflect() protoreflect.Message

func (*ListCustomModelsRequest) Reset added in v1.8.0 

func (x *ListCustomModelsRequest) Reset()

func (*ListCustomModelsRequest) String added in v1.8.0 

func (x *ListCustomModelsRequest) String() string

type ListCustomModelsResponse added in v1.8.0 

type ListCustomModelsResponse struct {

	// List of custom tuning models.
	Models []*CustomTuningModel `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// contains filtered or unexported fields
}

Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] method.

func (*ListCustomModelsResponse) Descriptor deprecated added in v1.8.0 

func (*ListCustomModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCustomModelsResponse.ProtoReflect.Descriptor instead.

func (*ListCustomModelsResponse) GetModels added in v1.8.0 

func (x *ListCustomModelsResponse) GetModels() []*CustomTuningModel

func (*ListCustomModelsResponse) ProtoMessage added in v1.8.0 

func (*ListCustomModelsResponse) ProtoMessage()

func (*ListCustomModelsResponse) ProtoReflect added in v1.8.0 

func (x *ListCustomModelsResponse) ProtoReflect() protoreflect.Message

func (*ListCustomModelsResponse) Reset added in v1.8.0 

func (x *ListCustomModelsResponse) Reset()

func (*ListCustomModelsResponse) String added in v1.8.0 

func (x *ListCustomModelsResponse) String() string

type ListDataStoresRequest 

type ListDataStoresRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection_id}`.
	//
	// If the caller does not have permission to list
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s under this
	// location, regardless of whether or not this data store exists, a
	// PERMISSION_DENIED error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s to return. If
	// unspecified, defaults to 10. The maximum allowed value is 50. Values above
	// 50 will be coerced to 50.
	//
	// If this field is negative, an INVALID_ARGUMENT is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token],
	// received from a previous
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
	// must match the call that provided the page token. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter by solution type .
	// For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.

func (*ListDataStoresRequest) Descriptor deprecated 

func (*ListDataStoresRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDataStoresRequest.ProtoReflect.Descriptor instead.

func (*ListDataStoresRequest) GetFilter 

func (x *ListDataStoresRequest) GetFilter() string

func (*ListDataStoresRequest) GetPageSize 

func (x *ListDataStoresRequest) GetPageSize() int32

func (*ListDataStoresRequest) GetPageToken 

func (x *ListDataStoresRequest) GetPageToken() string

func (*ListDataStoresRequest) GetParent 

func (x *ListDataStoresRequest) GetParent() string

func (*ListDataStoresRequest) ProtoMessage 

func (*ListDataStoresRequest) ProtoMessage()

func (*ListDataStoresRequest) ProtoReflect 

func (x *ListDataStoresRequest) ProtoReflect() protoreflect.Message

func (*ListDataStoresRequest) Reset 

func (x *ListDataStoresRequest) Reset()

func (*ListDataStoresRequest) String 

func (x *ListDataStoresRequest) String() string

type ListDataStoresResponse 

type ListDataStoresResponse struct {

	// All the customer's
	// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s.
	DataStores []*DataStore `protobuf:"bytes,1,rep,name=data_stores,json=dataStores,proto3" json:"data_stores,omitempty"`
	// A token that can be sent as
	// [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.

func (*ListDataStoresResponse) Descriptor deprecated 

func (*ListDataStoresResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDataStoresResponse.ProtoReflect.Descriptor instead.

func (*ListDataStoresResponse) GetDataStores 

func (x *ListDataStoresResponse) GetDataStores() []*DataStore

func (*ListDataStoresResponse) GetNextPageToken 

func (x *ListDataStoresResponse) GetNextPageToken() string

func (*ListDataStoresResponse) ProtoMessage 

func (*ListDataStoresResponse) ProtoMessage()

func (*ListDataStoresResponse) ProtoReflect 

func (x *ListDataStoresResponse) ProtoReflect() protoreflect.Message

func (*ListDataStoresResponse) Reset 

func (x *ListDataStoresResponse) Reset()

func (*ListDataStoresResponse) String 

func (x *ListDataStoresResponse) String() string

type ListDocumentsRequest 

type ListDocumentsRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
	// Use `default_branch` as the branch ID, to list documents under the default
	// branch.
	//
	// If the caller does not have permission to list
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s under this
	// branch, regardless of whether or not this branch exists, a
	// `PERMISSION_DENIED` error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of
	// [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
	// unspecified, defaults to 100. The maximum allowed value is 1000. Values
	// above 1000 are set to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token],
	// received from a previous
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] method.

func (*ListDocumentsRequest) Descriptor deprecated 

func (*ListDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetPageSize 

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken 

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent 

func (x *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect 

func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ListDocumentsRequest) Reset 

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (x *ListDocumentsRequest) String() string

type ListDocumentsResponse 

type ListDocumentsResponse struct {

	// The [Document][google.cloud.discoveryengine.v1alpha.Document]s.
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// A token that can be sent as
	// [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] method.

func (*ListDocumentsResponse) Descriptor deprecated 

func (*ListDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocuments 

func (x *ListDocumentsResponse) GetDocuments() []*Document

func (*ListDocumentsResponse) GetNextPageToken 

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect 

func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ListDocumentsResponse) Reset 

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (x *ListDocumentsResponse) String() string

type ListEnginesRequest 

type ListEnginesRequest struct {

	// Required. The parent resource name, such as
	// `projects/{project}/locations/{location}/collections/{collection_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Not supported.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. Not supported.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filter by solution type. For example:
	// solution_type=SOLUTION_TYPE_SEARCH
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.

func (*ListEnginesRequest) Descriptor deprecated 

func (*ListEnginesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.

func (*ListEnginesRequest) GetFilter 

func (x *ListEnginesRequest) GetFilter() string

func (*ListEnginesRequest) GetPageSize 

func (x *ListEnginesRequest) GetPageSize() int32

func (*ListEnginesRequest) GetPageToken 

func (x *ListEnginesRequest) GetPageToken() string

func (*ListEnginesRequest) GetParent 

func (x *ListEnginesRequest) GetParent() string

func (*ListEnginesRequest) ProtoMessage 

func (*ListEnginesRequest) ProtoMessage()

func (*ListEnginesRequest) ProtoReflect 

func (x *ListEnginesRequest) ProtoReflect() protoreflect.Message

func (*ListEnginesRequest) Reset 

func (x *ListEnginesRequest) Reset()

func (*ListEnginesRequest) String 

func (x *ListEnginesRequest) String() string

type ListEnginesResponse 

type ListEnginesResponse struct {

	// All the customer's [Engine][google.cloud.discoveryengine.v1alpha.Engine]s.
	Engines []*Engine `protobuf:"bytes,1,rep,name=engines,proto3" json:"engines,omitempty"`
	// Not supported.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.

func (*ListEnginesResponse) Descriptor deprecated 

func (*ListEnginesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.

func (*ListEnginesResponse) GetEngines 

func (x *ListEnginesResponse) GetEngines() []*Engine

func (*ListEnginesResponse) GetNextPageToken 

func (x *ListEnginesResponse) GetNextPageToken() string

func (*ListEnginesResponse) ProtoMessage 

func (*ListEnginesResponse) ProtoMessage()

func (*ListEnginesResponse) ProtoReflect 

func (x *ListEnginesResponse) ProtoReflect() protoreflect.Message

func (*ListEnginesResponse) Reset 

func (x *ListEnginesResponse) Reset()

func (*ListEnginesResponse) String 

func (x *ListEnginesResponse) String() string

type ListEvaluationResultsRequest added in v1.10.0 

type ListEvaluationResultsRequest struct {

	// Required. The evaluation resource name, such as
	// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
	//
	// If the caller does not have permission to list [EvaluationResult][]
	// under this evaluation, regardless of whether or not this evaluation
	// set exists, a `PERMISSION_DENIED` error is returned.
	Evaluation string `protobuf:"bytes,1,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
	// Maximum number of [EvaluationResult][] to return. If unspecified,
	// defaults to 100. The maximum allowed value is 1000. Values above 1000 will
	// be coerced to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.next_page_token],
	// received from a previous
	// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] method.

func (*ListEvaluationResultsRequest) Descriptor deprecated added in v1.10.0 

func (*ListEvaluationResultsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEvaluationResultsRequest.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsRequest) GetEvaluation added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetEvaluation() string

func (*ListEvaluationResultsRequest) GetPageSize added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetPageSize() int32

func (*ListEvaluationResultsRequest) GetPageToken added in v1.10.0 

func (x *ListEvaluationResultsRequest) GetPageToken() string

func (*ListEvaluationResultsRequest) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsRequest) ProtoMessage()

func (*ListEvaluationResultsRequest) ProtoReflect added in v1.10.0 

func (x *ListEvaluationResultsRequest) ProtoReflect() protoreflect.Message

func (*ListEvaluationResultsRequest) Reset added in v1.10.0 

func (x *ListEvaluationResultsRequest) Reset()

func (*ListEvaluationResultsRequest) String added in v1.10.0 

func (x *ListEvaluationResultsRequest) String() string

type ListEvaluationResultsResponse added in v1.10.0 

type ListEvaluationResultsResponse struct {

	// The
	// [EvaluationResult][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult]s.
	EvaluationResults []*ListEvaluationResultsResponse_EvaluationResult `protobuf:"bytes,1,rep,name=evaluation_results,json=evaluationResults,proto3" json:"evaluation_results,omitempty"`
	// A token that can be sent as
	// [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] method.

func (*ListEvaluationResultsResponse) Descriptor deprecated added in v1.10.0 

func (*ListEvaluationResultsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEvaluationResultsResponse.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsResponse) GetEvaluationResults added in v1.10.0 

func (x *ListEvaluationResultsResponse) GetEvaluationResults() []*ListEvaluationResultsResponse_EvaluationResult

func (*ListEvaluationResultsResponse) GetNextPageToken added in v1.10.0 

func (x *ListEvaluationResultsResponse) GetNextPageToken() string

func (*ListEvaluationResultsResponse) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsResponse) ProtoMessage()

func (*ListEvaluationResultsResponse) ProtoReflect added in v1.10.0 

func (x *ListEvaluationResultsResponse) ProtoReflect() protoreflect.Message

func (*ListEvaluationResultsResponse) Reset added in v1.10.0 

func (x *ListEvaluationResultsResponse) Reset()

func (*ListEvaluationResultsResponse) String added in v1.10.0 

func (x *ListEvaluationResultsResponse) String() string

type ListEvaluationResultsResponse_EvaluationResult added in v1.10.0 

type ListEvaluationResultsResponse_EvaluationResult struct {

	// Output only. The
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] that was
	// evaluated.
	SampleQuery *SampleQuery `protobuf:"bytes,1,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
	// Output only. The metrics produced by the evaluation, for a given
	// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
	QualityMetrics *QualityMetrics `protobuf:"bytes,2,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
	// contains filtered or unexported fields
}

Represents the results of an evaluation for a single SampleQuery[google.cloud.discoveryengine.v1alpha.SampleQuery].

func (*ListEvaluationResultsResponse_EvaluationResult) Descriptor deprecated added in v1.10.0 

func (*ListEvaluationResultsResponse_EvaluationResult) Descriptor() ([]byte, []int)

Deprecated: Use ListEvaluationResultsResponse_EvaluationResult.ProtoReflect.Descriptor instead.

func (*ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics() *QualityMetrics

func (*ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery() *SampleQuery

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage added in v1.10.0 

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage()

func (*ListEvaluationResultsResponse_EvaluationResult) ProtoReflect added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) ProtoReflect() protoreflect.Message

func (*ListEvaluationResultsResponse_EvaluationResult) Reset added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) Reset()

func (*ListEvaluationResultsResponse_EvaluationResult) String added in v1.10.0 

func (x *ListEvaluationResultsResponse_EvaluationResult) String() string

type ListEvaluationsRequest added in v1.10.0 

type ListEvaluationsRequest struct {

	// Required. The parent location resource name, such as
	// `projects/{project}/locations/{location}`.
	//
	// If the caller does not have permission to list
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s under this
	// location, regardless of whether or not this location exists, a
	// `PERMISSION_DENIED` error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of
	// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s to return.
	// If unspecified, defaults to 100. The maximum allowed value is 1000. Values
	// above 1000 will be coerced to 1000.
	//
	// If this field is negative, an `INVALID_ARGUMENT` error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.next_page_token],
	// received from a previous
	// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
	// must match the call that provided the page token. Otherwise, an
	// `INVALID_ARGUMENT` error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] method.

func (*ListEvaluationsRequest) Descriptor deprecated added in v1.10.0 

func (*ListEvaluationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEvaluationsRequest.ProtoReflect.Descriptor instead.

func (*ListEvaluationsRequest) GetPageSize added in v1.10.0 

func (x *ListEvaluationsRequest) GetPageSize() int32

func (*ListEvaluationsRequest) GetPageToken added in v1.10.0 

func (x *ListEvaluationsRequest) GetPageToken() string

func (*ListEvaluationsRequest) GetParent added in v1.10.0 

func (x *ListEvaluationsRequest) GetParent() string

func (*ListEvaluationsRequest) ProtoMessage added in v1.10.0 

func (*ListEvaluationsRequest) ProtoMessage()

func (*ListEvaluationsRequest) ProtoReflect added in v1.10.0 

func (x *ListEvaluationsRequest) ProtoReflect() protoreflect.Message

func (*ListEvaluationsRequest) Reset added in v1.10.0 

func (x *ListEvaluationsRequest) Reset()

func (*ListEvaluationsRequest) String added in v1.10.0 

func (x *ListEvaluationsRequest) String() string

type ListEvaluationsResponse added in v1.10.0 

type ListEvaluationsResponse struct {

	// The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
	Evaluations []*Evaluation `protobuf:"bytes,1,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
	// A token that can be sent as
	// [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] method.

func (*ListEvaluationsResponse) Descriptor deprecated added in v1.10.0 

func (*ListEvaluationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEvaluationsResponse.ProtoReflect.Descriptor instead.

func (*ListEvaluationsResponse) GetEvaluations added in v1.10.0 

func (x *ListEvaluationsResponse) GetEvaluations() []*Evaluation

func (*ListEvaluationsResponse) GetNextPageToken added in v1.10.0 

func (x *ListEvaluationsResponse) GetNextPageToken() string

func (*ListEvaluationsResponse) ProtoMessage added in v1.10.0 

func (*ListEvaluationsResponse) ProtoMessage()

func (*ListEvaluationsResponse) ProtoReflect added in v1.10.0 

func (x *ListEvaluationsResponse) ProtoReflect() protoreflect.Message

func (*ListEvaluationsResponse) Reset added in v1.10.0 

func (x *ListEvaluationsResponse) Reset()

func (*ListEvaluationsResponse) String added in v1.10.0 

func (x *ListEvaluationsResponse) String() string

type ListFilesRequest added in v1.21.0 

type ListFilesRequest struct {

	// Required. The resource name of the Session.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
	// Name of the session resource to which the file belong.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The filter syntax consists of an expression language for
	// constructing a predicate from one or more fields of the files being
	// filtered. Filter expression is case-sensitive. Currently supported field
	// names are:
	// * upload_time
	// * last_add_time
	// * last_use_time
	// * file_name
	// * mime_type
	//
	// Some examples of filters would be:
	// * "file_name = 'file_1'"
	// * "file_name = 'file_1' AND mime_type = 'text/plain'"
	// * "last_use_time > '2025-06-14T12:00:00Z'"
	//
	// For a full description of the filter format, please
	// see https://google.aip.dev/160.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The maximum number of files to return. The service may return
	// fewer than this value. If unspecified, at most 100 files will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	// If user specifies a value less than or equal to 0 - the request will be
	// rejected with an INVALID_ARGUMENT error.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token received from a previous `ListFiles` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListFiles`
	// must match the call that provided the page token (except `page_size`, which
	// may differ).
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] method.

func (*ListFilesRequest)